تخطَّ إلى المحتوى
AR
الحصول على مفتاح API
تصفح الوثائق

مرجع API

إشارة API

نقاط نهاية الحشد للحسابات والمفاتيح و الفواتير والوظائف وتورد كل نقطة نهاية قائمة بمتطلبات التوثيق والوصول.

اقرأ حسابك مع API المفتاح

عنوان Management API الأساسي هو https://api.flashdata.dev/v2. تعيد هذه القراءة المجانية معرّفات المفتاح الحالي والحساب والملكية. اضبط FLASHDATA_API_KEY قبل تشغيل الأمر.

تحقق من المفتاح الحالي Bash
curl --fail-with-body --silent --show-error --max-time 20 \
  --header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY first}" \
  'https://api.flashdata.dev/v2/api-access/identity'

توقع أن تنجح شركة HTTP 200. تحقق من خط التوثيق في كل نقطة نهاية: dataApiKey الاستخدامات X-API-Key; cookieSession يستعمل جلسة موقّعة في بروزر مخطط الاستجابة للهوية

تحميل مواصفات العملاء. وهو يغطي الاستفسارات، والوظائف، والحسابات، ومفاتيح شركة API وفواتير.

تم توثيق بارامترات الحجر وشفرة الطلب في Google و YouTube إشارات API.

مخططات التوثيق

المخططالاحتياج
dataApiKey

X-API-Key · header

FlashData API المفتاح الدخول إلى العمل مقتصر على نطاقات المصدر

cookieSession

__Host-fd_session · cookie

جلسة على الشبكة العالمية. لا يمكن للمتجر قراءة هذه الكعكة

csrfToken

X-CSRF-Token · header

apiKey

agentRegistrationProof

احفظ إثباتًا عشوائيًا آمنًا بطول 32-byte بصيغة base64url والطلب نفسه قبل الإرسال؛ ولا تستعد التسجيل إلا بالإثبات والجسم نفسيهما. هذا ليس رمز OAuth.

agentSetupCredential

Provisional setup credential for status and claim creation only. ليس بيانات API المفتاح

agentHandoffProof

البروف كان يستعيد مفتاح المالك ويعترف بالتركيب لم يرسل أبداً إلى إستفسار البيانات

agentIdentityKey

معتاد FlashData API المفتاح في الرخصة (بيرر) فقط بشأن هوية العميل استخدام الاستفسارات عن البيانات X-API-Key بدلاً من ذلك

النظام

GET/health

الخدمات الصحية

Authentication: الجمهور

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

الردود

200 الصحة

رد 200 · application/json

Health

رد 200
{
  "$ref": "#/components/schemas/Health"
}
GET/status

قراءة موجز حالة العنصر العام

Authentication: الجمهور

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

الردود

200 موجز الحالة العامة

المرؤوسون: Cache-Control

رد 200 · application/json

PublicStatus

رد 200
{
  "$ref": "#/components/schemas/PublicStatus"
}

Auth

GET/oauth/requests/{requestId}

اقرأ طلب الإذن بالتطبيق وربطه بالدورة الحالية

الدورة الكاملة مطلوبة. الطلب ينتهي بعد عشر دقائق الاستجابة ليست مُقدّمة.

Authentication: cookieSession

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

requestId · path · المطلوب

Schema
Schema
{
  "type": "string",
  "pattern": "^fdo_[A-Za-z0-9_-]{43}$"
}

الردود

200 تصاريح التطبيق المطلوبة

رد 200 · application/json

OAuthConsent

رد 200
{
  "$ref": "#/components/schemas/OAuthConsent"
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 مثبتة ولكن غير مسموح بها، أو لم تُثبت شركة CSRF

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

410 الطلب المنتهي أو المستعمل أو المُلزَم بعقد دورة أخرى

رد 410 · application/problem+json

Problem

رد 410
{
  "$ref": "#/components/schemas/Problem"
}
POST/oauth/requests/{requestId}

الموافقة أو رفض طلب الترخيص بالتطبيق

الدورة الكاملة، CSRF وسمحت للأوغين بأن يطلب. يستهلك الطلب مرة. الاستجابة ليست مُقدّمة.

Authentication: cookieSession + csrfToken

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

requestId · path · المطلوب

Schema
Schema
{
  "type": "string",
  "pattern": "^fdo_[A-Za-z0-9_-]{43}$"
}

طلب الجسد؟ · المطلوب

Schema · application/json
Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "decision"
  ],
  "properties": {
    "decision": {
      "type": "string",
      "enum": [
        "approve",
        "deny"
      ]
    }
  }
}

الردود

200 إعادة الاتصال بالزبائن المسجلة بالرمز أو الرفض، والولاية، والمصدر

رد 200 · application/json
رد 200
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "redirectUrl"
  ],
  "properties": {
    "redirectUrl": {
      "type": "string",
      "format": "uri"
    }
  }
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 مثبتة ولكن غير مسموح بها، أو لم تُثبت شركة CSRF

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

410 طلب الإذن غير متاح؛ بدء وصلة جديدة

رد 410 · application/problem+json

Problem

رد 410
{
  "$ref": "#/components/schemas/Problem"
}

422 فشل التثبت من الطلب

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}
POST/auth/register

(أ) إنشاء معلقة FlashData الحساب

ويجب أن تضاهي الأحكام والصيغ الخاصة المقدمة الحزمة القانونية المنشورة حاليا.

Authentication: الجمهور

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

طلب الجسد؟ · المطلوب

Schema · application/json

RegisterRequest

Schema
{
  "$ref": "#/components/schemas/RegisterRequest"
}

الردود

201 الحساب المنشأ؛ يتطلب التحقق من البريد الإلكتروني

المرؤوسون: Cache-Control, X-Request-Id

رد 201 · application/json

RegisterResponse

رد 201
{
  "$ref": "#/components/schemas/RegisterResponse"
}

409 النزاع في حالة الموارد أو الافتراض

رد 409 · application/problem+json

Problem

رد 409
{
  "$ref": "#/components/schemas/Problem"
}

422 فشل التثبت من الطلب

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

429 تجاوز الحد الأقصى للمعدلات أو المطابقة أو الدفعات أو الحد المقرر للعمل

المرؤوسون: Retry-After

رد 429 · application/problem+json

Problem

رد 429
{
  "$ref": "#/components/schemas/Problem"
}

500 حدث خطأ داخلي غير متوقع

رد 500 · application/problem+json

Problem

رد 500
{
  "$ref": "#/components/schemas/Problem"
}

503 التبعية المطلوبة أو المكتال غير متاح بصورة مؤقتة

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/auth/login

إنشاء جلسة مثمرة على شبكة الإنترنت

يضبط الأمن، هتوبونلي `__Host-fd_session` كعكة. حسابات نهاية الخدمة وتتلقى دورة مقيّدة من طراز email_verification من أجل لوحة التحقق. وتتلقى الحسابات التي تم التحقق منها على نحو مؤهل قروضاً تجريبية لمرة واحدة في حالة عدم منحها بالفعل. حساب نشط تستقبل دورة كاملة ما لم تكن هويتها المهاجرة لا تزال تتطلب القبول القانوني الحالي، وفي هذه الحالة يتلقى قبولاً مقيداً legal_acceptance Session. حساب مع طلب حذف مقرر ويتلقى المجلس جلسة محدودة في إطار برنامج deletion_recovery. حسابات من يحذفها هو processing/failed/completed، وحسابات معلّقة، ويتلقى 403.

Authentication: الجمهور

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

طلب الجسد؟ · المطلوب

Schema · application/json

LoginRequest

Schema
{
  "$ref": "#/components/schemas/LoginRequest"
}

الردود

200 Authenticated

المرؤوسون: Set-Cookie, Cache-Control, X-Request-Id

رد 200 · application/json

LoginResponse

رد 200
{
  "$ref": "#/components/schemas/LoginResponse"
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 (لوجين) ممنوع Problem.code is email_not_verified, account_suspended, account_deletion_processing, account_deletion_failed, or account_deleted

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

422 فشل التثبت من الطلب

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

423 حساب مقفل مؤقتا

المرؤوسون: Retry-After

رد 423 · application/problem+json

Problem

رد 423
{
  "$ref": "#/components/schemas/Problem"
}

429 تجاوز الحد الأقصى للمعدلات أو المطابقة أو الدفعات أو الحد المقرر للعمل

المرؤوسون: Retry-After

رد 429 · application/problem+json

Problem

رد 429
{
  "$ref": "#/components/schemas/Problem"
}
POST/auth/logout

تنشيط الدورة الحالية

Authentication: cookieSession + csrfToken

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

الردود

204 ألغيت الجلسة وأخليت الكعكة

المرؤوسون: Set-Cookie, Cache-Control, X-Request-Id

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 مثبتة ولكن غير مسموح بها، أو لم تُثبت شركة CSRF

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}
GET/auth/me

اقرأ الحساب الجاري والمستعمل

Authentication: cookieSession

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

الردود

200 الحساب الجاري

المرؤوسون: Cache-Control, X-Request-Id

رد 200 · application/json

Account

رد 200
{
  "$ref": "#/components/schemas/Account"
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}
GET/auth/csrf

احصل على CSRF الملتزمة بالدورة الحالية

Authentication: cookieSession

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

الردود

200 CSRF token

المرؤوسون: Cache-Control, X-Request-Id

رد 200 · application/json
رد 200
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "csrfToken"
  ],
  "properties": {
    "csrfToken": {
      "type": "string",
      "minLength": 32,
      "readOnly": true
    }
  }
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}
POST/auth/email-verifications

طلب رسالة تحقق بالبريد الإلكتروني أو إلغائها

وبالنسبة لكل بريد إلكتروني سليم من الناحية العملية، يعيد الرد نفسه بصرف النظر عما إذا كان الحساب مفقوداً أو معلقاً أو نشطاً أو معلقاً أو محذفاً. وتحصل الحسابات المستحقة القبض على روابط متناوبة لمرة واحدة بعد إعادة التهدئة.

Authentication: الجمهور

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

طلب الجسد؟ · المطلوب

Schema · application/json
Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "email"
  ],
  "properties": {
    "email": {
      "type": "string",
      "format": "email",
      "maxLength": 320
    }
  }
}

الردود

202 تم قبول الطلب ولا يكشف الرد عما إذا كان هناك حساب.

المرؤوسون: Cache-Control, X-Request-Id

رد 202 · application/json
رد 202
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "accepted"
  ],
  "properties": {
    "accepted": {
      "type": "boolean",
      "const": true
    }
  }
}

422 فشل طلب التوثيق مجهول الهوية

المرؤوسون: Cache-Control, X-Request-Id

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

429 تجاوز الحد الأقصى لمعدل التوثيق مجهول الهوية

المرؤوسون: Cache-Control, Retry-After, X-Request-Id

رد 429 · application/problem+json

Problem

رد 429
{
  "$ref": "#/components/schemas/Problem"
}

500 حدث خطأ غير متوقع في التوثيق المجهول

المرؤوسون: Cache-Control, X-Request-Id

رد 500 · application/problem+json

Problem

رد 500
{
  "$ref": "#/components/schemas/Problem"
}

503 التبعية من مجهول الهوية غير متاحة مؤقتاً

المرؤوسون: Cache-Control, X-Request-Id

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/auth/email-verifications/confirm

التحقق من البريد الإلكتروني وتفعيل الحساب

يستهلك من الناحية الذريّة الحساب والمستعمل لمرة واحدة. وتنطبق قواعد المحاسبة والاعتراف بالتجربة. بدون جلسة توقيع، يسجل المستخدم بشكل صريح. طلب مسموح به يحمل جلسة المباريات X-CSRF-Token ويمكن أن يتلقى كعكة دوارة في الدورة لنفس الحساب المتحقق منه؛ ولا يسجل التحقق وحده في أي مستخدم.

Authentication: الجمهور

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

طلب الجسد؟ · المطلوب

Schema · application/json

TokenRequest

Schema
{
  "$ref": "#/components/schemas/TokenRequest"
}

الردود

200 الحساب المنفذ

المرؤوسون: Set-Cookie, Cache-Control, X-Request-Id

رد 200 · application/json

Account

رد 200
{
  "allOf": [
    {
      "$ref": "#/components/schemas/Account"
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "const": "active"
        },
        "emailVerified": {
          "const": true
        }
      }
    }
  ]
}

410 غير صحيح، أو منتهية الصلاحية، أو غير صالحة، أو مستعملة بالفعل، أو فقدت سباقا متزامنا للتأكيد. Problem.code is `token_unavailable`.

المرؤوسون: Cache-Control, X-Request-Id

رد 410 · application/problem+json

Problem

رد 410
{
  "$ref": "#/components/schemas/Problem"
}

422 فشل طلب التوثيق مجهول الهوية

المرؤوسون: Cache-Control, X-Request-Id

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

429 تجاوز الحد الأقصى لمعدل التوثيق مجهول الهوية

المرؤوسون: Cache-Control, Retry-After, X-Request-Id

رد 429 · application/problem+json

Problem

رد 429
{
  "$ref": "#/components/schemas/Problem"
}

500 حدث خطأ غير متوقع في التوثيق المجهول

المرؤوسون: Cache-Control, X-Request-Id

رد 500 · application/problem+json

Problem

رد 500
{
  "$ref": "#/components/schemas/Problem"
}

503 التبعية من مجهول الهوية غير متاحة مؤقتاً

المرؤوسون: Cache-Control, X-Request-Id

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/auth/email-verifications/session

مواصلة جلسة التوقيع الأصلية بعد التحقق من البريد الإلكتروني

يَشترطُ a يُسْمحُ أوريجين و CSRF مُلزمة بجلسة تدقيق بالبريد الإلكتروني لكلمة سر حية. العودة معلقة حتى يتم التحقق من حساب تلك الجلسة الخاصة، بما في ذلك التحقق في بروزر آخر. تلغي دورة الاشتراك من الناحية الذرية وتنظم دورة جديدة كاملة أو قانونية للاعتماد. لا يقبل حساب ID، أو البريد الإلكتروني، أو كلمة السر، أو التحقق المكشوف، أو القبول القانوني الالتفافي، أو الائتمانات الممنوحة.

Authentication: cookieSession + csrfToken

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

طلب الجسد؟ · المطلوب

Schema · application/json
Schema
{
  "type": "object",
  "additionalProperties": false
}

الردود

200 جلسة التوقيع تناوبت

المرؤوسون: Set-Cookie, Cache-Control

رد 200 · application/json

LoginResponse

رد 200
{
  "$ref": "#/components/schemas/LoginResponse"
}

202 التحقق من البريد الإلكتروني معلّق؛ لا توجد دورة جديدة

المرؤوسون: Cache-Control

رد 202 · application/json
رد 202
{
  "type": "object",
  "required": [
    "pending"
  ],
  "additionalProperties": false,
  "properties": {
    "pending": {
      "type": "boolean",
      "const": true
    }
  }
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 مثبتة ولكن غير مسموح بها، أو لم تُثبت شركة CSRF

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

422 فشل التثبت من الطلب

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

500 حدث خطأ داخلي غير متوقع

رد 500 · application/problem+json

Problem

رد 500
{
  "$ref": "#/components/schemas/Problem"
}
POST/auth/password-resets

نطلب إعادة إرسال رسالة بالبريد الإلكتروني

دائماً ما يعيد نفس رد 202 إلى بريد إلكتروني سليم عملياً بغض النظر عن وجود الحسابات أو حالة دورة الحياة. فقط الهويات الناشطة أو المقفلة المؤهلة تحصل على البريد.

Authentication: الجمهور

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

طلب الجسد؟ · المطلوب

Schema · application/json
Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "email"
  ],
  "properties": {
    "email": {
      "type": "string",
      "format": "email",
      "maxLength": 320
    }
  }
}

الردود

202 تم قبول الطلب ولا يكشف الرد عما إذا كان هناك حساب.

المرؤوسون: Cache-Control, X-Request-Id

رد 202 · application/json
رد 202
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "accepted"
  ],
  "properties": {
    "accepted": {
      "type": "boolean",
      "const": true
    }
  }
}

422 فشل طلب التوثيق مجهول الهوية

المرؤوسون: Cache-Control, X-Request-Id

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

429 تجاوز الحد الأقصى لمعدل التوثيق مجهول الهوية

المرؤوسون: Cache-Control, Retry-After, X-Request-Id

رد 429 · application/problem+json

Problem

رد 429
{
  "$ref": "#/components/schemas/Problem"
}

500 حدث خطأ غير متوقع في التوثيق المجهول

المرؤوسون: Cache-Control, X-Request-Id

رد 500 · application/problem+json

Problem

رد 500
{
  "$ref": "#/components/schemas/Problem"
}

503 التبعية من مجهول الهوية غير متاحة مؤقتاً

المرؤوسون: Cache-Control, X-Request-Id

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/auth/password-resets/confirm

وضع كلمة سر جديدة وإلغاء الدورات الحالية

يستهلك من الناحية الذرية رمز كلمة السر، ويخزن عقيدة جديدة من طراز Argon2id، ويلغي كل دورة قائمة، ويبطل رموزا أخرى من كلمات السر. ولا يسجل المستعمل في جلسة أو يُنشئها.

Authentication: الجمهور

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

طلب الجسد؟ · المطلوب

Schema · application/json

Password

Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "token",
    "password"
  ],
  "properties": {
    "token": {
      "type": "string",
      "minLength": 32,
      "maxLength": 256,
      "writeOnly": true
    },
    "password": {
      "$ref": "#/components/schemas/Password"
    }
  }
}

الردود

204 تحديث كلمة السر؛ وألغيت الجلسات الحالية

المرؤوسون: Cache-Control, X-Request-Id

410 غير صحيح، أو منتهية الصلاحية، أو غير صالحة، أو مستعملة بالفعل، أو فقدت سباقا متزامنا للتأكيد. Problem.code is `token_unavailable`.

المرؤوسون: Cache-Control, X-Request-Id

رد 410 · application/problem+json

Problem

رد 410
{
  "$ref": "#/components/schemas/Problem"
}

422 فشل طلب التوثيق مجهول الهوية

المرؤوسون: Cache-Control, X-Request-Id

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

429 تجاوز الحد الأقصى لمعدل التوثيق مجهول الهوية

المرؤوسون: Cache-Control, Retry-After, X-Request-Id

رد 429 · application/problem+json

Problem

رد 429
{
  "$ref": "#/components/schemas/Problem"
}

500 حدث خطأ غير متوقع في التوثيق المجهول

المرؤوسون: Cache-Control, X-Request-Id

رد 500 · application/problem+json

Problem

رد 500
{
  "$ref": "#/components/schemas/Problem"
}

503 التبعية من مجهول الهوية غير متاحة مؤقتاً

المرؤوسون: Cache-Control, X-Request-Id

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
GET/auth/sessions

قائمة بالدورات النشطة للمستعمل الحالي

Authentication: cookieSession

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

الردود

200 الدورات

المرؤوسون: Cache-Control, X-Request-Id

رد 200 · application/json

Session

رد 200
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Session"
      }
    }
  }
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}
DELETE/auth/sessions

راجع جميع الجلسات باستثناء الجلسات الحالية

Authentication: cookieSession + csrfToken

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

الردود

204 الدورات الأخرى التي ألغيت

المرؤوسون: Cache-Control, X-Request-Id

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 مثبتة ولكن غير مسموح بها، أو لم تُثبت شركة CSRF

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}
DELETE/auth/sessions/{sessionId}

الدورة الأولى

Authentication: cookieSession + csrfToken

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

sessionId · path · المطلوب

Schema
Schema
{
  "type": "string",
  "pattern": "^ses_"
}

الردود

204 الجلسة ألغيت إذا كانت الدورة الحالية، الكعكة مُطهّرة.

المرؤوسون: Set-Cookie, Cache-Control, X-Request-Id

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 مثبتة ولكن غير مسموح بها، أو لم تُثبت شركة CSRF

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

404 الموارد التي لم يعثر عليها أو لا يملكها المتصل

رد 404 · application/problem+json

Problem

رد 404
{
  "$ref": "#/components/schemas/Problem"
}

409 النزاع في حالة الموارد أو الافتراض

رد 409 · application/problem+json

Problem

رد 409
{
  "$ref": "#/components/schemas/Problem"
}

422 فشل التثبت من الطلب

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

503 التبعية المطلوبة أو المكتال غير متاح بصورة مؤقتة

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/auth/re-authenticate

التحقق من كلمة السر الحالية لعملية حساسة

يسجل دليلا قصير الأجل مؤخّرا على الدورة الحالية لجانب الخادم.

Authentication: cookieSession + csrfToken

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

طلب الجسد؟ · المطلوب

Schema · application/json
Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "password"
  ],
  "properties": {
    "password": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "writeOnly": true
    }
  }
}

الردود

200 الجلسة قد اثبتت مؤخرا

المرؤوسون: Cache-Control, X-Request-Id

رد 200 · application/json

Reauthentication

رد 200
{
  "$ref": "#/components/schemas/Reauthentication"
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 مثبتة ولكن غير مسموح بها، أو لم تُثبت شركة CSRF

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

429 تجاوز الحد الأقصى للمعدلات أو المطابقة أو الدفعات أو الحد المقرر للعمل

المرؤوسون: Retry-After

رد 429 · application/problem+json

Problem

رد 429
{
  "$ref": "#/components/schemas/Problem"
}
PATCH/auth/password

تغيير كلمة السر وتناوب الدورة الحالية

Authentication: cookieSession + csrfToken

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

طلب الجسد؟ · المطلوب

Schema · application/json

Password

Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "currentPassword",
    "newPassword"
  ],
  "properties": {
    "currentPassword": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "writeOnly": true
    },
    "newPassword": {
      "$ref": "#/components/schemas/Password"
    },
    "revokeOtherSessions": {
      "type": "boolean",
      "default": true
    }
  }
}

الردود

204 تغيرت كلمة السر؛ وتناوبت الدورة الحالية وألغيت الدورات الأخرى عند الطلب

المرؤوسون: Set-Cookie, Cache-Control, X-Request-Id

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 مثبتة ولكن غير مسموح بها، أو لم تُثبت شركة CSRF

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

422 فشل التثبت من الطلب

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

الحساب

GET/oauth/connections

قائمة تطبيقات الحساب الحالي ذات الصلة

الدورة الكاملة مطلوبة. فارغ عندما لا يكون للحساب تطبيقات متصلة الاستجابة ليست مُقدّمة.

Authentication: cookieSession

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

الردود

200 Connected apps

رد 200 · application/json

OAuthConnection

رد 200
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OAuthConnection"
      }
    }
  }
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 مثبتة ولكن غير مسموح بها، أو لم تُثبت شركة CSRF

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}
DELETE/oauth/connections/{grantId}

إحياء تطبيق متصل ومكرس له API المفتاح

الدورة الكاملة، CSRF وسمحت للأوغين بأن يطلب. ويتم إنفاذ الملكية الحسابية. الاستجابة ليست مُقدّمة.

Authentication: cookieSession + csrfToken

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

grantId · path · المطلوب

Schema
Schema
{
  "type": "string",
  "pattern": "^oag_[A-Za-z0-9_-]{8,}$"
}

الردود

204 ألغي الإذن

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 مثبتة ولكن غير مسموح بها، أو لم تُثبت شركة CSRF

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

404 الموارد التي لم يعثر عليها أو لا يملكها المتصل

رد 404 · application/problem+json

Problem

رد 404
{
  "$ref": "#/components/schemas/Problem"
}
GET/account

الحسابات الجاهزة

Authentication: cookieSession

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

الردود

200 الحساب

رد 200 · application/json

Account

رد 200
{
  "$ref": "#/components/schemas/Account"
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}
PATCH/account

آخر الملامح

Authentication: cookieSession + csrfToken

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

طلب الجسد؟ · المطلوب

Schema · application/json

UpdateAccountRequest

Schema
{
  "$ref": "#/components/schemas/UpdateAccountRequest"
}

الردود

200 الحساب المستكمل

رد 200 · application/json

Account

رد 200
{
  "$ref": "#/components/schemas/Account"
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 مثبتة ولكن غير مسموح بها، أو لم تُثبت شركة CSRF

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

422 فشل التثبت من الطلب

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}
DELETE/account

إقفال حسابات الجدول وإلغاء جميع الدورات الحالية و API Keys

ويجب أن تُلغى حسابات مدير البرنامج دورها من خلال سير عمل المشغل المراجَع قبل تحديد موعد لحذفها. وثمة طلب نشيط فريد من نوعه هو حدود الايدمان الطبيعي. وتعيد الجداول الموثقة المتزامنة الطلب نفسه. وبعد إلغاء الدورة، استرد رد ضائع بقطع الأشجار إلى نمط deletion_recovery وقراءة GET /account/deletion؛ ولم تقبل الدورات الملغومة قط لإعادة اللعب.

Authentication: cookieSession + csrfToken

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

طلب الجسد؟ · المطلوب

Schema · application/json
Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "password",
    "confirmation"
  ],
  "properties": {
    "password": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "writeOnly": true
    },
    "confirmation": {
      "type": "string",
      "const": "DELETE"
    }
  }
}

الردود

202 الحذف المقرر؛ إلغاء الدورات والمفاتيح النشطة

رد 202 · application/json

AccountDeletionRequest

رد 202
{
  "$ref": "#/components/schemas/AccountDeletionRequest"
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 مثبتة ولكن غير مسموح بها، أو لم تُثبت شركة CSRF

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

409 النزاع في حالة الموارد أو الافتراض

رد 409 · application/problem+json

Problem

رد 409
{
  "$ref": "#/components/schemas/Problem"
}

422 فشل التثبت من الطلب

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}
GET/account/deletion

اقرأ طلب حذف الحساب الجاري

Authentication: cookieSession

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

الردود

200 طلب الحذف الحالي

رد 200 · application/json

AccountDeletionRequest

رد 200
{
  "$ref": "#/components/schemas/AccountDeletionRequest"
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

404 الموارد التي لم يعثر عليها أو لا يملكها المتصل

رد 404 · application/problem+json

Problem

رد 404
{
  "$ref": "#/components/schemas/Problem"
}
DELETE/account/deletion

الغى الحذف المقرر خلال فترة النعمة

يُستخدم مُقرّر مُلغى مُقارنة و مُحدّدة. ويعود عنصر المعالج 409؛ وبعد النجاح، تدور دورة التعافي ولا يمكن أن تعيد أداء المرحلة الانتقالية القديمة.

Authentication: cookieSession + csrfToken

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

الردود

204 إلغاء الحذف، وإعادة تنشيط الحساب، وتناوبت جلسة الاسترداد وفقاً لبوابة القبول القانوني

المرؤوسون: Set-Cookie, Cache-Control, X-Request-Id

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 مثبتة ولكن غير مسموح بها، أو لم تُثبت شركة CSRF

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

404 الموارد التي لم يعثر عليها أو لا يملكها المتصل

رد 404 · application/problem+json

Problem

رد 404
{
  "$ref": "#/components/schemas/Problem"
}

409 النزاع في حالة الموارد أو الافتراض

رد 409 · application/problem+json

Problem

رد 409
{
  "$ref": "#/components/schemas/Problem"
}
POST/account/legal-acceptances

قبول الإصدارين المنشورين حاليًا من الشروط وسياسة الخصوصية

يضيف سجل قبول قانوني غير قابل للتعديل، ويزيل شرط الترحيل، ويدوّر Session. تُرفض الإصدارات القديمة المرسلة.

Authentication: cookieSession + csrfToken

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

طلب الجسد؟ · المطلوب

Schema · application/json

LegalAcceptanceRequest

Schema
{
  "$ref": "#/components/schemas/LegalAcceptanceRequest"
}

الردود

200 :: تسجيل القبول القانوني وتناوبت الجلسة على نحو كامل

المرؤوسون: Set-Cookie, Cache-Control, X-Request-Id

رد 200 · application/json

LoginResponse

رد 200
{
  "$ref": "#/components/schemas/LoginResponse"
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 مثبتة ولكن غير مسموح بها، أو لم تُثبت شركة CSRF

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

404 الموارد التي لم يعثر عليها أو لا يملكها المتصل

رد 404 · application/problem+json

Problem

رد 404
{
  "$ref": "#/components/schemas/Problem"
}

422 فشل التثبت من الطلب

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

على متن السفينة

GET/onboarding

اقرأ التقدم الذي يمكن الاستغناء عنه

Authentication: cookieSession

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

الردود

200 الحالة الراهنة على متن السفينة

المرؤوسون: Cache-Control, X-Request-Id

رد 200 · application/json

OnboardingProgress

رد 200
{
  "$ref": "#/components/schemas/OnboardingProgress"
}

401 التوثيق المطلوب أو غير صحيح

المرؤوسون: Cache-Control, X-Request-Id

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

500 حدث خطأ داخلي غير متوقع

المرؤوسون: Cache-Control, X-Request-Id

رد 500 · application/problem+json

Problem

رد 500
{
  "$ref": "#/components/schemas/Problem"
}

503 التبعية المطلوبة أو التسجيل غير متاح بصورة مؤقتة

المرؤوسون: Cache-Control, X-Request-Id

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
PATCH/onboarding

تقدم على متن السفينة دون السماح بالتقدم بالتراجع

Authentication: cookieSession + csrfToken

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

طلب الجسد؟ · المطلوب

Schema · application/json

UpdateOnboardingRequest

Schema
{
  "$ref": "#/components/schemas/UpdateOnboardingRequest"
}

الردود

200 آخر المستجدات على متن الولاية

المرؤوسون: Cache-Control, X-Request-Id

رد 200 · application/json

OnboardingProgress

رد 200
{
  "$ref": "#/components/schemas/OnboardingProgress"
}

401 التوثيق المطلوب أو غير صحيح

المرؤوسون: Cache-Control, X-Request-Id

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 مثبتة ولكن غير مسموح بها، أو لم تُثبت شركة CSRF

المرؤوسون: Cache-Control, X-Request-Id

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

409 النزاع في حالة الموارد أو الافتراض

المرؤوسون: Cache-Control, X-Request-Id

رد 409 · application/problem+json

Problem

رد 409
{
  "$ref": "#/components/schemas/Problem"
}

422 فشل التثبت من الطلب

المرؤوسون: Cache-Control, X-Request-Id

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

500 حدث خطأ داخلي غير متوقع

المرؤوسون: Cache-Control, X-Request-Id

رد 500 · application/problem+json

Problem

رد 500
{
  "$ref": "#/components/schemas/Problem"
}

503 التبعية المطلوبة أو التسجيل غير متاح بصورة مؤقتة

المرؤوسون: Cache-Control, X-Request-Id

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}

نظرة عامة

GET/overview

إقرأْ مجموعَ لوحةَ دبوسَ الحسابَ

Authentication: cookieSession

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

الردود

200 لمحة عامة مقترضة بالحساب

المرؤوسون: Cache-Control, X-Request-Id

رد 200 · application/json

ConsoleOverview

رد 200
{
  "$ref": "#/components/schemas/ConsoleOverview"
}

401 التوثيق المطلوب أو غير صحيح

المرؤوسون: Cache-Control, X-Request-Id

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

500 حدث خطأ داخلي غير متوقع

المرؤوسون: Cache-Control, X-Request-Id

رد 500 · application/problem+json

Problem

رد 500
{
  "$ref": "#/components/schemas/Problem"
}

503 التبعية المطلوبة أو التسجيل غير متاح بصورة مؤقتة

المرؤوسون: Cache-Control, X-Request-Id

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}

API Keys

GET/api-access/identity

التحقق من الملكية الرئيسية الحالية للشركة API والاستعداد المتكرر

رئيس مجاني فقط API-حسناً Res public account/key IDs and authoritative ownership. لا يوجد طلب للجثة لا يُغيّرُ القائمةَ /api-access ردة فعل يتقاسم الحد الأقصى لقراءة حسابات 120/minute. الفشل مغلق على عدم توافره؛ لا تُخَلِّص من الملكية الأساسية أو الخطة أو الدولة المحلية. لا توجد معايير للاستفسار مقبولة. الردود ليست مخزنة.

Authentication: dataApiKey

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

الردود

200 التحقق من الملكية الرئيسية الحالية للشركة API والاستعداد المتكرر

رد 200 · application/json

APIKeyIdentity

رد 200
{
  "$ref": "#/components/schemas/APIKeyIdentity"
}

400 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 400 · application/problem+json

Problem

رد 400
{
  "$ref": "#/components/schemas/Problem"
}

401 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

409 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 409 · application/problem+json

Problem

رد 409
{
  "$ref": "#/components/schemas/Problem"
}

410 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 410 · application/problem+json

Problem

رد 410
{
  "$ref": "#/components/schemas/Problem"
}

422 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

429 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 429 · application/problem+json

Problem

رد 429
{
  "$ref": "#/components/schemas/Problem"
}

503 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
GET/api-keys

القائمة API Key metadata

Authentication: cookieSession

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

الردود

200 API Keys بدون أسرار

رد 200 · application/json

ApiKey

رد 200
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ApiKey"
      }
    }
  }
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}
POST/api-keys

Create an API Key and reveal its secret once

Authentication: cookieSession + csrfToken

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

Idempotency-Key · header · المطلوب

Schema
Schema
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

طلب الجسد؟ · المطلوب

Schema · application/json

CreateApiKeyRequest

Schema
{
  "$ref": "#/components/schemas/CreateApiKeyRequest"
}

الردود

201 الإبداع؛ وقد يعود نفس التلاعب الإيديبي إلى نفس الرد المشفر لمدة خمس دقائق

رد 201 · application/json

ApiKeyCreated

رد 201
{
  "$ref": "#/components/schemas/ApiKeyCreated"
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 مثبتة ولكن غير مسموح بها، أو لم تُثبت شركة CSRF

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

409 النزاع في حالة الموارد أو الافتراض

رد 409 · application/problem+json

Problem

رد 409
{
  "$ref": "#/components/schemas/Problem"
}

422 فشل التثبت من الطلب

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

503 التبعية المطلوبة أو المكتال غير متاح بصورة مؤقتة

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
DELETE/api-keys/{keyId}

Revoke an API Key

Authentication: cookieSession + csrfToken

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

keyId · path · المطلوب

Schema
Schema
{
  "type": "string",
  "pattern": "^key_"
}

الردود

204 Revoked

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 مثبتة ولكن غير مسموح بها، أو لم تُثبت شركة CSRF

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

404 الموارد التي لم يعثر عليها أو لا يملكها المتصل

رد 404 · application/problem+json

Problem

رد 404
{
  "$ref": "#/components/schemas/Problem"
}

503 التبعية المطلوبة أو المكتال غير متاح بصورة مؤقتة

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/api-keys/{keyId}/rotate

إنشاء مفتاح بديل والجدول الزمني للإلغاء القديم

يخلق مفتاحا جديدا ويبقي المفتاح القديم نشطا حتى revokeOldAt. ويستغرق التداخل، في حالة التقصير، ساعات من الـ 24 أو إلى أن تنتهي صلاحية المفتاح القديم، أيهما كان سابقا. ويجب أن يكون العرف revokeOldAt في المستقبل، في غضون سبعة أيام، وفي موعد لا يتجاوز الانهيار الرئيسي القديم.

Authentication: cookieSession + csrfToken

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

keyId · path · المطلوب

Schema
Schema
{
  "type": "string",
  "pattern": "^key_"
}

Idempotency-Key · header · المطلوب

Schema
Schema
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

طلب الجسد؟ · اختياري

Schema · application/json
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "revokeOldAt": {
      "type": "string",
      "format": "date-time",
      "description": "Optional old-key revocation time; defaults to 24 hours and cannot exceed seven days or the old key expiry."
    }
  }
}

الردود

201 الاستبدال الذي تم خلقه؛ وعاد سره مرة واحدة

رد 201 · application/json

ApiKeyCreated

رد 201
{
  "$ref": "#/components/schemas/ApiKeyCreated"
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 مثبتة ولكن غير مسموح بها، أو لم تُثبت شركة CSRF

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

404 الموارد التي لم يعثر عليها أو لا يملكها المتصل

رد 404 · application/problem+json

Problem

رد 404
{
  "$ref": "#/components/schemas/Problem"
}

409 النزاع في حالة الموارد أو الافتراض

رد 409 · application/problem+json

Problem

رد 409
{
  "$ref": "#/components/schemas/Problem"
}

422 فشل التثبت من الطلب

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

503 التبعية المطلوبة أو المكتال غير متاح بصورة مؤقتة

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
GET/api-access

إقرأْ نداءَ API المصادرَ المأذونَةَ ومصدرَ النتيجةَ

مجاني، رئيس فقط X-API-Key التوثيق حالات العودة الممنوحة للجمهور فقط أسماء المصادر والأصل المركب المركب للتخزين (null) غير متوافر. No account ID, key ID, secret or storage accreditation are returned. محلية MCP يُعيد ترتيب هذه النقطة النهائية قبل أن تكتشف كل أداة و تتصل بما في ذلك قراءه النتائج ولا تُقبل أي معايير للاستفسار أو أي هيئة طلب. وتتقاسم جميع مسارات /api-access طلبات 120 في الدقيقة لكل عميل من شركاء التنفيذ وتعود (كاش) من القطاع الخاص، من غير المُنظمة. لا يزال التتبع العادي الذي استخدم لآخر مرة يحدث.

Authentication: dataApiKey

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

الردود

200 المصادر العامة المأذون بها ومصدر النتائج

رد 200 · application/json

ApiAccess

رد 200
{
  "$ref": "#/components/schemas/ApiAccess"
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

422 فشل التثبت من الطلب

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

429 عدد كبير جداً من الحسابات يقرأ، يعاد النظر بعد نافذة الحد الأقصى للمعدل

503 التبعية المطلوبة أو المكتال غير متاح بصورة مؤقتة

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}

الوكيل إتحادات

GET/agent-connections/capabilities

بروتوكول الكشف 2 على متن السفينة

لا توجد معايير للاستفسار مقبولة. الردود ليست مخزنة. وطرق العمل هي الإدارة وحدها ورسم الملامح؛ ويمكن للنشر أن يعيد 404 عندما يكون معوقا. X-API-Key محظور على مسارات العميل.

Authentication: الجمهور

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

الردود

200 بروتوكول الكشف 2 على متن السفينة

رد 200 · application/json

AgentCapabilities

رد 200
{
  "$ref": "#/components/schemas/AgentCapabilities"
}

400 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 400 · application/problem+json

Problem

رد 400
{
  "$ref": "#/components/schemas/Problem"
}

401 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

409 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 409 · application/problem+json

Problem

رد 409
{
  "$ref": "#/components/schemas/Problem"
}

410 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 410 · application/problem+json

Problem

رد 410
{
  "$ref": "#/components/schemas/Problem"
}

422 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

429 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 429 · application/problem+json

Problem

رد 429
{
  "$ref": "#/components/schemas/Problem"
}

503 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/agent-connections/registrations

إنشاء أو استعادة وصلة مؤقتة من طراز API-key

احفظ إثبات التسجيل والمدخلات نفسها قبل POST. يستعيد الإثبات والجسم نفسيهما التجربة نفسها؛ ويؤدي تغيير المدخلات إلى تعارض. التجربة المؤقتة: 1 Credit، و72 ساعة، و1 طلب/ثانية، وحجم batch يساوي 1. تبقى حدود صلاحيات المصادر المفروضة على الخادم هي المرجع. لا تُقبل معاملات الاستعلام. الاستجابات no-store. مسارات الوكيل للإدارة فقط وتخضع لتفعيل الميزة؛ وقد تعيد عمليات النشر 404 عند تعطيلها. يُمنع X-API-Key في مسارات الوكيل.

Authentication: agentRegistrationProof

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

طلب الجسد؟ · المطلوب

Schema · application/json

AgentRegistrationRequest

Schema
{
  "$ref": "#/components/schemas/AgentRegistrationRequest"
}

الردود

201 إنشاء أو استعادة وصلة مؤقتة من طراز API-key

رد 201 · application/json

AgentRegistration

رد 201
{
  "$ref": "#/components/schemas/AgentRegistration"
}

400 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 400 · application/problem+json

Problem

رد 400
{
  "$ref": "#/components/schemas/Problem"
}

401 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

409 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 409 · application/problem+json

Problem

رد 409
{
  "$ref": "#/components/schemas/Problem"
}

410 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 410 · application/problem+json

Problem

رد 410
{
  "$ref": "#/components/schemas/Problem"
}

422 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

429 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 429 · application/problem+json

Problem

رد 429
{
  "$ref": "#/components/schemas/Problem"
}

503 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
GET/agent-connections/owned

قائمة بالوصلات التي يملكها المتجولون

لا توجد معايير للاستفسار مقبولة. الردود ليست مخزنة. وطرق العمل هي الإدارة وحدها ورسم الملامح؛ ويمكن للنشر أن يعيد 404 عندما يكون معوقا. X-API-Key محظور على مسارات العميل. عملية مملوءة بـ (بروزر) ولا بد من إجراء جلسة متحققة بالكامل؛ ولا ينبغي للمتصل أن يحل محل مفتاح أو دليل من طراز API.

Authentication: cookieSession

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

الردود

200 قائمة بالوصلات التي يملكها المتجولون

رد 200 · application/json

AgentConnection

رد 200
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "connections": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AgentConnection"
      }
    }
  },
  "required": [
    "connections"
  ]
}

400 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 400 · application/problem+json

Problem

رد 400
{
  "$ref": "#/components/schemas/Problem"
}

401 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

409 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 409 · application/problem+json

Problem

رد 409
{
  "$ref": "#/components/schemas/Problem"
}

410 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 410 · application/problem+json

Problem

رد 410
{
  "$ref": "#/components/schemas/Problem"
}

422 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

429 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 429 · application/problem+json

Problem

رد 429
{
  "$ref": "#/components/schemas/Problem"
}

503 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
GET/agent-connections/{connectionId}

الحصول على مركز الاتصال المؤقت

لا توجد معايير للاستفسار مقبولة. الردود ليست مخزنة. وطرق العمل هي الإدارة وحدها ورسم الملامح؛ ويمكن للنشر أن يعيد 404 عندما يكون معوقا. X-API-Key محظور على مسارات العميل.

Authentication: agentSetupCredential

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

connectionId · path · المطلوب

Schema
Schema
{
  "type": "string",
  "pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}

الردود

200 الحصول على مركز الاتصال المؤقت

رد 200 · application/json

AgentConnectionResponse

رد 200
{
  "$ref": "#/components/schemas/AgentConnectionResponse"
}

400 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 400 · application/problem+json

Problem

رد 400
{
  "$ref": "#/components/schemas/Problem"
}

401 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

409 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 409 · application/problem+json

Problem

رد 409
{
  "$ref": "#/components/schemas/Problem"
}

410 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 410 · application/problem+json

Problem

رد 410
{
  "$ref": "#/components/schemas/Problem"
}

422 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

429 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 429 · application/problem+json

Problem

رد 429
{
  "$ref": "#/components/schemas/Problem"
}

503 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
DELETE/agent-connections/{connectionId}

راجعوا الإتصالات الملكية

لا توجد معايير للاستفسار مقبولة. الردود ليست مخزنة. وطرق العمل هي الإدارة وحدها ورسم الملامح؛ ويمكن للنشر أن يعيد 404 عندما يكون معوقا. X-API-Key محظور على مسارات العميل. عملية مملوءة بـ (بروزر) ولا بد من إجراء جلسة متحققة بالكامل؛ ولا ينبغي للمتصل أن يحل محل مفتاح أو دليل من طراز API.

Authentication: cookieSession + csrfToken

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

connectionId · path · المطلوب

Schema
Schema
{
  "type": "string",
  "pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}

Origin · header · المطلوب

Schema
Schema
{
  "type": "string"
}

X-CSRF-Token · header · المطلوب

Schema
Schema
{
  "type": "string"
}

الردود

204 راجعوا الإتصالات الملكية

400 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 400 · application/problem+json

Problem

رد 400
{
  "$ref": "#/components/schemas/Problem"
}

401 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

409 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 409 · application/problem+json

Problem

رد 409
{
  "$ref": "#/components/schemas/Problem"
}

410 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 410 · application/problem+json

Problem

رد 410
{
  "$ref": "#/components/schemas/Problem"
}

422 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

429 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 429 · application/problem+json

Problem

رد 429
{
  "$ref": "#/components/schemas/Problem"
}

503 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
GET/agent-connections/{connectionId}/identity

التحقق من البيانات الحالية API مفتاح للتواصل

لا توجد معايير للاستفسار مقبولة. الردود ليست مخزنة. وطرق العمل هي الإدارة وحدها ورسم الملامح؛ ويمكن للنشر أن يعيد 404 عندما يكون معوقا. X-API-Key محظور على مسارات العميل.

Authentication: agentIdentityKey

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

connectionId · path · المطلوب

Schema
Schema
{
  "type": "string",
  "pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}

الردود

200 التحقق من البيانات الحالية API مفتاح للتواصل

رد 200 · application/json

AgentConnectionResponse

رد 200
{
  "$ref": "#/components/schemas/AgentConnectionResponse"
}

400 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 400 · application/problem+json

Problem

رد 400
{
  "$ref": "#/components/schemas/Problem"
}

401 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

409 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 409 · application/problem+json

Problem

رد 409
{
  "$ref": "#/components/schemas/Problem"
}

410 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 410 · application/problem+json

Problem

رد 410
{
  "$ref": "#/components/schemas/Problem"
}

422 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

429 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 429 · application/problem+json

Problem

رد 429
{
  "$ref": "#/components/schemas/Problem"
}

503 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
GET/agent-connections/{connectionId}/onboarding

مُسترجعة في الولاية

لا توجد معايير للاستفسار مقبولة. الردود ليست مخزنة. وطرق العمل هي الإدارة وحدها ورسم الملامح؛ ويمكن للنشر أن يعيد 404 عندما يكون معوقا. X-API-Key محظور على مسارات العميل.

Authentication: agentHandoffProof

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

connectionId · path · المطلوب

Schema
Schema
{
  "type": "string",
  "pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}

الردود

200 مُسترجعة في الولاية

رد 200 · application/json

AgentOnboardingStatus

رد 200
{
  "$ref": "#/components/schemas/AgentOnboardingStatus"
}

400 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 400 · application/problem+json

Problem

رد 400
{
  "$ref": "#/components/schemas/Problem"
}

401 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

409 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 409 · application/problem+json

Problem

رد 409
{
  "$ref": "#/components/schemas/Problem"
}

410 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 410 · application/problem+json

Problem

رد 410
{
  "$ref": "#/components/schemas/Problem"
}

422 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

429 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 429 · application/problem+json

Problem

رد 429
{
  "$ref": "#/components/schemas/Problem"
}

503 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/agent-connections/{connectionId}/claims

إنشاء مطالبة للموافقة على المصفوفين

(أ) فتح موقع (زكس كيزوك (claimPath على شبكة الويب (FlashData) الموثوق بها وعرض الرمز بشكل منفصل. لا تضع أبداً وثائق التفويض أو رمز التأكيد في URL. لا توجد معايير للاستفسار مقبولة. الردود ليست مخزنة. وطرق العمل هي الإدارة وحدها ورسم الملامح؛ ويمكن للنشر أن يعيد 404 عندما يكون معوقا. X-API-Key محظور على مسارات العميل.

Authentication: agentSetupCredential

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

connectionId · path · المطلوب

Schema
Schema
{
  "type": "string",
  "pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}

طلب الجسد؟ · المطلوب

Schema · application/json
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {},
  "required": []
}

الردود

201 إنشاء مطالبة للموافقة على المصفوفين

رد 201 · application/json

AgentClaim

رد 201
{
  "$ref": "#/components/schemas/AgentClaim"
}

400 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 400 · application/problem+json

Problem

رد 400
{
  "$ref": "#/components/schemas/Problem"
}

401 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

409 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 409 · application/problem+json

Problem

رد 409
{
  "$ref": "#/components/schemas/Problem"
}

410 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 410 · application/problem+json

Problem

رد 410
{
  "$ref": "#/components/schemas/Problem"
}

422 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

429 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 429 · application/problem+json

Problem

رد 429
{
  "$ref": "#/components/schemas/Problem"
}

503 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/agent-connections/claims/{claimId}/confirm

تأكيد رمز المطالبة في دورة مصففة متحقق منها

لا توجد معايير للاستفسار مقبولة. الردود ليست مخزنة. وطرق العمل هي الإدارة وحدها ورسم الملامح؛ ويمكن للنشر أن يعيد 404 عندما يكون معوقا. X-API-Key محظور على مسارات العميل. عملية مملوءة بـ (بروزر) ولا بد من إجراء جلسة متحققة بالكامل؛ ولا ينبغي للمتصل أن يحل محل مفتاح أو دليل من طراز API.

Authentication: cookieSession + csrfToken

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

claimId · path · المطلوب

Schema
Schema
{
  "type": "string",
  "pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}

Origin · header · المطلوب

Schema
Schema
{
  "type": "string"
}

X-CSRF-Token · header · المطلوب

Schema
Schema
{
  "type": "string"
}

طلب الجسد؟ · المطلوب

Schema · application/json
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "code": {
      "type": "string",
      "pattern": "^\\d{8}$"
    }
  },
  "required": [
    "code"
  ]
}

الردود

200 تأكيد رمز المطالبة في دورة مصففة متحقق منها

رد 200 · application/json

AgentBrowserClaim

رد 200
{
  "$ref": "#/components/schemas/AgentBrowserClaim"
}

400 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 400 · application/problem+json

Problem

رد 400
{
  "$ref": "#/components/schemas/Problem"
}

401 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

409 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 409 · application/problem+json

Problem

رد 409
{
  "$ref": "#/components/schemas/Problem"
}

410 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 410 · application/problem+json

Problem

رد 410
{
  "$ref": "#/components/schemas/Problem"
}

422 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

429 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 429 · application/problem+json

Problem

رد 429
{
  "$ref": "#/components/schemas/Problem"
}

503 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
GET/agent-connections/claims/{claimId}

اقرأ مطالبة مؤكدة في دورتها التي عقدت

لا توجد معايير للاستفسار مقبولة. الردود ليست مخزنة. وطرق العمل هي الإدارة وحدها ورسم الملامح؛ ويمكن للنشر أن يعيد 404 عندما يكون معوقا. X-API-Key محظور على مسارات العميل. عملية مملوءة بـ (بروزر) ولا بد من إجراء جلسة متحققة بالكامل؛ ولا ينبغي للمتصل أن يحل محل مفتاح أو دليل من طراز API.

Authentication: cookieSession

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

claimId · path · المطلوب

Schema
Schema
{
  "type": "string",
  "pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}

الردود

200 اقرأ مطالبة مؤكدة في دورتها التي عقدت

رد 200 · application/json

AgentClaimView

رد 200
{
  "$ref": "#/components/schemas/AgentClaimView"
}

400 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 400 · application/problem+json

Problem

رد 400
{
  "$ref": "#/components/schemas/Problem"
}

401 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

409 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 409 · application/problem+json

Problem

رد 409
{
  "$ref": "#/components/schemas/Problem"
}

410 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 410 · application/problem+json

Problem

رد 410
{
  "$ref": "#/components/schemas/Problem"
}

422 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

429 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 429 · application/problem+json

Problem

رد 429
{
  "$ref": "#/components/schemas/Problem"
}

503 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/agent-connections/claims/{claimId}/approve

الموافقة على خفض النطاقات والتمويل المتوازن للمحاسبة

لا توجد معايير للاستفسار مقبولة. الردود ليست مخزنة. وطرق العمل هي الإدارة وحدها ورسم الملامح؛ ويمكن للنشر أن يعيد 404 عندما يكون معوقا. X-API-Key محظور على مسارات العميل. عملية مملوءة بـ (بروزر) ولا بد من إجراء جلسة متحققة بالكامل؛ ولا ينبغي للمتصل أن يحل محل مفتاح أو دليل من طراز API.

Authentication: cookieSession + csrfToken

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

claimId · path · المطلوب

Schema
Schema
{
  "type": "string",
  "pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}

Origin · header · المطلوب

Schema
Schema
{
  "type": "string"
}

X-CSRF-Token · header · المطلوب

Schema
Schema
{
  "type": "string"
}

طلب الجسد؟ · المطلوب

Schema · application/json

AgentApproval

Schema
{
  "$ref": "#/components/schemas/AgentApproval"
}

الردود

200 الموافقة على خفض النطاقات والتمويل المتوازن للمحاسبة

رد 200 · application/json

AgentConnection

رد 200
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "connection": {
      "$ref": "#/components/schemas/AgentConnection"
    },
    "handoff": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "status": {
          "type": "string"
        },
        "expiresAt": {
          "type": "string",
          "format": "date-time"
        }
      },
      "required": [
        "status",
        "expiresAt"
      ]
    }
  },
  "required": [
    "connection",
    "handoff"
  ]
}

400 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 400 · application/problem+json

Problem

رد 400
{
  "$ref": "#/components/schemas/Problem"
}

401 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

409 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 409 · application/problem+json

Problem

رد 409
{
  "$ref": "#/components/schemas/Problem"
}

410 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 410 · application/problem+json

Problem

رد 410
{
  "$ref": "#/components/schemas/Problem"
}

422 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

429 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 429 · application/problem+json

Problem

رد 429
{
  "$ref": "#/components/schemas/Problem"
}

503 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/agent-connections/{connectionId}/handoff

Recover the approved owner API key

تنتهي صلاحية المفتاح المرشّح بعد 24 ساعة حتى تأكيد التثبيت ACK. احفظه ذريًا، وأعد تحميله في عملية جديدة وتحقق من الهوية قبل ACK. تستعيد عملية التسليم المتكررة المرشّح نفسه؛ ويعيد التسليم المؤكد إيصالًا دون بيانات اعتماد. لا تُقبل معاملات الاستعلام. الاستجابات no-store. مسارات الوكيل للإدارة فقط وتخضع لتفعيل الميزة؛ وقد تعيد عمليات النشر 404 عند تعطيلها. يُمنع X-API-Key في مسارات الوكيل.

Authentication: agentHandoffProof

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

connectionId · path · المطلوب

Schema
Schema
{
  "type": "string",
  "pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}

طلب الجسد؟ · المطلوب

Schema · application/json
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {},
  "required": []
}

الردود

200 Recover the approved owner API key

رد 200 · application/json

AgentHandoff

رد 200
{
  "$ref": "#/components/schemas/AgentHandoff"
}

400 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 400 · application/problem+json

Problem

رد 400
{
  "$ref": "#/components/schemas/Problem"
}

401 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

409 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 409 · application/problem+json

Problem

رد 409
{
  "$ref": "#/components/schemas/Problem"
}

410 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 410 · application/problem+json

Problem

رد 410
{
  "$ref": "#/components/schemas/Problem"
}

422 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

429 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 429 · application/problem+json

Problem

رد 429
{
  "$ref": "#/components/schemas/Problem"
}

503 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/agent-connections/{connectionId}/handoff/ack

التركيب المتحقق من جانب المالك

لا بدّ أنّ (كالر) أنقذ المرشّح بالفعل وتحقق منه بشكل مستقل في عملية جديدة. وتركّبت علامات ناجحة على الكبريت، وتزيل الصلاحية الرئيسية للمرشح، وتحذف مواد الإبداع التي يمكن استردادها. ACK Apeated is idempotent. لا توجد معايير للاستفسار مقبولة. الردود ليست مخزنة. وطرق العمل هي الإدارة وحدها ورسم الملامح؛ ويمكن للنشر أن يعيد 404 عندما يكون معوقا. X-API-Key محظور على مسارات العميل.

Authentication: agentHandoffProof

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

connectionId · path · المطلوب

Schema
Schema
{
  "type": "string",
  "pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}

طلب الجسد؟ · المطلوب

Schema · application/json
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "apiKey": {
      "type": "string"
    }
  },
  "required": [
    "apiKey"
  ]
}

الردود

200 التركيب المتحقق من جانب المالك

رد 200 · application/json

AgentHandoff

رد 200
{
  "$ref": "#/components/schemas/AgentHandoff"
}

400 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 400 · application/problem+json

Problem

رد 400
{
  "$ref": "#/components/schemas/Problem"
}

401 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

409 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 409 · application/problem+json

Problem

رد 409
{
  "$ref": "#/components/schemas/Problem"
}

410 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 410 · application/problem+json

Problem

رد 410
{
  "$ref": "#/components/schemas/Problem"
}

422 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

429 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 429 · application/problem+json

Problem

رد 429
{
  "$ref": "#/components/schemas/Problem"
}

503 طلب مرفوع؛ فحص رمز المشكلة. لا تُعيدُ أبدًا الطفرة بشكل أعمى.

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}

الحضانات

GET/catalog/sources

إدراج قدرات المصادر العامة دون تسعير محدد لحسابات

Authentication: الجمهور

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

الردود

200 دليل المصادر العامة

المرؤوسون: Cache-Control

رد 200 · application/json

DataSource

رد 200
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DataSource"
      }
    }
  }
}
GET/plans

List public USD plans and prices

Authentication: الجمهور

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

الردود

200 كتيب الخطة العامة

المرؤوسون: Cache-Control

رد 200 · application/json

PlanCatalog

رد 200
{
  "$ref": "#/components/schemas/PlanCatalog"
}
GET/legal/current

قراءة المصطلحات الحالية والصيغ الخاصة المطلوبة للتوقيع

Authentication: الجمهور

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

الردود

200 دليل الصيغة القانونية الحالية

المرؤوسون: Cache-Control

رد 200 · application/json

PublicLegalVersions

رد 200
{
  "$ref": "#/components/schemas/PublicLegalVersions"
}

Billing

GET/billing/subscription

اقرأ الاشتراك القطاعي الفعال

Authentication: cookieSession

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

الردود

200 استحقاق الاشتراك أو الاستحقاق من PAYG

رد 200 · application/json

Subscription

رد 200
{
  "$ref": "#/components/schemas/Subscription"
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}
POST/billing/checkout-sessions

إنشاء جلسة تفتيش مأهولة

وتستخدم الاشتراكات ومجموعات الائتمان المنشورة priceId. استخدامات التمارين الفوقية amountMinor بدلا من ذلكUSD سنتات، دولار10 إلى دولار واحد999,999.99(أ) يحسب الخادم الأرصدة الدائنة بقيمة ائتمانية ثابتة وينشئ سعراً خاصاً لمرة واحدة في قطاعية. لم يقبل من المصفح أبداً المنتجات، وأسعار المورد، والعملة، والنجاح في URL، وإلغاء URL. ولا تُمنح القروض إلا بعد أن يتم التحقق من حدوث حدث مدفوع عن المبلغ المقتبس.

Authentication: cookieSession + csrfToken

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

Idempotency-Key · header · المطلوب

Schema
Schema
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

طلب الجسد؟ · المطلوب

Schema · application/json
Schema
{
  "oneOf": [
    {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "priceId"
      ],
      "properties": {
        "priceId": {
          "type": "string",
          "pattern": "^prc_"
        },
        "purchaseType": {
          "type": "string",
          "enum": [
            "subscription",
            "top_up"
          ],
          "default": "subscription"
        }
      }
    },
    {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "amountMinor",
        "purchaseType"
      ],
      "properties": {
        "amountMinor": {
          "type": "integer",
          "minimum": 1000,
          "maximum": 99999999,
          "description": "Custom top-up amount in USD cents."
        },
        "purchaseType": {
          "type": "string",
          "const": "top_up"
        }
      }
    }
  ]
}

الردود

201 جلسة الفحص القطاعي

رد 201 · application/json

HostedSession

رد 201
{
  "$ref": "#/components/schemas/HostedSession"
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 مثبتة ولكن غير مسموح بها، أو لم تُثبت شركة CSRF

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

409 النزاع في حالة الموارد أو الافتراض

رد 409 · application/problem+json

Problem

رد 409
{
  "$ref": "#/components/schemas/Problem"
}

422 فشل التثبت من الطلب

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

502 رسّال مُقدّم في أعلى المجرى

رد 502 · application/problem+json

Problem

رد 502
{
  "$ref": "#/components/schemas/Problem"
}

503 فهرس الفواتير أو مقدمها غير مهيأ أو غير متاح مؤقتاً

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/billing/subscription-changes

رفع الاشتراك في قطاعي الحالي إلى سعر منشور أعلى

الخادم يتحقق من ذلك FlashData السعر ناشط، متاح في البيوت الحالية، USD- مُعلَّم، متكرر، نفس الفترة الزمنية، وأكثر تكلفة من سعر الاشتراك الحالي. ولا تقبل أبداً خيارات المنتجات وأسعار المزودين بالعملة والتناسب من المصفح. ولا تتغير الاستحقاقات المحلية والائتمانات إلا بعد توقع حدوث حدث مُحقَّق من جانب مقدِّمي الخدمات.

Authentication: cookieSession + csrfToken

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

Idempotency-Key · header · المطلوب

Schema
Schema
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

طلب الجسد؟ · المطلوب

Schema · application/json
Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "priceId"
  ],
  "properties": {
    "priceId": {
      "type": "string",
      "pattern": "^prc_"
    }
  }
}

الردود

201 تغيير الاشتراك المقدم إلى قطاعي

رد 201 · application/json

SubscriptionChange

رد 201
{
  "$ref": "#/components/schemas/SubscriptionChange"
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 مثبتة ولكن غير مسموح بها، أو لم تُثبت شركة CSRF

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

404 الموارد التي لم يعثر عليها أو لا يملكها المتصل

رد 404 · application/problem+json

Problem

رد 404
{
  "$ref": "#/components/schemas/Problem"
}

409 النزاع في حالة الموارد أو الافتراض

رد 409 · application/problem+json

Problem

رد 409
{
  "$ref": "#/components/schemas/Problem"
}

422 فشل التثبت من الطلب

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

502 رسّال مُقدّم في أعلى المجرى

رد 502 · application/problem+json

Problem

رد 502
{
  "$ref": "#/components/schemas/Problem"
}

503 فهرس الفواتير أو مقدمها غير مهيأ أو غير متاح مؤقتاً

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/billing/portal-sessions

:: عقد دورة لبورصة العملاء في قطاعي

Authentication: cookieSession + csrfToken

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

Idempotency-Key · header · المطلوب

Schema
Schema
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

الردود

201 دورة المبيعات التجارية المزروعة

رد 201 · application/json

HostedSession

رد 201
{
  "$ref": "#/components/schemas/HostedSession"
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 مثبتة ولكن غير مسموح بها، أو لم تُثبت شركة CSRF

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

404 الموارد التي لم يعثر عليها أو لا يملكها المتصل

رد 404 · application/problem+json

Problem

رد 404
{
  "$ref": "#/components/schemas/Problem"
}

409 النزاع في حالة الموارد أو الافتراض

رد 409 · application/problem+json

Problem

رد 409
{
  "$ref": "#/components/schemas/Problem"
}

502 رسّال مُقدّم في أعلى المجرى

رد 502 · application/problem+json

Problem

رد 502
{
  "$ref": "#/components/schemas/Problem"
}

503 فهرس الفواتير أو مقدمها غير مهيأ أو غير متاح مؤقتاً

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/billing/subscription-cancellation

الجدول الزمني للاشتراك الجاري المدفوع الأجر أو الإلغاء غير المطبق

(ب) وضع جداول زمنية لإلغاء cancelAtPeriodEnd إلى true في نهاية فترة إعداد الفواتير الحالية؛ وتحتفظ شركة false بالاشتراك. تحديث الاستحقاقات بعد حدث مُحقّق من المشاركة في برنامج (روي). هذه النقطه النهائيه لا تلغي فوراً او تُصدر ردها

Authentication: cookieSession + csrfToken

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

Idempotency-Key · header · المطلوب

Schema
Schema
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

طلب الجسد؟ · المطلوب

Schema · application/json
Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "cancelAtPeriodEnd"
  ],
  "properties": {
    "cancelAtPeriodEnd": {
      "type": "boolean"
    }
  }
}

الردود

202 آخر المستجدات المتعلقة بالإلغاء المقدمة إلى قطاعي

رد 202 · application/json

SubscriptionCancellationChange

رد 202
{
  "$ref": "#/components/schemas/SubscriptionCancellationChange"
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 مثبتة ولكن غير مسموح بها، أو لم تُثبت شركة CSRF

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

404 الموارد التي لم يعثر عليها أو لا يملكها المتصل

رد 404 · application/problem+json

Problem

رد 404
{
  "$ref": "#/components/schemas/Problem"
}

409 النزاع في حالة الموارد أو الافتراض

رد 409 · application/problem+json

Problem

رد 409
{
  "$ref": "#/components/schemas/Problem"
}

422 فشل التثبت من الطلب

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

502 رسّال مُقدّم في أعلى المجرى

رد 502 · application/problem+json

Problem

رد 502
{
  "$ref": "#/components/schemas/Problem"
}

503 فهرس الفواتير أو مقدمها غير مهيأ أو غير متاح مؤقتاً

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
GET/billing/invoices

إسقاطات الفواتير القطاعية

Authentication: cookieSession

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

cursor · query · اختياري

Schema
Schema
{
  "type": "string",
  "maxLength": 512
}

limit · query · اختياري

Schema
Schema
{
  "type": "integer",
  "minimum": 1,
  "maximum": 100,
  "default": 50
}

الردود

200 الفواتير

رد 200 · application/json

Invoice · Page

رد 200
{
  "allOf": [
    {
      "$ref": "#/components/schemas/Page"
    },
    {
      "type": "object",
      "properties": {
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Invoice"
          }
        }
      }
    }
  ]
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}
GET/billing/payments

إسقاطات سداد المبالغ المستحقة والمبالغ المستردة

Authentication: cookieSession

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

cursor · query · اختياري

Schema
Schema
{
  "type": "string",
  "maxLength": 512
}

limit · query · اختياري

Schema
Schema
{
  "type": "integer",
  "minimum": 1,
  "maximum": 100,
  "default": 50
}

الردود

200 تاريخ الدفع لمرة واحدة بدون أسرار

رد 200 · application/json

BillingPaymentPage

رد 200
{
  "$ref": "#/components/schemas/BillingPaymentPage"
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

الأرصدة

GET/api-access/balance

اقرأ رصيد الحساب الحي باستخدام مفتاح API

اقرأ الرصيد الائتماني الحالي الذي يتقاسمه الجميع API المفاتيح في حسابك ويمكن للتحفظات النشطة أن تقلل من التوازن المتاح. ولا يكلف هذا الطلب أي ائتمانات ولا يأخذ أي معايير للاستفسار أو هيئة. والاستجابات خاصة وليست مزورة؛ وتنطبق حدود معدلات قراءة الحسابات.

Authentication: dataApiKey

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

الردود

200 الرصيد الموقعي والائتمانات المتاحة غير المجزية

رد 200 · application/json

ApiAccessBalance

رد 200
{
  "$ref": "#/components/schemas/ApiAccessBalance"
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

422 فشل التثبت من الطلب

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

429 عدد كبير جداً من الحسابات يقرأ، يعاد النظر بعد نافذة الحد الأقصى للمعدل

503 التبعية المطلوبة أو المكتال غير متاح بصورة مؤقتة

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
GET/api-access/pricing

قراءة أسعار الحساب الفعلي للمصادر التي أذنت بها شركة API

اقرأي معدلات حسابك للمصادر المسموح بها API المفتاح ألف null السعر يعني أن هذا المصدر غير متاح request_count عدد الاستفسارات، وليس البنود المعادة؛ ومعدلات التنزيل لكل بروميد الميثيل10^12 (ب) فالتقديرات لا ترصد اعتمادات أو قدرة احتياطية. ولا يكلف هذا الطلب أي ائتمانات. والاستجابات خاصة وليست مزورة؛ وتنطبق حدود معدلات قراءة الحسابات.

Authentication: dataApiKey

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

source · query · اختياري

مصدر مُصرّح لهذا المفتاح؛ احذفه لقراءة جميع المصادر المصرّح بها.

Schema

ApiAccessSource

Schema
{
  "$ref": "#/components/schemas/ApiAccessSource"
}

request_count · query · اختياري

عدد أقل من المكالمات؛ لا يقدر حجم الحمولة.

Schema
Schema
{
  "type": "integer",
  "minimum": 1,
  "maximum": 100000,
  "default": 1
}

الردود

200 خطة الحساب والأسعار الخاصة بالمصدر

رد 200 · application/json

ApiAccessPricing

رد 200
{
  "$ref": "#/components/schemas/ApiAccessPricing"
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 مثبتة ولكن غير مسموح بها، أو لم تُثبت شركة CSRF

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

422 فشل التثبت من الطلب

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

429 عدد كبير جداً من الحسابات يقرأ، يعاد النظر بعد نافذة الحد الأقصى للمعدل

503 التبعية المطلوبة أو المكتال غير متاح بصورة مؤقتة

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
GET/api-access/limits

حدود خطة حساب القراءة والوظائف الحالية التي لم يبت فيها بعد باستخدام مفتاح API

اقرأي تماسكك وحجم الدفعات و حدود العمل المنتظرة بالإضافة إلى العدد الحالي المنتظر وتساعد هذه القيم على تخطيط الطلبات، ولكنها لا تساعد على الاحتفاظ بالقدرات. ولا يكلف هذا الطلب أي ائتمانات ولا يأخذ أي معايير للاستفسار أو هيئة. والاستجابات خاصة وليست مزورة؛ وتنطبق حدود معدلات قراءة الحسابات.

Authentication: dataApiKey

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

الردود

200 الحد الأقصى للخطط والحساب الجاري قيد النظر

رد 200 · application/json

ApiAccessLimits

رد 200
{
  "$ref": "#/components/schemas/ApiAccessLimits"
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

422 فشل التثبت من الطلب

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

429 عدد كبير جداً من الحسابات يقرأ، يعاد النظر بعد نافذة الحد الأقصى للمعدل

503 التبعية المطلوبة أو المكتال غير متاح بصورة مؤقتة

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
GET/usage

استخدام الحساب الجاهز للمصادر التي أذنت بها شركة API

قراءتها مجاناً، مصدق عليها فقط من قبل X-API-Key. تشمل جميع مفاتيح الحساب ولكن فقط المصادر الممنوحة لمفتاح الاتصال لا ترد على رسالة الاستفسارات، المفاتيح تفاصيل الدفع أو حسابات أخرى. حالات التخلف إلى سبعة أيام؛ الحد الأقصى للأيام من الـ 31. يجب أن تستخدم التواريخ مسامير التذاكر من الشمولية إلى الحصرية؛ كلاهما محاصرين حتى دقائق. من وحده، إلى العجز عن الدفع إلى من + 7 أيام. ولا حتى بداية اللحظة التالية في نهاية المطاف متسقة؛ بل وحتى استكمالهاfalse لا يضمن أن كل الأحداث الأخيرة مستغلة. الحد الأقصى للقراءة: طلبات شركة 60 في الدقيقة لكل عميل من شركاء التنفيذ.

Authentication: dataApiKey

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

source · query · اختياري

ويُمنح مصدر مفهرس محدد لمفتاح الاتصال؛ ويُغفل يعني جميع المصادر الممنوحة.

Schema
Schema
{
  "type": "string",
  "enum": [
    "google_search",
    "google_images",
    "google_news",
    "google_shopping",
    "google_videos",
    "google_places",
    "youtube_search",
    "youtube_search_extended",
    "youtube_metadata",
    "youtube_transcript",
    "youtube_captions",
    "youtube_trainability",
    "youtube_channel",
    "youtube_suggestions",
    "youtube_download"
  ]
}

from · query · اختياري

Schema
Schema
{
  "type": "string",
  "format": "date-time"
}

to · query · اختياري

Schema
Schema
{
  "type": "string",
  "format": "date-time"
}

الردود

200 عدد الطلبات المقدمة على نطاق واسع والائتمانات المحملة، مع معلومات جديدة

رد 200 · application/json

ApiKeyUsage

رد 200
{
  "$ref": "#/components/schemas/ApiKeyUsage"
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 مثبتة ولكن غير مسموح بها، أو لم تُثبت شركة CSRF

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

422 فشل التثبت من الطلب

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

429 عدد كبير جداً من الأعراف يُقرأ؛ يُعاد النظر بعد نافذة الحد الأقصى للمعدل

503 التبعية المطلوبة أو المكتال غير متاح بصورة مؤقتة

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
GET/credits/balance

قراءة الأرصدة الدائنة المتاحة والمخصصة الحالية

Authentication: cookieSession

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

الردود

200 الرصيد الدائن

رد 200 · application/json

CreditBalance

رد 200
{
  "$ref": "#/components/schemas/CreditBalance"
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}
GET/credits/policy

اقرأ منحة ائتمان الحساب الفعال ورسوم السياسة العامة

Authentication: cookieSession

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

الردود

200 السياسة الائتمانية الفعالة

رد 200 · application/json

CreditPolicy

رد 200
{
  "$ref": "#/components/schemas/CreditPolicy"
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}
GET/credits/transactions

قيود دفتر الأستاذ

Authentication: cookieSession

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

cursor · query · اختياري

Schema
Schema
{
  "type": "string",
  "maxLength": 512
}

limit · query · اختياري

Schema
Schema
{
  "type": "integer",
  "minimum": 1,
  "maximum": 100,
  "default": 50
}

type · query · اختياري

Schema

CreditEntryType

Schema
{
  "$ref": "#/components/schemas/CreditEntryType"
}

الردود

200 Ledger entries

رد 200 · application/json

CreditTransaction · Page

رد 200
{
  "allOf": [
    {
      "$ref": "#/components/schemas/Page"
    },
    {
      "type": "object",
      "properties": {
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/CreditTransaction"
          }
        }
      }
    }
  ]
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

ائتمانات المحاكمات

GET/trial-credit-request

اقرأ أهلية الإئتمان و طلب الحساب مدى الحياة

Authentication: cookieSession

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

الردود

200 الأهلية الحالية، المنحة المُحدَّدة، وطلب الدولة

المرؤوسون: Cache-Control

رد 200 · application/json

TrialCreditState

رد 200
{
  "$ref": "#/components/schemas/TrialCreditState"
}

401 التوثيق المطلوب أو غير صحيح

المرؤوسون: Cache-Control, X-Request-Id

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

500 حدث خطأ داخلي غير متوقع

المرؤوسون: Cache-Control, X-Request-Id

رد 500 · application/problem+json

Problem

رد 500
{
  "$ref": "#/components/schemas/Problem"
}

503 التبعية المطلوبة أو التسجيل غير متاح بصورة مؤقتة

المرؤوسون: Cache-Control, X-Request-Id

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/trial-credit-request

تقدم طلب الإئتمان الإبتدائي

تم حفظ مبلغ التجربة وقضية الاستخدام عندما تقدم الطلب

Authentication: cookieSession + csrfToken

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

Idempotency-Key · header · المطلوب

Schema
Schema
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

طلب الجسد؟ · اختياري

Schema · application/json
Schema
{
  "type": "object",
  "additionalProperties": false
}

الردود

201 تقديم طلب ائتمانات ابتدائية وموافقة تلقائية على حسابات يمكن التحقق منها، بصرف النظر عن مقدم البريد الإلكتروني

المرؤوسون: Cache-Control

رد 201 · application/json

TrialCreditState

رد 201
{
  "$ref": "#/components/schemas/TrialCreditState"
}

401 التوثيق المطلوب أو غير صحيح

المرؤوسون: Cache-Control, X-Request-Id

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

403 مثبتة ولكن غير مسموح بها، أو لم تُثبت شركة CSRF

المرؤوسون: Cache-Control, X-Request-Id

رد 403 · application/problem+json

Problem

رد 403
{
  "$ref": "#/components/schemas/Problem"
}

409 النزاع في حالة الموارد أو الافتراض

المرؤوسون: Cache-Control, X-Request-Id

رد 409 · application/problem+json

Problem

رد 409
{
  "$ref": "#/components/schemas/Problem"
}

422 فشل التثبت من الطلب

المرؤوسون: Cache-Control, X-Request-Id

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

500 حدث خطأ داخلي غير متوقع

المرؤوسون: Cache-Control, X-Request-Id

رد 500 · application/problem+json

Problem

رد 500
{
  "$ref": "#/components/schemas/Problem"
}

503 التبعية المطلوبة أو التسجيل غير متاح بصورة مؤقتة

المرؤوسون: Cache-Control, X-Request-Id

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}

التوصيل

GET/delivery/webhooks

القائمة التي تم حفظها URLs

Authentication: cookieSession

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

الردود

200 Callback URLs

رد 200 · application/json

DeliveryWebhook

رد 200
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DeliveryWebhook"
      }
    }
  }
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}
POST/delivery/webhooks

انقذوا عوده الاستكمال URL

Authentication: cookieSession + csrfToken

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

طلب الجسد؟ · المطلوب

Schema · application/json

CreateDeliveryWebhookRequest

Schema
{
  "$ref": "#/components/schemas/CreateDeliveryWebhookRequest"
}

الردود

201 الإبداع

رد 201 · application/json

DeliveryWebhook

رد 201
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "webhook"
  ],
  "properties": {
    "webhook": {
      "$ref": "#/components/schemas/DeliveryWebhook"
    }
  }
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

422 فشل التثبت من الطلب

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}
DELETE/delivery/webhooks/{webhookId}

إزالة نداء الاستكمال URL

Authentication: cookieSession + csrfToken

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

webhookId · path · المطلوب

Schema
Schema
{
  "type": "string",
  "pattern": "^cbk_[A-Za-z0-9_-]{8,}$"
}

الردود

204 إزالة الألغام

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

404 الموارد التي لم يعثر عليها أو لا يملكها المتصل

رد 404 · application/problem+json

Problem

رد 404
{
  "$ref": "#/components/schemas/Problem"
}
POST/delivery/webhooks/{webhookId}/test

أرسل عينة حمولة كاملة

Authentication: cookieSession + csrfToken

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

webhookId · path · المطلوب

Schema
Schema
{
  "type": "string",
  "pattern": "^cbk_[A-Za-z0-9_-]{8,}$"
}

الردود

200 محاولة اختبار

رد 200 · application/json

DeliveryWebhook

رد 200
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "statusCode",
    "webhook"
  ],
  "properties": {
    "statusCode": {
      "type": "integer",
      "minimum": 0
    },
    "webhook": {
      "$ref": "#/components/schemas/DeliveryWebhook"
    }
  }
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

404 الموارد التي لم يعثر عليها أو لا يملكها المتصل

رد 404 · application/problem+json

Problem

رد 404
{
  "$ref": "#/components/schemas/Problem"
}

الوظائف

وللاطلاع على أمثلة على التقديم والوضع والنتائج، انظر Realtime and async · Batch.

GET/jobs

List Data API jobs for the current workspace

تاريخ نشط ومحفوظ (ب) حالات التخلف عن السداد إلى الأيام السبعة الماضية؛ ويقتصر نطاق كل من مواعدات المواصلات المقطعية على عدد أيام الـ (31). من الشمولية إلى أن تكون حصرية، في الدقيقة الدقيقة. ويُحتفظ بالملخصات بشكل غير مقصود ويمكن أن تُشَدَّل الإغراق.

Authentication: cookieSession

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

cursor · query · اختياري

Schema
Schema
{
  "type": "string",
  "minLength": 1,
  "maxLength": 512
}

limit · query · اختياري

Schema
Schema
{
  "type": "integer",
  "minimum": 1,
  "maximum": 50
}

source · query · اختياري

Schema
Schema
{
  "type": "string",
  "pattern": "^(google|youtube|google_[a-z]+|youtube_[a-z_]+)$"
}

status · query · اختياري

Schema
Schema
{
  "type": "string",
  "enum": [
    "completed",
    "failed",
    "pending",
    "processing"
  ]
}

mode · query · اختياري

Schema
Schema
{
  "type": "string",
  "enum": [
    "async",
    "batch",
    "realtime"
  ]
}

from · query · اختياري

Schema
Schema
{
  "type": "string",
  "format": "date-time"
}

to · query · اختياري

Schema
Schema
{
  "type": "string",
  "format": "date-time"
}

الردود

200 صفحة العمل

رد 200 · application/json

ConsoleJob · Pagination

رد 200
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "pagination",
    "summary"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ConsoleJob"
      }
    },
    "pagination": {
      "$ref": "#/components/schemas/Pagination"
    },
    "summary": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "required": [
        "completed",
        "credits",
        "failed",
        "total"
      ],
      "properties": {
        "completed": {
          "type": "integer",
          "minimum": 0
        },
        "credits": {
          "type": "number",
          "minimum": 0
        },
        "failed": {
          "type": "integer",
          "minimum": 0
        },
        "total": {
          "type": "integer",
          "minimum": 0
        },
        "updating": {
          "type": "boolean"
        }
      }
    }
  }
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

422 فشل التثبت من الطلب

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}
GET/jobs/{jobId}

اقرأ وظيفة واحدة من وظائف شركة API

اقرأ job.status للتحقق من التقدم و job.error إذا فشلت عملية التجهيز. JSON is the default; use Accept: text/plain for readable text. X-Respond-With يتم تجاهله هنا أتبع Retry-After عندما تقدم قبل التحقق مرة أخرى.

Authentication: cookieSession أو dataApiKey

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

Accept · header · اختياري

وتعيد شركة application/json الرد المهيكل الأصلي؛ وتعيد شركة text/plain نفس الحقول التي يرد فيها النص السهلي. وتُدعم النطاقات القياسية لوسائط الإعلام وأثقال الـ (ف)؛ أو تُفقَد في الرقم Accept أو في حالة عجز عن استخدام البطاقات البرية على الصعيد العالمي إلى JSON. وتُتجاهل شركة X-Respond-With عند نقاط النهاية في مرحلة تقديم الخدمات وحالات العمل. ولا تزال السطوات منظمة من طراز JSON. ويستخدم كل من نوعي الاستجابة الرقم UTF-8؛ ويُدعم بارامتر واضح للشحنة (Outf-8).

Schema
Schema
{
  "type": "string"
}

jobId · path · المطلوب

Schema
Schema
{
  "type": "string",
  "pattern": "^job_[A-Za-z0-9_-]+$"
}

الردود

200 تفاصيل العمل

رد 200 · application/json

ConsoleJob

رد 200
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "job"
  ],
  "properties": {
    "job": {
      "$ref": "#/components/schemas/ConsoleJob"
    }
  }
}
رد 200 · text/plain
رد 200
{
  "type": "string"
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

404 الموارد التي لم يعثر عليها أو لا يملكها المتصل

رد 404 · application/problem+json

Problem

رد 404
{
  "$ref": "#/components/schemas/Problem"
}

406 ولم تقبل شركة application/json ولا text/plain؛ والرد هو JSON.

رد 406 · application/json

QueryRepresentationError

رد 406
{
  "$ref": "#/components/schemas/QueryRepresentationError"
}
GET/jobs/{jobId}/results

تحميل نتيجة مكتملة من الإسينك

افتراضيًا، يتحقق من صلاحية الوصول ويعيد التوجيه إلى رابط R2 خاص قصير العمر؛ ويستقبل العملاء JSON الأصلي مباشرة من R2. يعيد Accept: text/plain بصورة مستقلة HTTP 200 مع حقول النتيجة الأصلية كنص عادي ذي مسافات بادئة. يختار X-Respond-With: markdown محتوى Markdown: تغلّفه application/json في content بجانب البيانات الوصفية الأصلية بدلًا من results؛ ويعيد text/plain البيانات الوصفية ثم Markdown. عند غياب Accept أو استخدام محرف بدل عام تكون الصيغة الافتراضية JSON. لا يرسل التنسيق استعلامًا جديدًا ولا يستهلك رصيد الاستعلامات. تنتهي صلاحية النتائج المخزنة بعد 24 ساعة من الاكتمال. تبقى الأخطاء بصيغة JSON منظّمة.

Authentication: cookieSession أو dataApiKey

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

X-Respond-With · header · اختياري

تم وضعه كعلامة لإزالة النتائج كمحتوى من طراز Markdown. احفظ حقول النتائج الأصلية ويختار Accept بصورة مستقلة JSON أو النص العادي. ولا يُقرأ إلا الاستفسارات في الوقت الحقيقي ونتيجة العمل المنجزة، أي دعم لهذا الرئيس. وهي لا تغير طلبات العمل، أو المركز، أو مؤشرات الأداء، أو ملفات الطلبات، أو ملفات شركة Bulk، أو عمليات التنزيل الثنائية، أو الردود على البروتوكول الخاص بشركة MCP.

Schema
Schema
{
  "type": "string",
  "enum": [
    "markdown"
  ]
}

Accept · header · اختياري

اختر application/json أو text/plain بصورة مستقلة عن X-Respond-With. دون X-Respond-With، يعيد text/plain الحقول الأصلية مع مسافات بادئة؛ ويحتفظ JSON بحقول الاستجابة الأصلية، مع إعادة توجيه قراءات النتائج المكتملة إلى التخزين. مع markdown، يعيد JSON حقل content والبيانات الوصفية، ويعيد النص العادي البيانات الوصفية ثم Markdown. تُدعم نطاقات الوسائط القياسية وأوزان q؛ وعند غياب Accept أو استخدام محرف بدل عام تكون الصيغة الافتراضية JSON. يستخدم نوعا الاستجابة UTF-8؛ وتُدعم المعلمة الصريحة charset=utf-8.

Schema
Schema
{
  "type": "string"
}

jobId · path · المطلوب

Schema
Schema
{
  "type": "string",
  "pattern": "^job_[A-Za-z0-9_-]+$"
}

الردود

200 تُعاد الحقول الأصلية كنص عادي أو Markdown مباشرة؛ ويُسترجع JSON الأصلي من R2 بعد اتباع إعادة التوجيه الافتراضية

رد 200 · application/json

MarkdownQueryResult

رد 200
{
  "anyOf": [
    {
      "$ref": "#/components/schemas/MarkdownQueryResult"
    },
    {
      "type": "object",
      "additionalProperties": true
    }
  ]
}
رد 200 · text/plain
رد 200
{
  "type": "string"
}

302 إعادة توجيه إلى JSON الأصلي في تخزين R2 الخاص عند اختيار JSON دون X-Respond-With

المرؤوسون: Location

400 القيمة غير المدعومة من X-Respond-With؛ الاستجابة هي JSON

رد 400 · application/json

QueryRepresentationError

رد 400
{
  "$ref": "#/components/schemas/QueryRepresentationError"
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

404 الموارد التي لم يعثر عليها أو لا يملكها المتصل

رد 404 · application/problem+json

Problem

رد 404
{
  "$ref": "#/components/schemas/Problem"
}

406 ولم تقبل شركة application/json ولا text/plain؛ والرد هو JSON.

رد 406 · application/json

QueryRepresentationError

رد 406
{
  "$ref": "#/components/schemas/QueryRepresentationError"
}

409 النزاع في حالة الموارد أو الافتراض

رد 409 · application/problem+json

Problem

رد 409
{
  "$ref": "#/components/schemas/Problem"
}

410 انتهت صلاحية النتائج

رد 410 · application/problem+json

Problem

رد 410
{
  "$ref": "#/components/schemas/Problem"
}

422 فشلت المهمة. يتضمن الحقل detail في الاستجابة سبب الفشل المحفوظ عند توفره.

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}

503 التبعية المطلوبة أو المكتال غير متاح بصورة مؤقتة

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}

واجهة API لمعالجة Bulk

ولدى نقاط نهاية Bulk إشارة مكرسة مع البارامترات، وطلب أمثلة وشيكات الاستجابة. افتح الباب Bulk التجهيز API

ساحة اللعب

POST/playground/run

أُجري بحثاً عن أرض الملعب كحيز العمل الحالي

Authentication: cookieSession + csrfToken

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

طلب الجسد؟ · المطلوب

Schema · application/json
Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "source",
    "mode",
    "query"
  ],
  "properties": {
    "source": {
      "type": "string"
    },
    "mode": {
      "type": "string",
      "enum": [
        "realtime",
        "async",
        "batch"
      ]
    },
    "query": {
      "description": "Source request body. In batch mode, also accepts an object containing only queries, an array of 1 to 20 request bodies. Every entry must match the selected source and its input schema. Search and Suggestions require query; Channel requires handle; Metadata, Transcript, Captions, Trainability and Download require an 11-character video_id matching [A-Za-z0-9_-]. Download batch entries must supply params.storage for customer storage; console browser delivery is not supported in this envelope. Account batch and pending-job limits still apply.",
      "type": "object",
      "additionalProperties": true
    }
  }
}

الردود

200 بيانات مقدمة من شركة API تم القبض عليها من أجل الملعب

رد 200 · application/json
رد 200
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "body",
    "endpoint",
    "mode",
    "status"
  ],
  "properties": {
    "body": {},
    "endpoint": {
      "type": "string",
      "enum": [
        "/v1/queries",
        "/v1/queries/batch",
        "/v1/queries/realtime"
      ]
    },
    "mode": {
      "type": "string",
      "enum": [
        "realtime",
        "async",
        "batch"
      ]
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599
    }
  }
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

422 فشل التثبت من الطلب

رد 422 · application/problem+json

Problem

رد 422
{
  "$ref": "#/components/schemas/Problem"
}
GET/playground/jobs/{jobId}/download

تحميل القطعة الأثرية المكتملة من بلاي في المروحية الحالية

Authentication: cookieSession

سيرفر: https://api.flashdata.dev/v2

سيرفر: http://localhost:5000/v2

البارامترات

jobId · path · المطلوب

Schema
Schema
{
  "type": "string",
  "pattern": "^job_[A-Za-z0-9_-]+$"
}

الردود

200 القطع الأثرية المؤقتة للأجهزة المزودة بالبضائع

المرؤوسون: Content-Disposition, Content-Length

رد 200 · application/octet-stream
رد 200
{
  "type": "string",
  "format": "binary"
}

401 التوثيق المطلوب أو غير صحيح

رد 401 · application/problem+json

Problem

رد 401
{
  "$ref": "#/components/schemas/Problem"
}

404 الموارد التي لم يعثر عليها أو لا يملكها المتصل

رد 404 · application/problem+json

Problem

رد 404
{
  "$ref": "#/components/schemas/Problem"
}

409 النزاع في حالة الموارد أو الافتراض

رد 409 · application/problem+json

Problem

رد 409
{
  "$ref": "#/components/schemas/Problem"
}

410 القطعة الأثرية المؤقتة انتهت

رد 410 · application/problem+json

Problem

رد 410
{
  "$ref": "#/components/schemas/Problem"
}

503 التبعية المطلوبة أو المكتال غير متاح بصورة مؤقتة

رد 503 · application/problem+json

Problem

رد 503
{
  "$ref": "#/components/schemas/Problem"
}

تعاريف الكيماويات

APIKeyIdentity
APIKeyIdentity
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "apiKeyId": {
      "type": "string"
    },
    "accountId": {
      "type": "string"
    },
    "accountType": {
      "type": "string",
      "enum": [
        "owned",
        "temporary"
      ]
    },
    "ownership": {
      "type": "string",
      "enum": [
        "owned",
        "unowned"
      ]
    },
    "access": {
      "type": "string",
      "enum": [
        "ready",
        "blocked"
      ]
    },
    "installed": {
      "type": "boolean"
    },
    "recurringAllowed": {
      "type": "boolean"
    },
    "connectionId": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "scopes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "expiresAt": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ]
    },
    "verifiedAt": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "apiKeyId",
    "accountId",
    "accountType",
    "ownership",
    "access",
    "installed",
    "recurringAllowed",
    "connectionId",
    "scopes",
    "expiresAt",
    "verifiedAt"
  ],
  "description": "Authoritative current-record ownership and readiness. Public IDs only. recurringAllowed requires a verified active owner and, for agent-issued keys, server-confirmed installation. It is a point-in-time check, not an authorization token or permission to reuse cached data after revocation."
}
Account
Account
{
  "type": "object",
  "description": "Deleted accounts are only returned through authorized Admin projections; their identity fields are redacted.",
  "additionalProperties": false,
  "required": [
    "id",
    "name",
    "email",
    "status",
    "emailVerified",
    "legalAcceptanceRequired",
    "role",
    "timezone",
    "createdAt",
    "updatedAt"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^acct_"
    },
    "name": {
      "type": "string"
    },
    "email": {
      "type": [
        "string",
        "null"
      ],
      "format": "email"
    },
    "status": {
      "type": "string",
      "enum": [
        "pending_verification",
        "active",
        "suspended",
        "deleting",
        "deleted"
      ]
    },
    "emailVerified": {
      "type": "boolean"
    },
    "legalAcceptanceRequired": {
      "type": "boolean"
    },
    "role": {
      "type": "string",
      "enum": [
        "user",
        "admin"
      ]
    },
    "timezone": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}
AccountDeletionRequest
AccountDeletionRequest
{
  "type": "object",
  "description": "User-safe deletion summary. Durable processor cursor and per-step metadata are internal operational state and are intentionally omitted.",
  "additionalProperties": false,
  "required": [
    "id",
    "status",
    "requestedAt",
    "scheduledFor",
    "cancellable",
    "billingCancellationStatus",
    "activeJobsAtRequest",
    "retryable"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^del_"
    },
    "status": {
      "type": "string",
      "enum": [
        "scheduled",
        "cancelled",
        "processing",
        "completed",
        "failed"
      ]
    },
    "requestedAt": {
      "type": "string",
      "format": "date-time"
    },
    "scheduledFor": {
      "type": "string",
      "format": "date-time"
    },
    "cancellable": {
      "type": "boolean"
    },
    "cancelledAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "processingStartedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "completedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "failureCode": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 80
    },
    "billingCancellationStatus": {
      "type": "string",
      "enum": [
        "not_required",
        "pending",
        "completed",
        "failed"
      ]
    },
    "activeJobsAtRequest": {
      "type": "integer",
      "minimum": 0
    },
    "retryable": {
      "type": "boolean",
      "description": "True only when an Admin-audited processor retry is possible; it does not grant the user mutation access."
    }
  }
}
AgentApproval
AgentApproval
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "scopes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "allowAccountBalance": {
      "const": true
    }
  },
  "required": [
    "scopes",
    "allowAccountBalance"
  ]
}
AgentBrowserClaim
AgentBrowserClaim
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "connection": {
      "$ref": "#/components/schemas/AgentConnection"
    },
    "claimId": {
      "type": "string"
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "connection",
    "claimId",
    "expiresAt"
  ]
}
AgentCapabilities
AgentCapabilities
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "protocolVersion": {
      "const": 2
    },
    "available": {
      "type": "boolean"
    },
    "flow": {
      "const": "temporary_account_api_key"
    },
    "dataOrigin": {
      "type": "string"
    },
    "queryPath": {
      "const": "/v1/queries/realtime"
    },
    "credentialType": {
      "const": "api_key"
    },
    "permissions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AgentPermission"
      }
    },
    "owner": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "scopes"
      ],
      "properties": {
        "scopes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "trial": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "scopes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "credits": {
          "type": "number"
        },
        "lifetimeHours": {
          "type": "integer",
          "minimum": 0
        },
        "requestsPerSecond": {
          "type": "integer",
          "minimum": 0
        },
        "maxBatchSize": {
          "type": "integer",
          "minimum": 0
        },
        "requestCounts": {}
      },
      "required": [
        "credits",
        "lifetimeHours",
        "requestsPerSecond",
        "maxBatchSize",
        "requestCounts"
      ]
    },
    "recurringRequires": {
      "const": "owned_key_installed"
    },
    "replayProtection": {
      "const": "client_local_only"
    }
  },
  "required": [
    "protocolVersion",
    "available"
  ]
}
AgentClaim
AgentClaim
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "claimId": {
      "type": "string"
    },
    "claimPath": {
      "type": "string"
    },
    "confirmationCode": {
      "type": "string",
      "pattern": "^\\d{8}$"
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time"
    },
    "pollAfterSeconds": {
      "type": "integer",
      "minimum": 0
    }
  },
  "required": [
    "claimId",
    "claimPath",
    "confirmationCode",
    "expiresAt",
    "pollAfterSeconds"
  ]
}
AgentClaimView
AgentClaimView
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "connection"
  ],
  "properties": {
    "connection": {
      "$ref": "#/components/schemas/AgentConnection"
    },
    "handoff": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "status"
      ],
      "properties": {
        "status": {
          "type": "string"
        }
      }
    }
  }
}
AgentConnection
AgentConnection
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "audience": {
      "type": "string",
      "enum": [
        "coding",
        "personal",
        "unspecified"
      ]
    },
    "ownership": {
      "type": "string",
      "enum": [
        "owned",
        "unowned"
      ]
    },
    "lifecycle": {
      "type": "string",
      "enum": [
        "valid",
        "revoked",
        "expired"
      ]
    },
    "access": {
      "type": "string",
      "enum": [
        "ready",
        "fenced",
        "blocked"
      ]
    },
    "scopes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Actual scopes on the current API key. May be empty on an unowned claim-only connection; every data-source request is then forbidden."
    },
    "requestedScopes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Original owner-access request. Claim approval can only reduce this set. Legacy connections retain their original scopes."
    },
    "trialScopes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Saved subset eligible for the temporary key. Never expanded by catalog changes."
    },
    "permissions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AgentPermission"
      }
    },
    "generation": {
      "type": "integer",
      "minimum": 0
    },
    "installed": {
      "type": "boolean"
    },
    "trialExpiresAt": {
      "type": "string",
      "format": "date-time"
    },
    "fundingMode": {
      "type": "string",
      "enum": [
        "trial",
        "account_balance"
      ]
    },
    "trialCredits": {
      "type": "number"
    },
    "trialRequestCounts": {}
  },
  "required": [
    "id",
    "name",
    "audience",
    "ownership",
    "lifecycle",
    "access",
    "scopes",
    "generation",
    "installed",
    "trialExpiresAt",
    "fundingMode",
    "trialCredits",
    "trialRequestCounts"
  ]
}
AgentConnectionResponse
AgentConnectionResponse
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "connection": {
      "$ref": "#/components/schemas/AgentConnection"
    }
  },
  "required": [
    "connection"
  ]
}
AgentHandoff
AgentHandoff
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "delivered",
        "confirmed"
      ]
    },
    "connection": {
      "$ref": "#/components/schemas/AgentConnection"
    },
    "credentials": {
      "$ref": "#/components/schemas/AgentCredentials"
    },
    "generation": {
      "type": "integer",
      "minimum": 0
    }
  },
  "required": [
    "status"
  ]
}
AgentCredentials
AgentCredentials
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "connectionId": {
      "type": "string"
    },
    "apiKey": {
      "type": "string"
    },
    "setupCredential": {
      "type": "string"
    },
    "handoffProof": {
      "type": "string"
    },
    "generation": {
      "type": "integer",
      "minimum": 0
    }
  },
  "required": [
    "connectionId",
    "apiKey",
    "generation"
  ],
  "description": "Sensitive ordinary API-key credentials. Never log or put in browser URLs. Proofs are returned on temporary registration; handoff returns the owned candidate key."
}
AgentOnboardingStatus
AgentOnboardingStatus
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "awaiting_claim",
        "claim_processing",
        "handoff_ready",
        "installed",
        "handoff_expired",
        "expired",
        "revoked",
        "blocked"
      ]
    },
    "connection": {
      "$ref": "#/components/schemas/AgentConnection"
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time"
    },
    "nextAction": {
      "type": "string"
    },
    "pollAfterSeconds": {
      "type": "integer",
      "minimum": 0
    }
  },
  "required": [
    "status"
  ]
}
AgentPermission
AgentPermission
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "source",
    "name",
    "product",
    "trialEligible",
    "ownerAllowed",
    "requiresStorageDestination"
  ],
  "properties": {
    "source": {
      "type": "string",
      "pattern": "^[a-z_]{1,80}$"
    },
    "name": {
      "type": "string"
    },
    "product": {
      "type": "string"
    },
    "trialEligible": {
      "type": "boolean"
    },
    "ownerAllowed": {
      "type": "boolean"
    },
    "requiresStorageDestination": {
      "type": "boolean"
    }
  },
  "description": "Catalog-derived agent permissions. Trial eligibility is an explicit opt-in independent of owner approval. Storage and variable-price sources require owner access."
}
AgentRegistration
AgentRegistration
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "connection": {
      "$ref": "#/components/schemas/AgentConnection"
    },
    "credentials": {
      "$ref": "#/components/schemas/AgentCredentials"
    },
    "dataOrigin": {
      "type": "string"
    },
    "deniedScopes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "limits": {
      "type": "object",
      "additionalProperties": true
    },
    "nextAction": {
      "type": "string",
      "enum": [
        "query_or_claim",
        "claim"
      ],
      "description": "Claim before the first data request when no requested source is trial eligible."
    }
  },
  "required": [
    "connection",
    "credentials",
    "dataOrigin",
    "deniedScopes",
    "limits"
  ]
}
AgentRegistrationRequest
AgentRegistrationRequest
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "audience": {
      "type": "string",
      "enum": [
        "coding",
        "personal"
      ]
    },
    "scopes": {
      "type": "array",
      "minItems": 1,
      "maxItems": 30,
      "uniqueItems": true,
      "items": {
        "type": "string",
        "pattern": "^[a-z_]{1,80}$"
      }
    },
    "client": {
      "type": "string",
      "pattern": "^[a-z0-9][a-z0-9_-]{0,63}$"
    },
    "transport": {
      "type": "string",
      "enum": [
        "api",
        "cli",
        "mcp"
      ]
    }
  },
  "required": [
    "name",
    "scopes"
  ]
}
ApiAccess
ApiAccess
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "sources",
    "result_origin"
  ],
  "properties": {
    "sources": {
      "type": "array",
      "uniqueItems": true,
      "items": {
        "$ref": "#/components/schemas/ApiAccessSource"
      }
    },
    "result_origin": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "description": "Configured signed-result storage origin, without credentials, path, query or fragment. Not an access token or a media URL."
    }
  }
}
ApiAccessBalance
ApiAccessBalance
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "scope",
    "unit",
    "balanceCredits",
    "availableCredits",
    "updatedAt",
    "note"
  ],
  "properties": {
    "scope": {
      "type": "string",
      "const": "account"
    },
    "unit": {
      "type": "string",
      "const": "Credits"
    },
    "balanceCredits": {
      "type": "number",
      "description": "Signed live balance; in-flight reservations may already be reflected."
    },
    "availableCredits": {
      "type": "number",
      "minimum": 0,
      "description": "max(balanceCredits, 0)."
    },
    "updatedAt": {
      "type": [
        "string",
        "null"
      ]
    },
    "note": {
      "type": "string"
    }
  }
}
ApiAccessLimits
ApiAccessLimits
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "scope",
    "plan",
    "limits",
    "current",
    "note"
  ],
  "properties": {
    "scope": {
      "type": "string",
      "const": "account"
    },
    "plan": {
      "$ref": "#/components/schemas/ApiAccessPlan"
    },
    "limits": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "concurrency": {
          "type": "integer",
          "minimum": 0
        },
        "batchSize": {
          "type": "integer",
          "minimum": 0
        },
        "pendingJobs": {
          "type": "integer",
          "minimum": 0
        }
      }
    },
    "current": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "pendingJobs"
      ],
      "properties": {
        "pendingJobs": {
          "type": "integer",
          "minimum": 0
        }
      }
    },
    "note": {
      "type": "string"
    }
  }
}
ApiAccessPlan
ApiAccessPlan
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "billingMode": {
      "type": "string"
    },
    "status": {
      "type": "string"
    }
  }
}
ApiAccessPricing
ApiAccessPricing
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "unit",
    "plan",
    "requestCount",
    "prices",
    "note"
  ],
  "properties": {
    "unit": {
      "type": "string",
      "const": "Credits"
    },
    "plan": {
      "$ref": "#/components/schemas/ApiAccessPlan"
    },
    "requestCount": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100000
    },
    "prices": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "source",
          "available",
          "estimatedCredits"
        ],
        "properties": {
          "source": {
            "$ref": "#/components/schemas/ApiAccessSource"
          },
          "available": {
            "type": "boolean"
          },
          "creditsPerRequest": {
            "type": [
              "number",
              "null"
            ],
            "minimum": 0
          },
          "estimatedCredits": {
            "type": [
              "number",
              "null"
            ],
            "minimum": 0,
            "description": "Null for downloads or missing pricing."
          },
          "billingUnit": {
            "type": "string",
            "const": "TB"
          },
          "bytesPerUnit": {
            "type": "integer",
            "const": 1000000000000
          },
          "creditsPerTb": {
            "type": [
              "number",
              "null"
            ],
            "minimum": 0
          },
          "note": {
            "type": "string"
          }
        }
      }
    },
    "note": {
      "type": "string"
    }
  }
}
ApiAccessSource
ApiAccessSource
{
  "type": "string",
  "enum": [
    "google_search",
    "google_images",
    "google_news",
    "google_shopping",
    "google_videos",
    "google_places",
    "youtube_search",
    "youtube_search_extended",
    "youtube_metadata",
    "youtube_transcript",
    "youtube_captions",
    "youtube_trainability",
    "youtube_channel",
    "youtube_suggestions",
    "youtube_download"
  ]
}
ApiKey
ApiKey
{
  "type": "object",
  "description": "API key details. A key remains active until scheduledRevocationAt when revocation is scheduled.",
  "additionalProperties": false,
  "required": [
    "id",
    "name",
    "prefix",
    "last4",
    "scopes",
    "status",
    "createdAt"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^key_"
    },
    "name": {
      "type": "string"
    },
    "prefix": {
      "type": "string"
    },
    "last4": {
      "type": "string",
      "minLength": 4,
      "maxLength": 4
    },
    "scopes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "revoked",
        "expired"
      ]
    },
    "lastUsedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "expiresAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "scheduledRevocationAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "Planned revocation time for an overlapping retiring key; null for a primary or immediately revoked key."
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}
ApiKeyCreated
ApiKeyCreated
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "apiKey",
    "secret"
  ],
  "properties": {
    "apiKey": {
      "$ref": "#/components/schemas/ApiKey"
    },
    "secret": {
      "type": "string",
      "readOnly": true,
      "pattern": "^fd_(?:(?:test|live)_)?[A-Za-z0-9_-]{43}$",
      "description": "Plaintext secret returned only by this create/rotate transaction. Newly issued secrets use the `fd_` prefix. Previously issued `fd_test_` and `fd_live_` secrets still authenticate. An authenticated replay with the same Idempotency-Key and request body may receive the same KMS-encrypted response for five minutes; it is not recoverable afterward.",
      "x-secret-reveal": "once"
    }
  }
}
ApiKeyUsage
ApiKeyUsage
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "scope",
    "unit",
    "from",
    "to",
    "observedAt",
    "totals",
    "bySource",
    "updating",
    "note"
  ],
  "properties": {
    "scope": {
      "type": "string",
      "const": "account_authorized_sources"
    },
    "unit": {
      "type": "string",
      "const": "Credits"
    },
    "from": {
      "type": "string",
      "format": "date-time"
    },
    "to": {
      "type": "string",
      "format": "date-time"
    },
    "observedAt": {
      "type": "string",
      "format": "date-time"
    },
    "totals": {
      "$ref": "#/components/schemas/UsageCounts"
    },
    "bySource": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "source",
          "requests",
          "completed",
          "failed",
          "credits"
        ],
        "properties": {
          "source": {
            "type": "string"
          },
          "requests": {
            "type": "integer",
            "minimum": 0
          },
          "completed": {
            "type": "integer",
            "minimum": 0
          },
          "failed": {
            "type": "integer",
            "minimum": 0
          },
          "credits": {
            "type": "number",
            "minimum": 0
          }
        }
      }
    },
    "updating": {
      "type": "boolean"
    },
    "note": {
      "type": "string"
    }
  }
}
BillingPaymentPage
BillingPaymentPage
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "pagination"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/BillingPayment"
      }
    },
    "pagination": {
      "$ref": "#/components/schemas/Pagination"
    }
  }
}
BillingPayment
BillingPayment
{
  "description": "Account-scoped top-up projection. Refund state is updated only from verified provider events; this API does not initiate refunds.",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "purchaseType",
    "status",
    "currency",
    "amount",
    "refundedAmount",
    "credits",
    "reversedCredits",
    "createdAt"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^pay_"
    },
    "purchaseType": {
      "type": "string",
      "const": "top_up"
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "paid",
        "partially_refunded",
        "refunded",
        "failed"
      ]
    },
    "currency": {
      "type": "string",
      "const": "USD"
    },
    "amount": {
      "type": "integer",
      "minimum": 0,
      "description": "USD cents"
    },
    "refundedAmount": {
      "type": "integer",
      "minimum": 0,
      "description": "USD cents"
    },
    "credits": {
      "type": "number",
      "minimum": 0,
      "multipleOf": 0.001
    },
    "hostedInvoiceUrl": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "description": "Stripe-hosted HTTPS invoice URL, when Stripe created an invoice for this top-up."
    },
    "invoiceNumber": {
      "type": [
        "string",
        "null"
      ],
      "description": "Stripe invoice number, when available."
    },
    "reversedCredits": {
      "type": "number",
      "minimum": 0,
      "multipleOf": 0.001,
      "description": "Cumulative credits removed by append-only payment_reversal entries; never exceeds credits."
    },
    "paidAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "refundedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}
BulkJobCreated
BulkJobCreated
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "job",
    "upload"
  ],
  "properties": {
    "job": {
      "$ref": "#/components/schemas/BulkJob"
    },
    "upload": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "href",
        "method",
        "expiresAt",
        "contentType"
      ],
      "properties": {
        "href": {
          "type": "string",
          "format": "uri"
        },
        "method": {
          "type": "string",
          "const": "PUT"
        },
        "expiresAt": {
          "type": "string",
          "format": "date-time"
        },
        "contentType": {
          "type": "string",
          "const": "text/plain; charset=utf-8"
        }
      }
    }
  }
}
BulkJob
BulkJob
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "source",
    "status",
    "input",
    "counts",
    "delivery",
    "pauseReason",
    "error",
    "createdAt",
    "startedAt",
    "completedAt",
    "expiresAt",
    "links"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^bulk_[A-Za-z0-9_-]{8,}$"
    },
    "source": {
      "type": "string",
      "enum": [
        "youtube_metadata",
        "youtube_transcript",
        "youtube_captions",
        "youtube_trainability",
        "youtube_download"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "awaiting_upload",
        "running",
        "paused",
        "finalizing",
        "completed",
        "failed",
        "cancelled"
      ]
    },
    "input": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "bytes",
        "complete",
        "scannedBytes",
        "scannedLines"
      ],
      "properties": {
        "bytes": {
          "type": "integer",
          "minimum": 0
        },
        "complete": {
          "type": "boolean"
        },
        "scannedBytes": {
          "type": "integer",
          "minimum": 0
        },
        "scannedLines": {
          "type": "integer",
          "minimum": 0
        }
      }
    },
    "counts": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "accepted",
        "completed",
        "failed",
        "invalid",
        "results"
      ],
      "properties": {
        "accepted": {
          "type": "integer",
          "minimum": 0
        },
        "completed": {
          "type": "integer",
          "minimum": 0
        },
        "failed": {
          "type": "integer",
          "minimum": 0
        },
        "invalid": {
          "type": "integer",
          "minimum": 0
        },
        "results": {
          "type": "integer",
          "minimum": 0
        }
      }
    },
    "pauseReason": {
      "type": [
        "string",
        "null"
      ]
    },
    "delivery": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "customerStorage",
        "storageType",
        "uploadedParts",
        "retryCount"
      ],
      "properties": {
        "customerStorage": {
          "type": "boolean"
        },
        "storageType": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "s3",
            "s3_compatible",
            "oss",
            "gcs",
            "azure",
            "cos",
            "bos",
            "tos",
            null
          ]
        },
        "uploadedParts": {
          "type": "integer",
          "minimum": 0
        },
        "retryCount": {
          "type": "integer",
          "minimum": 0
        }
      }
    },
    "error": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "code",
            "detail"
          ],
          "properties": {
            "code": {
              "type": "string"
            },
            "detail": {
              "type": [
                "string",
                "null"
              ]
            }
          }
        }
      ]
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "startedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "completedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "expiresAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "links": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JobLink"
      }
    }
  }
}
BulkJobPage
BulkJobPage
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "pagination"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/BulkJob"
      }
    },
    "pagination": {
      "$ref": "#/components/schemas/Pagination"
    }
  }
}
BulkJobResponse
BulkJobResponse
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "job"
  ],
  "properties": {
    "job": {
      "$ref": "#/components/schemas/BulkJob"
    }
  }
}
ConsoleJob
ConsoleJob
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "createdAt",
    "credits",
    "durationMs",
    "error",
    "id",
    "params",
    "progress",
    "result",
    "source",
    "status",
    "updatedAt",
    "videoId"
  ],
  "properties": {
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "credits": {
      "type": "number",
      "multipleOf": 0.001
    },
    "durationMs": {
      "type": [
        "number",
        "null"
      ],
      "minimum": 0
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "id": {
      "type": "string"
    },
    "params": {
      "type": "object",
      "additionalProperties": true
    },
    "progress": {
      "type": "integer",
      "minimum": 0
    },
    "result": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": true
    },
    "source": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "completed",
        "failed",
        "pending",
        "processing"
      ]
    },
    "updatedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "videoId": {
      "type": [
        "string",
        "null"
      ]
    },
    "links": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/JobLink"
      }
    }
  }
}
ConsoleOverview
ConsoleOverview
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "account",
    "onboarding",
    "subscription",
    "balance",
    "publicStatus",
    "degradedSections",
    "generatedAt"
  ],
  "properties": {
    "account": {
      "$ref": "#/components/schemas/Account"
    },
    "onboarding": {
      "$ref": "#/components/schemas/OnboardingProgress"
    },
    "subscription": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/Subscription"
        },
        {
          "type": "null"
        }
      ]
    },
    "balance": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/CreditBalance"
        },
        {
          "type": "null"
        }
      ]
    },
    "publicStatus": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/PublicStatus"
        },
        {
          "type": "null"
        }
      ]
    },
    "degradedSections": {
      "type": "array",
      "uniqueItems": true,
      "items": {
        "type": "string",
        "enum": [
          "subscription",
          "balance",
          "public_status"
        ]
      },
      "description": "A listed section uses its unavailable representation; null and empty values must not be interpreted as zero or healthy."
    },
    "generatedAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}
CreateApiKeyRequest
CreateApiKeyRequest
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "name",
    "scopes"
  ],
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "scopes": {
      "type": "array",
      "minItems": 1,
      "uniqueItems": true,
      "items": {
        "type": "string",
        "enum": [
          "google_search",
          "google_images",
          "google_news",
          "google_shopping",
          "google_videos",
          "google_places",
          "youtube_search",
          "youtube_search_extended",
          "youtube_metadata",
          "youtube_transcript",
          "youtube_captions",
          "youtube_trainability",
          "youtube_channel",
          "youtube_suggestions",
          "youtube_download"
        ]
      }
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}
CreateBulkJobRequest
CreateBulkJobRequest
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "source"
  ],
  "properties": {
    "source": {
      "type": "string",
      "enum": [
        "youtube_metadata",
        "youtube_transcript",
        "youtube_captions",
        "youtube_trainability",
        "youtube_download"
      ]
    },
    "options": {
      "type": "object",
      "additionalProperties": true,
      "description": "Reused for every ID. Metadata accepts include_formats and include_chapters. Transcript and captions accept language (one code or an array of 1–10 distinct codes) and auto (applies to all requested languages). Omit language to prefer en-orig, fall back to en, and return one track. With auto=true, each requested code tries its -orig track first, then the plain code. Explicit -orig codes and auto=false stay exact. languageCode identifies the selected track; requestedLanguageCode is included when it differs from the requested code. A language array returns tracks and per-language errors for each video with at least one retrieved track. If no track is retrieved, the video job fails and its reserved credits are refunded. Bulk exports use one JSONL record per video. Trainability accepts no source options. These four data sources optionally accept result_storage. Supported storage_type values are s3, s3_compatible, oss, gcs, azure, cos, bos, and tos. storage_url is the bucket name (Azure container name); object_prefix is optional. S3, S3-compatible, OSS, COS, BOS, and TOS use access_key and secret_key. S3-compatible and OSS also require a public HTTPS endpoint_url. COS, BOS, and TOS require region and use fixed provider endpoints. COS bucket names include the APPID. BOS S3-compatible HTTPS delivery supports bj, su, and hkg. GCS requires service_account with project_id, client_email, and private_key. Azure requires account_name and a container SAS sas_token with write permission. Default object_prefix is YYYYMMDD, frozen to the UTC bulk creation date. Files are written to <prefix>/<source>/<bulkId>/results/part-NNNNNNNN.jsonl.gz; manifest.json in the same bulk directory is written last. Each JSONL row includes its input index and completed, failed, or invalid status. Internal R2 results remain available through the result links for 24 hours. Download accepts the normal YouTube download parameters, requires customer storage, and does not permit browser_delivery. Download storage supports the same eight provider types and credential shapes listed above under the storage field. Download storage may include object_prefix; YYYYMMDD tokens resolve to the UTC upload date, while literal prefixes are unchanged."
    },
    "callback_url": {
      "type": "string",
      "format": "uri",
      "maxLength": 2048,
      "description": "Optional public HTTPS endpoint notified once after manifest publication."
    }
  }
}
CreateDeliveryWebhookRequest
CreateDeliveryWebhookRequest
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "name",
    "url"
  ],
  "properties": {
    "name": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "format": "uri"
    }
  }
}
CreditBalance
CreditBalance
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "balanceCredits",
    "reservedCredits",
    "availableCredits",
    "lifetimeGrantedCredits",
    "lifetimeUsedCredits",
    "lifetimeRefundedCredits",
    "lifetimePaymentReversedCredits",
    "updatedAt"
  ],
  "properties": {
    "balanceCredits": {
      "type": "number",
      "multipleOf": 0.001,
      "description": "Signed settled balance after grants, usage, refunds and provider reversals."
    },
    "reservedCredits": {
      "type": "number",
      "minimum": 0,
      "multipleOf": 0.001
    },
    "availableCredits": {
      "type": "number",
      "minimum": 0,
      "multipleOf": 0.001,
      "description": "max(balanceCredits, 0)."
    },
    "lifetimeGrantedCredits": {
      "type": "number",
      "minimum": 0,
      "multipleOf": 0.001
    },
    "lifetimeUsedCredits": {
      "type": "number",
      "minimum": 0,
      "multipleOf": 0.001
    },
    "lifetimeRefundedCredits": {
      "type": "number",
      "minimum": 0,
      "multipleOf": 0.001,
      "description": "Credits returned to the account after failed usage."
    },
    "lifetimePaymentReversedCredits": {
      "type": "number",
      "minimum": 0,
      "multipleOf": 0.001,
      "description": "Absolute Credits removed after verified provider refunds or chargebacks."
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}
CreditEntryType
CreditEntryType
{
  "type": "string",
  "enum": [
    "subscription_grant",
    "topup_grant",
    "payment_reversal",
    "admin_adjustment",
    "trial_grant"
  ]
}
CreditPolicy
CreditPolicy
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "unit",
    "failedRequestsCharged",
    "subscriptionGrantTiming",
    "refundHandling"
  ],
  "properties": {
    "unit": {
      "type": "string",
      "const": "credit"
    },
    "failedRequestsCharged": {
      "type": "boolean",
      "const": false
    },
    "subscriptionGrantTiming": {
      "type": "string",
      "const": "invoice_paid"
    },
    "refundHandling": {
      "type": "string",
      "const": "append_only_reversal",
      "description": "Failed requests are refunded; verified provider refunds remove the proportional Credits through immutable transactions."
    }
  }
}
CreditTransaction
CreditTransaction
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "type",
    "deltaCredits",
    "balanceAfterCredits",
    "createdAt"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^ctx_"
    },
    "type": {
      "$ref": "#/components/schemas/CreditEntryType"
    },
    "deltaCredits": {
      "type": "number",
      "multipleOf": 0.001
    },
    "balanceAfterCredits": {
      "type": [
        "number",
        "null"
      ],
      "multipleOf": 0.001,
      "description": "Signed settled balance after this immutable transaction, when recorded."
    },
    "description": {
      "type": "string"
    },
    "requestId": {
      "type": [
        "string",
        "null"
      ]
    },
    "jobId": {
      "type": [
        "string",
        "null"
      ]
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}
DataSource
DataSource
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "name",
    "category",
    "product",
    "modes",
    "inputSchema",
    "estimatedCredits",
    "requiresStorageDestination"
  ],
  "properties": {
    "id": {
      "type": "string",
      "enum": [
        "google_search",
        "google_images",
        "google_news",
        "google_shopping",
        "google_videos",
        "google_places",
        "youtube_search",
        "youtube_search_extended",
        "youtube_metadata",
        "youtube_transcript",
        "youtube_captions",
        "youtube_trainability",
        "youtube_channel",
        "youtube_suggestions",
        "youtube_download"
      ]
    },
    "name": {
      "type": "string"
    },
    "category": {
      "type": "string",
      "enum": [
        "google",
        "youtube"
      ]
    },
    "product": {
      "type": "string",
      "enum": [
        "google_search",
        "youtube_data",
        "youtube_download"
      ]
    },
    "modes": {
      "type": "array",
      "minItems": 1,
      "uniqueItems": true,
      "description": "Only modes backed by a real adapter or consumer in the current release",
      "items": {
        "type": "string",
        "enum": [
          "realtime",
          "async",
          "batch"
        ]
      }
    },
    "inputSchema": {
      "type": "object",
      "additionalProperties": true,
      "description": "JSON Schema used by the Playground and generated clients"
    },
    "estimatedCredits": {
      "type": "number",
      "minimum": 0,
      "multipleOf": 0.001
    },
    "requiresStorageDestination": {
      "type": "boolean",
      "description": "Whether query submission must include per-request storage configuration."
    }
  }
}
DeliveryWebhook
DeliveryWebhook
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "createdAt",
    "id",
    "lastTestStatus",
    "lastTestedAt",
    "name",
    "status",
    "updatedAt",
    "url"
  ],
  "properties": {
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "id": {
      "type": "string",
      "pattern": "^cbk_[A-Za-z0-9_-]{8,}$"
    },
    "lastTestStatus": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "lastTestedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "name": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "disabled"
      ]
    },
    "updatedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "url": {
      "type": "string",
      "format": "uri"
    }
  }
}
Health
Health
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "status",
    "service",
    "version",
    "time"
  ],
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "healthy",
        "degraded"
      ]
    },
    "service": {
      "type": "string"
    },
    "version": {
      "type": "string"
    },
    "time": {
      "type": "string",
      "format": "date-time"
    }
  }
}
HostedSession
HostedSession
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "url",
    "expiresAt"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "Provider-hosted HTTPS URL on a Stripe-controlled *.stripe.com host. Web clients must validate the origin and redirect from a server-only boundary."
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}
Invoice
Invoice
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "number",
    "status",
    "currency",
    "total",
    "amountPaid",
    "refundedAmount",
    "billingReason",
    "createdAt",
    "periodStart",
    "periodEnd"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^inv_"
    },
    "number": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "draft",
        "open",
        "paid",
        "void",
        "uncollectible"
      ]
    },
    "currency": {
      "type": "string",
      "const": "USD"
    },
    "total": {
      "type": "integer",
      "description": "USD cents"
    },
    "amountPaid": {
      "type": "integer",
      "description": "USD cents"
    },
    "refundedAmount": {
      "type": "integer",
      "minimum": 0,
      "description": "Cumulative USD cents observed from verified provider events."
    },
    "billingReason": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "subscription_create",
        "subscription_cycle",
        "subscription_update",
        null
      ]
    },
    "hostedInvoiceUrl": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "description": "Stripe-hosted HTTPS invoice URL. Production Web clients accept only Stripe-controlled *.stripe.com origins."
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "paidAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "periodStart": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "periodEnd": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  }
}
LegalAcceptanceRequest
LegalAcceptanceRequest
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "acceptedTerms",
    "termsVersion",
    "privacyVersion"
  ],
  "properties": {
    "acceptedTerms": {
      "type": "boolean",
      "const": true
    },
    "termsVersion": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "privacyVersion": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    }
  }
}
LoginRequest
LoginRequest
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "email",
    "password"
  ],
  "properties": {
    "email": {
      "type": "string",
      "format": "email",
      "maxLength": 320
    },
    "password": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "writeOnly": true
    },
    "rememberMe": {
      "type": "boolean",
      "default": false,
      "description": "Ignored for email_verification, legal_acceptance and deletion_recovery Sessions, which always use a short fixed expiry."
    }
  }
}
LoginResponse
LoginResponse
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "account",
    "csrfToken",
    "sessionMode"
  ],
  "properties": {
    "account": {
      "$ref": "#/components/schemas/Account"
    },
    "csrfToken": {
      "type": "string",
      "minLength": 32,
      "readOnly": true
    },
    "sessionMode": {
      "type": "string",
      "enum": [
        "full",
        "email_verification",
        "legal_acceptance",
        "deletion_recovery"
      ]
    }
  }
}
MarkdownQueryResult
MarkdownQueryResult
{
  "type": "object",
  "required": [
    "source",
    "status",
    "content"
  ],
  "additionalProperties": true,
  "description": "Markdown result content. content replaces the results array; other response fields such as id, source, status, usage and timestamps are preserved. No generated summary is added. Source URLs and transcript segment start/end times are retained.",
  "properties": {
    "source": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "content": {
      "type": "string",
      "description": "Deterministic Markdown derived from the retrieved source result."
    },
    "usage": {
      "type": "object",
      "additionalProperties": true
    }
  }
}
OAuthConnection
OAuthConnection
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "clientName",
    "scope",
    "status",
    "createdAt",
    "expiresAt"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^oag_[A-Za-z0-9_-]{8,}$"
    },
    "clientName": {
      "type": "string"
    },
    "scope": {
      "type": "string",
      "enum": [
        "mcp:research"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "expired",
        "revoked"
      ]
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}
OAuthConsent
OAuthConsent
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "clientName",
    "scope",
    "sources",
    "redirectUri",
    "expiresAt"
  ],
  "properties": {
    "clientName": {
      "type": "string",
      "maxLength": 80
    },
    "scope": {
      "type": "string",
      "enum": [
        "mcp:research"
      ]
    },
    "sources": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "google_search",
          "youtube_search",
          "youtube_metadata",
          "youtube_transcript"
        ]
      }
    },
    "redirectUri": {
      "type": "string",
      "format": "uri"
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}
OnboardingProgress
OnboardingProgress
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "currentStep",
    "apiKeyStepStatus",
    "firstRequestStatus",
    "version",
    "updatedAt"
  ],
  "properties": {
    "currentStep": {
      "type": "string",
      "enum": [
        "welcome",
        "api_key",
        "first_request",
        "completed"
      ]
    },
    "useCase": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "google_search",
        "youtube_data",
        "download",
        null
      ]
    },
    "apiKeyStepStatus": {
      "type": "string",
      "enum": [
        "pending",
        "created",
        "skipped"
      ]
    },
    "firstRequestStatus": {
      "type": "string",
      "enum": [
        "pending",
        "succeeded",
        "skipped"
      ]
    },
    "firstApiKeyId": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^key_"
    },
    "firstRequestId": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^req_"
    },
    "completedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "version": {
      "type": "integer",
      "minimum": 0
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    }
  }
}
Page
Page
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "pagination"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {}
    },
    "pagination": {
      "$ref": "#/components/schemas/Pagination"
    }
  }
}
Pagination
Pagination
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "hasMore",
    "limit"
  ],
  "properties": {
    "nextCursor": {
      "type": [
        "string",
        "null"
      ]
    },
    "previousCursor": {
      "type": [
        "string",
        "null"
      ]
    },
    "hasMore": {
      "type": "boolean"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    }
  }
}
Password
Password
{
  "type": "string",
  "minLength": 8,
  "maxLength": 128,
  "writeOnly": true
}
PlanCatalog
PlanCatalog
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "currency",
    "billingAvailability",
    "creditValueUsd"
  ],
  "properties": {
    "trialOffer": {
      "description": "Current one-time trial allowance expressed as alternative PAYG usage amounts. Eligibility and approval are required. The amounts share one balance and are not additive. Null when a reliable estimate is unavailable. This is not an account eligibility decision or a promise of immediate credit issuance.",
      "oneOf": [
        {
          "$ref": "#/components/schemas/PublicTrialOffer"
        },
        {
          "type": "null"
        }
      ]
    },
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Plan"
      }
    },
    "currency": {
      "type": "string",
      "const": "USD"
    },
    "creditValueUsd": {
      "type": "number",
      "exclusiveMinimum": 0,
      "description": "Fixed USD value of one credit, used to preview custom top-ups. The server computes the credited amount."
    },
    "billingAvailability": {
      "type": "string",
      "enum": [
        "available",
        "unconfigured",
        "unavailable"
      ]
    },
    "billingMessage": {
      "type": [
        "string",
        "null"
      ],
      "description": "Stable, non-sensitive explanation suitable for the Pricing and Billing UI."
    }
  }
}
Plan
Plan
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "slug",
    "name",
    "description",
    "includedCredits",
    "limits",
    "prices",
    "features",
    "usagePrices"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^plan_"
    },
    "slug": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "includedCredits": {
      "type": "number",
      "minimum": 0,
      "multipleOf": 0.001,
      "description": "Credits included in each paid subscription cycle; zero for Pay As You Go."
    },
    "limits": {
      "$ref": "#/components/schemas/PlanLimits"
    },
    "prices": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PlanPrice"
      }
    },
    "features": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "usagePrices": {
      "$ref": "#/components/schemas/PlanUsagePrices"
    }
  }
}
PlanLimits
PlanLimits
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "concurrency",
    "maxBatchSize",
    "maxPendingJobs"
  ],
  "properties": {
    "concurrency": {
      "type": "integer",
      "minimum": 1
    },
    "maxBatchSize": {
      "type": "integer",
      "minimum": 1
    },
    "maxPendingJobs": {
      "type": "integer",
      "minimum": 1
    }
  }
}
PlanPrice
PlanPrice
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "currency",
    "unitAmount",
    "credits",
    "type",
    "interval"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^prc_"
    },
    "currency": {
      "type": "string",
      "const": "USD"
    },
    "unitAmount": {
      "type": "integer",
      "minimum": 0,
      "description": "USD cents"
    },
    "credits": {
      "type": "number",
      "minimum": 0,
      "multipleOf": 0.001,
      "description": "Credits granted by a successful one-time top-up; zero for recurring prices."
    },
    "type": {
      "type": "string",
      "enum": [
        "recurring",
        "one_time"
      ]
    },
    "interval": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "month",
        "year",
        null
      ]
    }
  }
}
PlanUsagePrices
PlanUsagePrices
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "googlePer1kCents",
    "youtubePer1kCents",
    "downloadPerTbCents"
  ],
  "properties": {
    "googlePer1kCents": {
      "type": "integer",
      "minimum": 0,
      "description": "Google request price per 1,000 successful requests, in USD cents."
    },
    "youtubePer1kCents": {
      "type": "integer",
      "minimum": 0,
      "description": "Standard YouTube request price per 1,000 successful requests, in USD cents."
    },
    "downloadPerTbCents": {
      "type": "integer",
      "minimum": 0,
      "description": "Download price per decimal TB (1,000,000,000,000 bytes), in USD cents."
    }
  }
}
Problem
Problem
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type",
    "title",
    "status",
    "code",
    "requestId"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri-reference"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string",
      "pattern": "^[a-z0-9_]+$"
    },
    "detail": {
      "type": "string"
    },
    "requestId": {
      "type": "string",
      "pattern": "^req_"
    },
    "fieldErrors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/FieldError"
      }
    }
  }
}
FieldError
FieldError
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "field",
    "code",
    "message"
  ],
  "properties": {
    "field": {
      "type": "string"
    },
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}
PublicLegalVersions
PublicLegalVersions
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "availability",
    "termsVersion",
    "privacyVersion"
  ],
  "properties": {
    "availability": {
      "type": "string",
      "enum": [
        "configured",
        "unconfigured"
      ]
    },
    "termsVersion": {
      "type": [
        "string",
        "null"
      ],
      "minLength": 1,
      "maxLength": 64
    },
    "privacyVersion": {
      "type": [
        "string",
        "null"
      ],
      "minLength": 1,
      "maxLength": 64
    }
  }
}
PublicStatus
PublicStatus
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "status",
    "updatedAt",
    "components"
  ],
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "healthy",
        "degraded",
        "outage"
      ]
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "components": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PublicStatusComponent"
      }
    }
  }
}
PublicStatusComponent
PublicStatusComponent
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "name",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "operational",
        "degraded",
        "outage"
      ]
    }
  }
}
PublicTrialOffer
PublicTrialOffer
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "googleSearchRequests",
    "youtubeDataRequests",
    "downloadGigabytes"
  ],
  "properties": {
    "maxApiRequests": {
      "type": "integer",
      "minimum": 0,
      "description": "Maximum free API calls when the entire trial grant is spent on the lowest-cost per-request API at current Pay as you go rates. Other APIs may allow fewer calls. Downloads are billed by delivered bytes and excluded from this count."
    },
    "googleSearchRequests": {
      "type": "integer",
      "minimum": 0,
      "description": "Requests if the entire grant is spent on Google sources, using the highest current source rate."
    },
    "youtubeDataRequests": {
      "type": "integer",
      "minimum": 0,
      "description": "Standard YouTube requests, excluding Extended Search, using the highest current source rate."
    },
    "downloadGigabytes": {
      "type": "number",
      "minimum": 0,
      "description": "Approximate delivered media volume in decimal GB (1 GB = 1000000000 bytes). Zero when the grant cannot cover the initial download reservation. Completion also depends on per-job reservations and settlement."
    }
  }
}
QueryRepresentationError
QueryRepresentationError
{
  "type": "object",
  "required": [
    "error",
    "code",
    "message"
  ],
  "properties": {
    "error": {
      "type": "boolean",
      "const": true
    },
    "code": {
      "type": "string",
      "enum": [
        "unsupported_representation",
        "not_acceptable"
      ]
    },
    "message": {
      "type": "string"
    }
  }
}
Reauthentication
Reauthentication
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "reauthenticatedUntil"
  ],
  "properties": {
    "reauthenticatedUntil": {
      "type": "string",
      "format": "date-time"
    }
  }
}
RegisterRequest
RegisterRequest
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "email",
    "password",
    "acceptedTerms",
    "termsVersion",
    "privacyVersion"
  ],
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "description": "Optional display name. When omitted, defaults to the normalized email local part, truncated to 100 characters. Can be changed in the profile later."
    },
    "email": {
      "type": "string",
      "format": "email",
      "maxLength": 320
    },
    "password": {
      "$ref": "#/components/schemas/Password"
    },
    "acceptedTerms": {
      "type": "boolean",
      "const": true
    },
    "termsVersion": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "description": "Exact version rendered by the signup page; stale versions are rejected."
    },
    "privacyVersion": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "description": "Exact version rendered by the signup page; stale versions are rejected."
    }
  }
}
RegisterResponse
RegisterResponse
{
  "type": "object",
  "additionalProperties": false,
  "description": "Generic receipt returned for both a new account and a recoverable pending account. It intentionally omits identity data to limit account enumeration.",
  "required": [
    "emailVerificationRequired"
  ],
  "properties": {
    "emailVerificationRequired": {
      "type": "boolean",
      "const": true
    }
  }
}
Session
Session
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "current",
    "mode",
    "createdAt",
    "lastSeenAt",
    "expiresAt",
    "device"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^ses_"
    },
    "current": {
      "type": "boolean"
    },
    "mode": {
      "type": "string",
      "enum": [
        "full",
        "email_verification",
        "legal_acceptance",
        "deletion_recovery"
      ]
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "lastSeenAt": {
      "type": "string",
      "format": "date-time"
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time"
    },
    "device": {
      "type": "string"
    },
    "approximateLocation": {
      "type": "string"
    },
    "reauthenticatedUntil": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  }
}
Subscription
Subscription
{
  "type": "object",
  "description": "Effective entitlement projection. `status=payg` and `id=null` means no billing subscription record exists.",
  "additionalProperties": false,
  "required": [
    "status",
    "plan",
    "cancelAtPeriodEnd",
    "usageRates"
  ],
  "properties": {
    "id": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^sub_"
    },
    "status": {
      "type": "string",
      "enum": [
        "payg",
        "trialing",
        "active",
        "past_due",
        "grace",
        "cancelled"
      ]
    },
    "plan": {
      "$ref": "#/components/schemas/Plan"
    },
    "usageRates": {
      "type": "object",
      "description": "Account-specific configured credit rates. Query rates come from the account entitlement, not the public plan catalog. One TB is 1,000,000,000,000 bytes; download charges are settled against actual bytes and rounded per result.",
      "additionalProperties": false,
      "required": [
        "customized",
        "queries",
        "downloadCreditsPerTb"
      ],
      "properties": {
        "customized": {
          "type": "boolean",
          "description": "True when an administrator configured rates for this account."
        },
        "queries": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "source",
              "name",
              "creditsPerRequest"
            ],
            "properties": {
              "source": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "creditsPerRequest": {
                "type": "number",
                "minimum": 0
              }
            }
          }
        },
        "downloadCreditsPerTb": {
          "type": "number",
          "minimum": 0
        }
      }
    },
    "currentPeriodStart": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "currentPeriodEnd": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "cancelAtPeriodEnd": {
      "type": "boolean"
    },
    "graceEndsAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  }
}
SubscriptionCancellationChange
SubscriptionCancellationChange
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "cancelAtPeriodEnd",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^sub_"
    },
    "cancelAtPeriodEnd": {
      "type": "boolean"
    },
    "status": {
      "type": "string",
      "enum": [
        "submitted"
      ]
    }
  }
}
SubscriptionChange
SubscriptionChange
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "fromPriceId",
    "toPriceId",
    "effective",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^sub_",
      "description": "FlashData subscription public ID. Entitlement still updates only after a verified provider event."
    },
    "fromPriceId": {
      "type": "string",
      "pattern": "^prc_"
    },
    "toPriceId": {
      "type": "string",
      "pattern": "^prc_"
    },
    "effective": {
      "type": "string",
      "enum": [
        "immediate"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "submitted"
      ]
    }
  }
}
TokenRequest
TokenRequest
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "token"
  ],
  "properties": {
    "token": {
      "type": "string",
      "minLength": 32,
      "maxLength": 256,
      "writeOnly": true
    }
  }
}
TrialCreditState
TrialCreditState
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "eligible",
    "ineligibilityReason",
    "grantCredits",
    "settingsVersion",
    "request"
  ],
  "properties": {
    "eligible": {
      "type": "boolean"
    },
    "ineligibilityReason": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "account_inactive",
        "email_unverified",
        "onboarding_incomplete",
        "not_payg",
        "payment_history",
        "already_granted",
        "already_requested",
        null
      ]
    },
    "grantCredits": {
      "type": "integer",
      "minimum": 1
    },
    "settingsVersion": {
      "type": "integer",
      "minimum": 0
    },
    "request": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/TrialCreditRequest"
        },
        {
          "type": "null"
        }
      ]
    }
  }
}
TrialCreditRequest
TrialCreditRequest
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "status",
    "requestedCredits",
    "policyVersion",
    "useCase",
    "requestedAt",
    "reviewedAt",
    "reviewReason",
    "version"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^tcr_[A-Za-z0-9_-]{8,}$"
    },
    "status": {
      "$ref": "#/components/schemas/TrialCreditRequestStatus"
    },
    "requestedCredits": {
      "type": "integer",
      "minimum": 1
    },
    "policyVersion": {
      "type": "integer",
      "minimum": 0
    },
    "useCase": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "google_search",
        "youtube_data",
        "download",
        null
      ]
    },
    "requestedAt": {
      "type": "string",
      "format": "date-time"
    },
    "reviewedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "reviewReason": {
      "type": [
        "string",
        "null"
      ]
    },
    "version": {
      "type": "integer",
      "minimum": 0
    }
  }
}
TrialCreditRequestStatus
TrialCreditRequestStatus
{
  "type": "string",
  "enum": [
    "pending",
    "approved",
    "rejected"
  ]
}
UpdateAccountRequest
UpdateAccountRequest
{
  "type": "object",
  "additionalProperties": false,
  "minProperties": 1,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "timezone": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    }
  }
}
UpdateBulkJobRequest
UpdateBulkJobRequest
{
  "type": "object",
  "additionalProperties": false,
  "minProperties": 1,
  "properties": {
    "options": {
      "type": "object",
      "additionalProperties": true,
      "description": "Partial option update. Nested storage fields are merged so unchanged credentials do not need to be resent. Data result_storage fields are merged the same way. After all IDs have been scanned, a paused data bulk job accepts credential updates only: access_key and secret_key, GCS service_account, or Azure sas_token, depending on the storage type. The complete merged configuration is validated before it is stored."
    },
    "callback_url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "maxLength": 2048,
      "description": "Replacement completion callback, or null to remove the callback."
    }
  }
}
UpdateOnboardingRequest
UpdateOnboardingRequest
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "version",
    "action"
  ],
  "properties": {
    "version": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "action": {
      "type": "string",
      "enum": [
        "select_use_case",
        "confirm_api_key_saved",
        "skip_api_key",
        "confirm_first_request",
        "skip_first_request"
      ]
    },
    "useCase": {
      "type": "string",
      "enum": [
        "google_search",
        "youtube_data",
        "download"
      ]
    }
  },
  "allOf": [
    {
      "if": {
        "properties": {
          "action": {
            "const": "select_use_case"
          }
        }
      },
      "then": {
        "required": [
          "useCase"
        ],
        "properties": {
          "useCase": {}
        }
      },
      "else": {
        "not": {
          "required": [
            "useCase"
          ],
          "properties": {
            "useCase": {}
          }
        }
      }
    }
  ],
  "description": "Server-owned resource state validates confirmation actions; clients never submit API Key or request IDs."
}
UsageCounts
UsageCounts
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "requests",
    "completed",
    "failed",
    "credits"
  ],
  "properties": {
    "requests": {
      "type": "integer",
      "minimum": 0
    },
    "completed": {
      "type": "integer",
      "minimum": 0
    },
    "failed": {
      "type": "integer",
      "minimum": 0
    },
    "credits": {
      "type": "number",
      "minimum": 0,
      "description": "Charged Credits in the current aggregate; pending work may not be finally settled."
    }
  }
}