Перейти до вмісту
UK
Отримати ключ API
Переглянути документацію

Довідник API

Керівництво API

Переглядайте кінцеві точки для рахунків, ключів, рахунків та робочих місць. Кожна точка кінцевого рахунку списує свою автентифікацію та вимоги до доступу.

Ознайомтеся з нашим обліковим записом за допомогою ключа API

Управління API бази URL - https://api.flashdata.dev/v2. Цей безкоштовний зчитування повертає поточний ключ та обліковий запис IDs та власність. Встановіть 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 використовує підписку на веб-переглядач. Відповідність особистості schema

Завантажити специфікацію OpenAPI. Він охоплює запити, робочі місця, рахунки, ключі API та вексель.

Параметри запитів та код запиту задокументовані у Google і YouTube API посилання.

Схеми аутентифікації

АКЦІЇЗакупівля
dataApiKey

X-API-Key · header

FlashData API ключ. Доступ до роботи обмежується вихідним обсягом ключа.

cookieSession

__Host-fd_session · cookie

Веб-камера Opaque У браузері не можна прочитати цей cookie.

csrfToken

X-CSRF-Token · header

apiKey

agentRegistrationProof

Постійний криптографічно випадковий 32-байт base64url доказ і точний запит BEFORE відправлення; відновити тільки з однаковим доказом і тілом. Не токени OAuth.

agentSetupCredential

Тимчасове налаштування для створення статусу та претензії тільки. Не дані API ключ.

agentHandoffProof

Для відновлення ключа власника і визнання інсталяцій. Ніколи не відправили в запит даних.

agentIdentityKey

Ординарні FlashData API ключ в авторизації Bearer, тільки на ідентичність агента. Запити даних використовують X-API-Key замість.

Система

GET/health

Здоров'я

Ауттентифікація: Про нас

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Відповіді

200 Здоров'я

200 відповідь · application/json

Health

200 відповідь
{
  "$ref": "#/components/schemas/Health"
}
GET/status

Читати резюме стану публічного компонента

Ауттентифікація: Про нас

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Відповіді

200 Загальний статус громадськості

Рубанки: Cache-Control

200 відповідь · application/json

PublicStatus

200 відповідь
{
  "$ref": "#/components/schemas/PublicStatus"
}

Аути

GET/oauth/requests/{requestId}

Прочитати запит авторизації додатку та зв’язати його на поточну сеанс

Повне засідання обов’язково. Запит закінчується після десяти хвилин. Відповідність не є магазином.

Ауттентифікація: cookieSession

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

requestId · path · обов'язкові

Смоктати
Смоктати
{
  "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 і дозволена Походження потрібно. Згоди запита один раз. Відповідність не є магазином.

Ауттентифікація: cookieSession + csrfToken

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

requestId · path · обов'язкові

Смоктати
Смоктати
{
  "type": "string",
  "pattern": "^fdo_[A-Za-z0-9_-]{43}$"
}

Запит тіла · обов'язкові

Смоктати · application/json
Смоктати
{
  "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

Подані Умови та умови конфіденційності повинні відповідати чинному опублікованому юридичному пакету.

Ауттентифікація: Про нас

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Запит тіла · обов'язкові

Смоктати · application/json

RegisterRequest

Смоктати
{
  "$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

Створення веб-сесії

Налаштовує безпечну, HttpOnly `__Host-fd_session` cookie. Кредитні рахунки отримувати обмежену секцію email_verification для перевірки панелі. Вивірені облікові записи отримують свої одноразові кредитні картки на логін, якщо не раніше надано. Активний рахунок отримує повну сесія, якщо її мігрувати ідентичність все ще вимагає поточна юридична акцептація, в якій випадках вона отримує обмеження legal_acceptance Сесія. Обліковий запис з запитом на заплановане видалення отримує обмежену сеанс deletion_recovery. Рахунки, чиї затримки processing/failed/completed та підвісні рахунки, отримують 403.

Ауттентифікація: Про нас

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Запит тіла · обов'язкові

Смоктати · application/json

LoginRequest

Смоктати
{
  "$ref": "#/components/schemas/LoginRequest"
}

Відповіді

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 Вхід заборонено; Problem.code - email_not_verified, account_suspended, account_deletion_processing, account_deletion_failed, або 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

Відкликання поточного сеансу

Ауттентифікація: cookieSession + csrfToken

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Відповіді

204 Сесія відкликана і cookie очищена

Рубанки: 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

Читати поточний обліковий запис і користувач

Ауттентифікація: 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 токен, що відповідає поточному сеансу

Ауттентифікація: cookieSession

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Відповіді

200 CSRF токен

Рубанки: 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

Запитайте або перегляньте повідомлення про перевірку електронної пошти

Для кожного синхронного дійсного електронного листа, повертає однакову відповідь незалежно від того, чи відсутній обліковий запис, закінчення, активне, підвішене або видалене. Витратні рахунки, що зараховуються, отримують обертається одноразовим посиланням після перезаряджання.

Ауттентифікація: Про нас

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Запит тіла · обов'язкові

Смоктати · application/json
Смоктати
{
  "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 може отримати обертається Сесійний cookie для того ж перевіреного облікового запису; перевірка, що проявляється, не підписується на користувача.

Ауттентифікація: Про нас

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Запит тіла · обов'язкові

Смоктати · application/json

TokenRequest

Смоктати
{
  "$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 ЦЕНА ЗА ЧАС: `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

Продовжити оригінальну реєстрацію після перевірки електронної пошти

Вимагає дозволене походження і токен CSRF, що обмежуються живим паролем, що оновлюється сеансом електронної пошти. Повернутися до свого облікового запису сеансу, включаючи перевірку в іншому браузері. Атомно відкликає засідання реєстрації та видає свіжу повноправну або юридично-акцепційну сесія. Чи не приймається обліковий запис ID, електронної пошти, пароля або перевірки токену, обходячи правовий прийом, або надання кредитів.

Ауттентифікація: cookieSession + csrfToken

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Запит тіла · обов'язкові

Смоктати · application/json
Смоктати
{
  "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 на синтактичну електронну пошту незалежно від стану життєвого циклу облікового запису. Для отримання поштової скриньки необхідно мати доступ до Особистого кабінету.

Ауттентифікація: Про нас

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Запит тіла · обов'язкові

Смоктати · application/json
Смоктати
{
  "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, відроджує кожну існуючу сеансу, і недійсний інші токени пароля. Не ввійдіть користувача або створюйте сеанс.

Ауттентифікація: Про нас

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Запит тіла · обов'язкові

Смоктати · application/json

Password

Смоктати
{
  "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 ЦЕНА ЗА ЧАС: `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

Список активних сеансів для поточного користувача

Ауттентифікація: 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

Відкликати всі сеанси, крім поточного

Ауттентифікація: 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}

Відкликання однієї сесії

Ауттентифікація: cookieSession + csrfToken

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

sessionId · path · обов'язкові

Смоктати
Смоктати
{
  "type": "string",
  "pattern": "^ses_"
}

Відповіді

204 Сесія відкликана. Якщо це була поточна сесія, cookie очищається.

Рубанки: 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

Перевірити поточний пароль для чутливої роботи

Записи на короткочасну перевірку на поточній серверній стороні сеансу.

Ауттентифікація: cookieSession + csrfToken

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Запит тіла · обов'язкові

Смоктати · application/json
Смоктати
{
  "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

Зміна пароля і обертати поточну скриньку

Ауттентифікація: cookieSession + csrfToken

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Запит тіла · обов'язкові

Смоктати · application/json

Password

Смоктати
{
  "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

Список підключених додатків поточного рахунку

Повне засідання обов’язково. Якщо обліковий запис не підключено до додатків. Відповідність не є магазином.

Ауттентифікація: 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 і дозволена Походження потрібно. Застосовано право власності на рахунки. Відповідність не є магазином.

Ауттентифікація: cookieSession + csrfToken

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

grantId · path · обов'язкові

Смоктати
Смоктати
{
  "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

Налаштування облікового запису

Ауттентифікація: 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

Оновлення параметрів профілю

Ауттентифікація: cookieSession + csrfToken

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Запит тіла · обов'язкові

Смоктати · application/json

UpdateAccountRequest

Смоктати
{
  "$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

Аудиторські рахунки повинні мати свою роль платформи, що відкликається через процес роботи оператора, до того, як видалення може бути заплановано. Унікальний активний запит щодо видалення є природним лімітом idempotency. Виконувати автентифіковані графіки повернення одного запиту. Після відкликання сеансу, втрачена відповідь відновлюється шляхом входу в режим deletion_recovery і читання GET /account/deletion; скасовані сеанси ніколи не приймаються до відтворення.

Ауттентифікація: cookieSession + csrfToken

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Запит тіла · обов'язкові

Смоктати · application/json
Смоктати
{
  "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

Читання поточного запиту на видалення облікового запису

Ауттентифікація: 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; після успіху сеанс відновлення обертається і не може відтворювати старий перехід.

Ауттентифікація: 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

Accept в даний час опубліковані Правила та умови конфіденційності

Надає безперешкоджену юридичну акцепцію, очищає ворота міграції та обертає сеанс. Відхилено подані версії.

Ауттентифікація: cookieSession + csrfToken

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Запит тіла · обов'язкові

Смоктати · application/json

LegalAcceptanceRequest

Смоктати
{
  "$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

Читання пересувних на борту прогресу

Ауттентифікація: 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

Поспішне на борту без можливості переходу

Ауттентифікація: cookieSession + csrfToken

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Запит тіла · обов'язкові

Смоктати · application/json

UpdateOnboardingRequest

Смоктати
{
  "$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

Читання агрегату на касі облікового запису

Ауттентифікація: 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 і перезапуск готовності

Free header-only API-key читати. Повертає громадськість account/key IDs та авторитетне право власності. Немає запиту тіла. Чи не змінить існуючу відповідь метаданих /api-access. Відповідає 120/minute ліміт рахунка. Замкнено недоступність, не вживаючи права від ключової префіксації, плану чи місцевого стану. Не приймаються параметри запиту. Відповіді не є магазином.

Ауттентифікація: 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

Ауттентифікація: 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

Створіть ключ API і розкрийте секрет один раз

Ауттентифікація: cookieSession + csrfToken

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

Idempotency-Key · header · обов'язкові

Смоктати
Смоктати
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

Запит тіла · обов'язкові

Смоктати · application/json

CreateApiKeyRequest

Смоктати
{
  "$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}

Відкликання ключа API

Ауттентифікація: cookieSession + csrfToken

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

keyId · path · обов'язкові

Смоктати
Смоктати
{
  "type": "string",
  "pattern": "^key_"
}

Відповіді

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"
}

503 Необхідна залежність або каталог тимчасово недоступний

503 відповідь · application/problem+json

Problem

503 відповідь
{
  "$ref": "#/components/schemas/Problem"
}
POST/api-keys/{keyId}/rotate

Створення замінного ключа та розкладу застарілих відкликань

Створює новий ключ і зберігає старий ключ активний до revokeOldAt. За замовчуванням, перекриття триває 24 годин або до старого ключа закінчується, який раніше. На замовлення revokeOldAt повинен бути в майбутньому, протягом семи днів, і не пізніше, ніж за старим ключем.

Ауттентифікація: cookieSession + csrfToken

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

keyId · path · обов'язкові

Смоктати
Смоктати
{
  "type": "string",
  "pattern": "^key_"
}

Idempotency-Key · header · обов'язкові

Смоктати
Смоктати
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

Запит тіла · Додатково

Смоктати · application/json
Смоктати
{
  "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, якщо безоплатно. Немає облікового запису ID, ключ ID, секрет або облікові дані для зберігання. Місцевий MCP переоцінює цю кінцеву точку перед кожним відкриттям інструменту та викликом, в тому числі прочитано результати кешування. Не приймаються параметри запиту або замовлення тіла. Всі маршрути /api-access діляться 120 за хвилину за клієнт IP і повернення Особистий кабінет, безвідмовний. Нормальний ключ, що використовується, все ще відбувається.

Ауттентифікація: 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 Заборонено на маршрутах агента.

Ауттентифікація: Про нас

Сервер: 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 Кредит, 72 годин, 1 request/second, розмір партії 1. Нормативно-правові ліміти на сервері. Не приймаються параметри запиту. Відповіді не є магазином. У разі вимкнення маршрутів агента можна повернути 404. X-API-Key Заборонено на маршрутах агента.

Ауттентифікація: agentRegistrationProof

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Запит тіла · обов'язкові

Смоктати · application/json

AgentRegistrationRequest

Смоктати
{
  "$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 або доказ.

Ауттентифікація: 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 Заборонено на маршрутах агента.

Ауттентифікація: agentSetupCredential

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

connectionId · path · обов'язкові

Смоктати
Смоктати
{
  "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 або доказ.

Ауттентифікація: cookieSession + csrfToken

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

connectionId · path · обов'язкові

Смоктати
Смоктати
{
  "type": "string",
  "pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}

Origin · header · обов'язкові

Смоктати
Смоктати
{
  "type": "string"
}

X-CSRF-Token · header · обов'язкові

Смоктати
Смоктати
{
  "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 Заборонено на маршрутах агента.

Ауттентифікація: agentIdentityKey

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

connectionId · path · обов'язкові

Смоктати
Смоктати
{
  "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 Заборонено на маршрутах агента.

Ауттентифікація: agentHandoffProof

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

connectionId · path · обов'язкові

Смоктати
Смоктати
{
  "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 Заборонено на маршрутах агента.

Ауттентифікація: agentSetupCredential

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

connectionId · path · обов'язкові

Смоктати
Смоктати
{
  "type": "string",
  "pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}

Запит тіла · обов'язкові

Смоктати · application/json
Смоктати
{
  "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 або доказ.

Ауттентифікація: cookieSession + csrfToken

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

claimId · path · обов'язкові

Смоктати
Смоктати
{
  "type": "string",
  "pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}

Origin · header · обов'язкові

Смоктати
Смоктати
{
  "type": "string"
}

X-CSRF-Token · header · обов'язкові

Смоктати
Смоктати
{
  "type": "string"
}

Запит тіла · обов'язкові

Смоктати · application/json
Смоктати
{
  "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 або доказ.

Ауттентифікація: cookieSession

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

claimId · path · обов'язкові

Смоктати
Смоктати
{
  "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 або доказ.

Ауттентифікація: cookieSession + csrfToken

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

claimId · path · обов'язкові

Смоктати
Смоктати
{
  "type": "string",
  "pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}

Origin · header · обов'язкові

Смоктати
Смоктати
{
  "type": "string"
}

X-CSRF-Token · header · обов'язкові

Смоктати
Смоктати
{
  "type": "string"
}

Запит тіла · обов'язкові

Смоктати · application/json

AgentApproval

Смоктати
{
  "$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

Відновлення затвердженого власника API ключ

Кріплення ключа кандидата в 24 годин до установки ACK. Персист атомічно, перезавантажити в свіжому процесі і перевірити ідентичність перед знімком. Відшкодовано повторну поставку, що повертає той самий кандидат, підтверджену доставку повертається без облікових даних. Не приймаються параметри запиту. Відповіді не є магазином. У разі вимкнення маршрутів агента можна повернути 404. X-API-Key Заборонено на маршрутах агента.

Ауттентифікація: agentHandoffProof

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

connectionId · path · обов'язкові

Смоктати
Смоктати
{
  "type": "string",
  "pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}

Запит тіла · обов'язкові

Смоктати · application/json
Смоктати
{
  "type": "object",
  "additionalProperties": false,
  "properties": {},
  "required": []
}

Відповіді

200 Відновлення затвердженого власника API ключ

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

Acknowledge перевірена установка власника ключа

Зателефонуйте, щоб вже було збережено кандидата і самостійно перевірте його в свіжому процесі. Успішні позначки ACK, що встановлюються, видаліть запит кандидата та видаляє відновлений матеріал. Повторний ACK є idempotent. Не приймаються параметри запиту. Відповіді не є магазином. У разі вимкнення маршрутів агента можна повернути 404. X-API-Key Заборонено на маршрутах агента.

Ауттентифікація: agentHandoffProof

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

connectionId · path · обов'язкові

Смоктати
Смоктати
{
  "type": "string",
  "pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}

Запит тіла · обов'язкові

Смоктати · application/json
Смоктати
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "apiKey": {
      "type": "string"
    }
  },
  "required": [
    "apiKey"
  ]
}

Відповіді

200 Acknowledge перевірена установка власника ключа

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

Список можливостей публічного джерела без специфікаційного ціноутворення

Ауттентифікація: Про нас

Сервер: 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

Список публічних планів USD

Ауттентифікація: Про нас

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Відповіді

200 Каталог публічних планів

Рубанки: Cache-Control

200 відповідь · application/json

PlanCatalog

200 відповідь
{
  "$ref": "#/components/schemas/PlanCatalog"
}
GET/legal/current

Переглянути поточні умови та умови конфіденційності, необхідні для реєстрації

Ауттентифікація: Про нас

Сервер: 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

Читать ефективну підписку на стриптиз

Ауттентифікація: 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

Створіть стриптиз-hosted Checkout Session

Абоненти та опубліковані кредитні пакети використовують priceId. Замовний топ-ап використовує amountMinor замість (USD центів, $10 до $999,999.99); сервер розраховує кредити за фіксованою кредитною вартістю і створює приватний одноразовий стриптиз ціна. Продукт, ціна провайдера, валюта, успіх URL і скасувати URL ніколи не приймаються з браузера. Кредит надаються тільки після перевіреної платної події для цитованої суми.

Ауттентифікація: cookieSession + csrfToken

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

Idempotency-Key · header · обов'язкові

Смоктати
Смоктати
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

Запит тіла · обов'язкові

Смоктати · application/json
Смоктати
{
  "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-denomind, повторення, той самий інтервал, і строго дорожче, ніж ціна підписки. Ціна, ціна провайдера, валютні та проерційні параметри ніколи не приймаються з браузера. Проводиться локальне право та зміни кредитних коштів тільки після проведення перевірок.

Ауттентифікація: cookieSession + csrfToken

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

Idempotency-Key · header · обов'язкові

Смоктати
Смоктати
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

Запит тіла · обов'язкові

Смоктати · application/json
Смоктати
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "priceId"
  ],
  "properties": {
    "priceId": {
      "type": "string",
      "pattern": "^prc_"
    }
  }
}

Відповіді

201 Зміна підписки подано на Stripe

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

Створення сеансу клієнтського порталу Stripe

Ауттентифікація: cookieSession + csrfToken

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

Idempotency-Key · header · обов'язкові

Смоктати
Смоктати
{
  "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 зберігає підписку. Оновлення імен після перевіреної події підписки на стриптиз. Цей кінцевий пункт ніколи не скасовує негайно або видає повернення коштів.

Ауттентифікація: cookieSession + csrfToken

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

Idempotency-Key · header · обов'язкові

Смоктати
Смоктати
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

Запит тіла · обов'язкові

Смоктати · application/json
Смоктати
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "cancelAtPeriodEnd"
  ],
  "properties": {
    "cancelAtPeriodEnd": {
      "type": "boolean"
    }
  }
}

Відповіді

202 Оновлення скасування подано в Stripe

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

Список проекцій Стриптизьорка

Ауттентифікація: cookieSession

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

cursor · query · Додатково

Смоктати
Смоктати
{
  "type": "string",
  "maxLength": 512
}

limit · query · Додатково

Смоктати
Смоктати
{
  "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

Список проекцій з рахунку-скопдовим поповненням та поверненням коштів

Ауттентифікація: cookieSession

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

cursor · query · Додатково

Смоктати
Смоктати
{
  "type": "string",
  "maxLength": 512
}

limit · query · Додатково

Смоктати
Смоктати
{
  "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 у вашому обліковому записі. Активні бронювання можуть зменшити наявний баланс. Вартість запиту не вимагає кредитних коштів і не вимагає параметрів запиту або тіла. Відповіді є приватними та не є обов'язковими; накладаються ліміти облікового запису.

Ауттентифікація: 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 підраховує запити, не повернуті елементи; ставки завантаження є на TB (10^12 байтів). Оцінки не резервують Кредит або ємність. Вартість цього запиту не передбачає кредитів. Відповіді є приватними та не є обов'язковими; накладаються ліміти облікового запису.

Ауттентифікація: dataApiKey

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

source · query · Додатково

Джерело, надана цим ключем; omit читати всі надані джерела.

Смоктати

ApiAccessSource

Смоктати
{
  "$ref": "#/components/schemas/ApiAccessSource"
}

request_count · query · Додатково

Термінове ціле число дзвінків; не оцінює розмір завантаження.

Смоктати
Смоктати
{
  "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

Ознайомтеся з лімітами кінцевих користувачів, а також поточну кількість очікувань. Ці значення допомагають планувати запити, але не зафіксовані ємності. Вартість запиту не вимагає кредитних коштів і не вимагає параметрів запиту або тіла. Відповіді є приватними та не є обов'язковими; накладаються ліміти облікового запису.

Ауттентифікація: 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 днів. Дати необхідно використовувати UTC Z-timestamps. Від інклюзивного і до ексклюзивних; як занурюється, так і в хвилину. З одного боку, щоб за замовчуванням від + 7 днів. Ні, ні, щоб розпочати наступну хвилину. Агрегати в кінцевому підсумку послідовно; навіть оновлення=false не гарантує, що всі останні події не проходять. Читання ліміту: 60 Запити на хвилину на клієнт IP.

Ауттентифікація: dataApiKey

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

source · query · Додатково

Точне джерело каталогу, надане ключем виклику; випромінює всі дані, що надавалися.

Смоктати
Смоктати
{
  "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 · Додатково

Смоктати
Смоктати
{
  "type": "string",
  "format": "date-time"
}

to · query · Додатково

Смоктати
Смоктати
{
  "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

Кредитна картка

Ауттентифікація: 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

Читання ефективної політики кредитного рахунку та оплати

Ауттентифікація: 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

Список записів кредитних приводів

Ауттентифікація: cookieSession

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

cursor · query · Додатково

Смоктати
Смоктати
{
  "type": "string",
  "maxLength": 512
}

limit · query · Додатково

Смоктати
Смоктати
{
  "type": "integer",
  "minimum": 1,
  "maximum": 100,
  "default": 50
}

type · query · Додатково

Смоктати

CreditEntryType

Смоктати
{
  "$ref": "#/components/schemas/CreditEntryType"
}

Відповіді

200 Приводні записи

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

Читання правової відповідальності за термін дії облікового запису та вимогу про термін дії рахунку

Ауттентифікація: 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

Подати заявку на обслуговування облікового запису

Введіть номер мобільного, який Ви вказали при укладаннi договору з банком - для ідентифікації.

Ауттентифікація: cookieSession + csrfToken

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

Idempotency-Key · header · обов'язкові

Смоктати
Смоктати
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

Запит тіла · Додатково

Смоктати · application/json
Смоктати
{
  "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

Ауттентифікація: cookieSession

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Відповіді

200 Зворотній зв'язок 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

Ауттентифікація: cookieSession + csrfToken

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Запит тіла · обов'язкові

Смоктати · application/json

CreateDeliveryWebhookRequest

Смоктати
{
  "$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

Ауттентифікація: cookieSession + csrfToken

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

webhookId · path · обов'язкові

Смоктати
Смоктати
{
  "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

Відправте зразок завантаження-повний завантаження

Ауттентифікація: cookieSession + csrfToken

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

webhookId · path · обов'язкові

Смоктати
Смоктати
{
  "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 та async · Batch запитів.

GET/jobs

Список даних API для поточного робочого простору

Історія та архівування куратора. За замовчуванням до останніх семи днів; кожен діапазон дати UTC обмежений 31 днів. Від інклюзивного і до ексклюзивних, в хвилину прецизії. Сумпери підтримуються асинхронно і можуть відлягати загартування.

Ауттентифікація: cookieSession

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

cursor · query · Додатково

Смоктати
Смоктати
{
  "type": "string",
  "minLength": 1,
  "maxLength": 512
}

limit · query · Додатково

Смоктати
Смоктати
{
  "type": "integer",
  "minimum": 1,
  "maximum": 50
}

source · query · Додатково

Смоктати
Смоктати
{
  "type": "string",
  "pattern": "^(google|youtube|google_[a-z]+|youtube_[a-z_]+)$"
}

status · query · Додатково

Смоктати
Смоктати
{
  "type": "string",
  "enum": [
    "completed",
    "failed",
    "pending",
    "processing"
  ]
}

mode · query · Додатково

Смоктати
Смоктати
{
  "type": "string",
  "enum": [
    "async",
    "batch",
    "realtime"
  ]
}

from · query · Додатково

Смоктати
Смоктати
{
  "type": "string",
  "format": "date-time"
}

to · query · Додатково

Смоктати
Смоктати
{
  "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 є за замовчуванням; використовувати Accept: text/plain для читання тексту. X-Respond-With ігнорується тут. Додайте Retry-After, якщо надана перед перевіркою знову.

Ауттентифікація: cookieSession або dataApiKey

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

Accept · header · Додатково

application/json повертає оригінальну структуровану відповідь; text/plain повертає ті ж поля, як і відступний звичайний текст. Підтримуються стандартні медіа діапазони та ваги q; відсутні Accept або глобальні за замовчуванням Wildcard до JSON. X-Respond-With ігнорується на подачі та кінцевих точках роботи. Помилки залишаються структурованими JSON. Типи відповіді використовують UTF-8; чіткий charset=utf-8 параметр.

Смоктати
Смоктати
{
  "type": "string"
}

jobId · path · обов'язкові

Смоктати
Смоктати
{
  "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 Neither application/json, ні text/plain прийнятний; відповідь JSON

406 відповідь · application/json

QueryRepresentationError

406 відповідь
{
  "$ref": "#/components/schemas/QueryRepresentationError"
}
GET/jobs/{jobId}/results

Завантажити завершений підсумок async

За замовчуванням, автентифікує доступ і перенаправлення до короткострокової приватної R2 URL; клієнти отримують оригінальний JSON безпосередньо від R2. Accept: text/plain самостійно повертає HTTP 200 з оригінальними полями результату як відступний звичайний текст. X-Respond-With: розмітка вибирає зміст Markdown: application/json обгортає його в вмісті поряд з оригінальними метаданими, замінюючи результати; text/plain повертає метадані, з якими працює Markdown. Місячні Accept або глобальні за замовчуванням Wildcard JSON. Форматування не пред’являйте ще один запит або сплачуйте за запитом. Зберігайте результати затримки 24 після завершення. Помилки залишаються структурованими JSON.

Ауттентифікація: cookieSession або dataApiKey

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

X-Respond-With · header · Додатково

Встановити для позначення вмісту результату в Markdown. Збережіть поля оригінального результату. Accept самостійно вибирає JSON або звичайний текст. Тільки в режимі реального часу запити і завершений результат роботи читає підтримку цього заголовка. Це не змінює подання, статус, API облікових записів, зворотний зв'язок, Bulk файли, бінарні завантаження, або MCP відповіді протоколу.

Смоктати
Смоктати
{
  "type": "string",
  "enum": [
    "markdown"
  ]
}

Accept · header · Додатково

Виберіть application/json або text/plain самостійно від X-Respond-With. Без X-Respond-With, text/plain повертає оригінальні поля з відступом; JSON зберігає оригінальні поля відповіді (повна кількість даних, що перенаправлюється на зберігання). З розміткою, JSON повертає вміст та метадані, а також звичайний текст повертає метадані з використанням Markdown. Підтримуються стандартні медіа діапазони та ваги q; відсутні Accept або глобальні за замовчуванням Wildcard до JSON. Типи відповіді використовують UTF-8; чіткий charset=utf-8 параметр.

Смоктати
Смоктати
{
  "type": "string"
}

jobId · path · обов'язкові

Смоктати
Смоктати
{
  "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 Neither 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 кінцеві точки мають виділену посилання з параметрами, прикладами запиту та відповідями. Open Bulk обробка API

Плеймейт

POST/playground/run

Виконайте спортивну біржу в якості поточного робочого простору

Ауттентифікація: cookieSession + csrfToken

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Запит тіла · обов'язкові

Смоктати · application/json
Смоктати
{
  "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

Завантажити завершений артефакт Playground в поточному браузері

Ауттентифікація: cookieSession

Сервер: https://api.flashdata.dev/v2

Сервер: http://localhost:5000/v2

Параметри

jobId · path · обов'язкові

Смоктати
Смоктати
{
  "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."
    }
  }
}