Перейти к содержимому
RU
Ключ 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 использует сеанс подписки в браузере. Схема реагирования на идентификацию

Скачать спецификацию OpenAPI клиента. Он охватывает запросы, рабочие места, учетные записи, ключи API и выставление счетов.

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

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

схемаТребование
dataApiKey

X-API-Key · header

Ключ FlashData API. Доступ к работе ограничен сферами источника ключа.

cookieSession

__Host-fd_session · cookie

Непрозрачная веб-сессия. Браузер не может прочитать этот файл cookie.

csrfToken

X-CSRF-Token · header

apiKey

agentRegistrationProof

Сохраняйте криптографически случайное доказательство 32-байт base64url и точный запрос До отправки; восстанавливайте только с тем же доказательством и телом. Не токен OAuth.

agentSetupCredential

Временные полномочия установки только для статуса и создания претензий. Это не ключ API.

agentHandoffProof

Доказательство используется для восстановления ключа владельца и подтверждения установки. Никогда не отправляйте запрос данных.

agentIdentityKey

Обычный ключ FlashData API в носителе авторизации, только по идентификатору агента. Запросы данных используют 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 и разрешенный Origin требуется. Потребляет заявку один раз. Реакция - это не магазин.

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

Создайте непрозрачную веб-сессию

Устанавливает Secure, 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

Продолжить сеанс регистрации после проверки электронной почты

Требуется разрешенный Origin и токен 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

Запросить пароль reset email

Всегда возвращает один и тот же ответ 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 и разрешенный Origin требуется. Право собственности на счет соблюдается. Реакция - это не магазин.

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

Учетные записи администраторов должны быть отменены через проверенный рабочий процесс оператора, прежде чем удаление может быть запланировано. Уникальный активный запрос на удаление является естественной границей идемпотентности. Параллельные аутентифицированные графики возвращают тот же запрос. После отзыва сеанса потерянный ответ восстанавливается путем входа в режим 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

Read resumable onboarding progress (недоступная ссылка)

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

Бесплатный заголовок 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 Key

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

Сохраняйте регистрационное доказательство и точный ввод перед POST. Те же доказательства и тело восстанавливают одно и то же испытание; изменение исходных данных приводит к конфликту. Временная пробная версия: 1 Credit, 72 hours, 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-ключ

Ответ 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. Продолжить атомарно, перезагрузить в новом процессе и проверить личность перед 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

Подтвержденная установка ключа владельца

Звонивший должен был уже спасти кандидата и самостоятельно проверить его в новом процессе. Успешная установка знаков ACK, удаление истечения срока действия ключа-кандидата и удаление восстанавливаемого материала учетных данных. Повторяющийся 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": {
    "apiKey": {
      "type": "string"
    }
  },
  "required": [
    "apiKey"
  ]
}

Ответы

200 Подтвержденная установка ключа владельца

Ответ 200 · application/json

AgentHandoff

Ответ 200
{
  "$ref": "#/components/schemas/AgentHandoff"
}

400 Отклоненный запрос; проверить код проблемы. Никогда не повторяйте мутации вслепую.

Ответ 400 · application/problem+json

Problem

Ответ 400
{
  "$ref": "#/components/schemas/Problem"
}

401 Отклоненный запрос; проверить код проблемы. Никогда не повторяйте мутации вслепую.

Ответ 401 · application/problem+json

Problem

Ответ 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Отклоненный запрос; проверить код проблемы. Никогда не повторяйте мутации вслепую.

Ответ 403 · application/problem+json

Problem

Ответ 403
{
  "$ref": "#/components/schemas/Problem"
}

409 Отклоненный запрос; проверить код проблемы. Никогда не повторяйте мутации вслепую.

Ответ 409 · application/problem+json

Problem

Ответ 409
{
  "$ref": "#/components/schemas/Problem"
}

410 Отклоненный запрос; проверить код проблемы. Никогда не повторяйте мутации вслепую.

Ответ 410 · application/problem+json

Problem

Ответ 410
{
  "$ref": "#/components/schemas/Problem"
}

422 Отклоненный запрос; проверить код проблемы. Никогда не повторяйте мутации вслепую.

Ответ 422 · application/problem+json

Problem

Ответ 422
{
  "$ref": "#/components/schemas/Problem"
}

429 Отклоненный запрос; проверить код проблемы. Никогда не повторяйте мутации вслепую.

Ответ 429 · application/problem+json

Problem

Ответ 429
{
  "$ref": "#/components/schemas/Problem"
}

503 Отклоненный запрос; проверить код проблемы. Никогда не повторяйте мутации вслепую.

Ответ 503 · application/problem+json

Problem

Ответ 503
{
  "$ref": "#/components/schemas/Problem"
}

Каталог

GET/catalog/sources

Перечислите возможности публичных источников без учета конкретных цен

Аутентификация: Публичное

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

Читать Эффективная подписка Stripe

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

Создайте стриптиз-хостинг Checkout Session

Подписки и опубликованные кредитные пакеты используют priceId. Вместо этого пользовательское пополнение использует amountMinor (USD центы, $10 до $999,999.99); сервер вычисляет кредиты по фиксированной кредитной стоимости и создает частную единовременную цену Stripe. Продукт, цена поставщика, валюта, успех 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 Сеанс Stripe Checkout

Ответ 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

Обновите текущую подписку Stripe до более высокой опубликованной цены

Сервер проверяет, что цена FlashData является активной, доступной в текущем режиме, номиналом USD, повторяющейся, с тем же интервалом и строго дороже, чем текущая цена подписки. Опции продукта, цены поставщика, валюты и пропорциональности никогда не принимаются из браузера. Локальные права и кредиты меняются только после того, как прогнозируется событие с проверенным поставщиком.

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

Создайте сессию клиентского портала

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

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

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

Параметры

Idempotency-Key · header · необходимый

Схема
Схема
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

Ответы

201 Сеанс клиентского портала Stripe

Ответ 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 сохраняет подписку. Обновление прав после проверенного события подписки Stripe. Эта конечная точка никогда не отменяет немедленно или не возвращает деньги.

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

List Stripe Invoice Projections

Аутентификация: 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 · необязательный

Источник, предоставленный этому ключу; не читать все предоставленные источники.

Схема

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. От инклюзивного к эксклюзивному; Оба они округлены до нескольких минут. От одного, до дефолтов, от + 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

Отправьте запрос на пробный кредит на один срок жизни

Размер пробы и пример использования сохраняются при подаче запроса.

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

Список сохраненных записей Callback URLsQ

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

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

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

Ответы

200 Обсуждение Callback URLs

Ответ 200 · application/json

DeliveryWebhook

Ответ 200
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DeliveryWebhook"
      }
    }
  }
}

401 Требуемая или недействительная аутентификация

Ответ 401 · application/problem+json

Problem

Ответ 401
{
  "$ref": "#/components/schemas/Problem"
}
POST/delivery/webhooks

Скачать Callback 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}

Скачать Callback 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 и асинхронизация · Запросы 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}

Прочитать одну работу Data 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 Ни application/json, ни text/plain не приемлемы; ответ JSON

Ответ 406 · application/json

QueryRepresentationError

Ответ 406
{
  "$ref": "#/components/schemas/QueryRepresentationError"
}
GET/jobs/{jobId}/results

Скачать завершенный результат асинхронизации

По умолчанию аутентифицирует доступ и перенаправляет на недолговечный частный R2 URL; клиенты получают оригинальный JSON непосредственно от R2. Accept: text/plain самостоятельно возвращает HTTP 200 с исходными полями результатов в виде вложенного простого текста. X-Respond-With: Markdown выбирает контент 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 Ни application/json, ни text/plain не приемлемы; ответ JSON

Ответ 406 · application/json

QueryRepresentationError

Ответ 406
{
  "$ref": "#/components/schemas/QueryRepresentationError"
}

409 Конфликт состояния ресурсов или идемпотентности

Ответ 409 · application/problem+json

Problem

Ответ 409
{
  "$ref": "#/components/schemas/Problem"
}

410 Результат истек

Ответ 410 · application/problem+json

Problem

Ответ 410
{
  "$ref": "#/components/schemas/Problem"
}

422 Задание завершилось с ошибкой. Если причина ошибки сохранена, она указана в поле detail ответа.

Ответ 422 · application/problem+json

Problem

Ответ 422
{
  "$ref": "#/components/schemas/Problem"
}

503 Необходимая зависимость или каталог временно недоступны

Ответ 503 · application/problem+json

Problem

Ответ 503
{
  "$ref": "#/components/schemas/Problem"
}

API обработки Bulk

Конечные точки Bulk имеют специальную ссылку с параметрами, примерами запросов и схемами ответов. Открытая обработка Bulk API

игровая площадка

POST/playground/run

Запустите запрос игровой площадки в качестве текущего рабочего пространства

Аутентификация: 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 Реакция Upstream Data 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."
    }
  }
}