コンテンツへスキップ
JA
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

Opaque Webセッション。 ブラウザは、このクッキーを読み込むことができません。

csrfToken

X-CSRF-Token · header

apiKey

agentRegistrationProof

暗号的にランダムな32-バイトベース64urlの証拠と正確な要求BEFORE送信;同じ証拠と体だけを回復. 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}

アプリの承認リクエストを読んで、現在のセッションにバインドします

完全なセッションが必要です。 10分以内に期限が切れるリクエスト 応答は無店です。

認証: cookieSession

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

パラメーター

requestId · path · 必須条件

シェムリアップ
シェムリアップ
{
  "type": "string",
  "pattern": "^fdo_[A-Za-z0-9_-]{43}$"
}

対応機種

200 リクエストされたアプリの権限

200応答 · application/json

OAuthConsent

200応答
{
  "$ref": "#/components/schemas/OAuthConsent"
}

401 認証が必要または無効

401応答 · application/problem+json

Problem

401応答
{
  "$ref": "#/components/schemas/Problem"
}

403 認証が許可されていないか、CSRFの検証が失敗しました

403応答 · application/problem+json

Problem

403応答
{
  "$ref": "#/components/schemas/Problem"
}

410 期限切れ、使用、または別のセッションにバインドするリクエスト

410応答 · application/problem+json

Problem

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

アプリの承認要求を承認または拒否

完全なセッション、CSRFおよび許可された起源は要求しました。 一度リクエストを消費します。 応答は無店です。

認証: cookieSession + csrfToken

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

パラメーター

requestId · path · 必須条件

シェムリアップ
シェムリアップ
{
  "type": "string",
  "pattern": "^fdo_[A-Za-z0-9_-]{43}$"
}

リクエストボディ・ · 必須条件

シェムリアップ · application/json
シェムリアップ
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "decision"
  ],
  "properties": {
    "decision": {
      "type": "string",
      "enum": [
        "approve",
        "deny"
      ]
    }
  }
}

対応機種

200 コードまたはデニアル、状態、発行者とクライアントコールバックを登録

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

401 認証が必要または無効

401応答 · application/problem+json

Problem

401応答
{
  "$ref": "#/components/schemas/Problem"
}

403 認証が許可されていないか、CSRFの検証が失敗しました

403応答 · application/problem+json

Problem

403応答
{
  "$ref": "#/components/schemas/Problem"
}

410 許可申請が不在; 新規接続を開始

410応答 · application/problem+json

Problem

410応答
{
  "$ref": "#/components/schemas/Problem"
}

422 リクエストの検証が失敗しました

422応答 · application/problem+json

Problem

422応答
{
  "$ref": "#/components/schemas/Problem"
}
POST/auth/register

保留中のFlashDataアカウントを作成する

提出された利用規約とプライバシーバージョンは、現在の公開された法的バンドルと一致しなければなりません。

認証: パブリック

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

リクエストボディ・ · 必須条件

シェムリアップ · application/json

RegisterRequest

シェムリアップ
{
  "$ref": "#/components/schemas/RegisterRequest"
}

対応機種

201 作成されるアカウント; 電子メールの検証が必要

ヘッダー: Cache-Control, X-Request-Id

201応答 · application/json

RegisterResponse

201応答
{
  "$ref": "#/components/schemas/RegisterResponse"
}

409 リソースの状態または不在の競合

409応答 · application/problem+json

Problem

409応答
{
  "$ref": "#/components/schemas/Problem"
}

422 リクエストの検証が失敗しました

422応答 · application/problem+json

Problem

422応答
{
  "$ref": "#/components/schemas/Problem"
}

429 レート、通貨、バッチ、または保留ジョブの制限が超過

ヘッダー: Retry-After

429応答 · application/problem+json

Problem

429応答
{
  "$ref": "#/components/schemas/Problem"
}

500 予期しない内部エラーが発生しました

500応答 · application/problem+json

Problem

500応答
{
  "$ref": "#/components/schemas/Problem"
}

503 必要な依存性やカタログは一時的に利用できません。

503応答 · application/problem+json

Problem

503応答
{
  "$ref": "#/components/schemas/Problem"
}
POST/auth/login

不透明なWebセッションを作成する

セキュアなHttpOnly `__Host-fd_session`クッキーを設定します。 エンドアカウント 検証ダッシュボードの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 セッションを回収し、クッキーをクリア

ヘッダー: 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を運ぶ許可されたオリジンリクエストは、同じ検証されたアカウントの回転セッションクッキーを受け取ることができます。 検証トークンは、ユーザーだけでは署名しません。

認証: パブリック

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

リクエストボディ・ · 必須条件

シェムリアップ · application/json

TokenRequest

シェムリアップ
{
  "$ref": "#/components/schemas/TokenRequest"
}

対応機種

200 活動化したアカウント

ヘッダー: Set-Cookie, Cache-Control, X-Request-Id

200応答 · application/json

Account

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

410 ワンタイムトークンは無効、期限切れ、無効化、既に使用済み、または同時確認レースを紛失します。 Problem.codeは`token_unavailable`です。

ヘッダー: Cache-Control, X-Request-Id

410応答 · application/problem+json

Problem

410応答
{
  "$ref": "#/components/schemas/Problem"
}

422 匿名認証の検証リクエストが失敗しました

ヘッダー: Cache-Control, X-Request-Id

422応答 · application/problem+json

Problem

422応答
{
  "$ref": "#/components/schemas/Problem"
}

429 匿名認証率制限が超過

ヘッダー: Cache-Control, Retry-After, X-Request-Id

429応答 · application/problem+json

Problem

429応答
{
  "$ref": "#/components/schemas/Problem"
}

500 予期しない匿名認証エラーが発生しました

ヘッダー: Cache-Control, X-Request-Id

500応答 · application/problem+json

Problem

500応答
{
  "$ref": "#/components/schemas/Problem"
}

503 匿名認証の依存性は一時的に利用できません。

ヘッダー: Cache-Control, X-Request-Id

503応答 · application/problem+json

Problem

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

電子メール確認後、元のサインアップセッションを続行

許可されたオリジンとCSRFトークンは、ライブパスワードで認証されたメール検証セッションにバインドします。 セッション自身のアカウントが検証されるまで、別のブラウザで検証を含む保留期間を返します。 基本的には、サインアップセッションを呼び返し、新鮮なフルまたは法的な受容セッションを発行します。 ID、Eメール、パスワード、認証トークンは、法的受諾を迂回したり、クレジットを付与したりすることはできません。

認証: cookieSession + csrfToken

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

リクエストボディ・ · 必須条件

シェムリアップ · application/json
シェムリアップ
{
  "type": "object",
  "additionalProperties": false
}

対応機種

200 サインアップセッションが回転しました

ヘッダー: Set-Cookie, Cache-Control

200応答 · application/json

LoginResponse

200応答
{
  "$ref": "#/components/schemas/LoginResponse"
}

202 電子メールの検証は終了です。新しいセッションはありません。

ヘッダー: Cache-Control

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

401 認証が必要または無効

401応答 · application/problem+json

Problem

401応答
{
  "$ref": "#/components/schemas/Problem"
}

403 認証が許可されていないか、CSRFの検証が失敗しました

403応答 · application/problem+json

Problem

403応答
{
  "$ref": "#/components/schemas/Problem"
}

422 リクエストの検証が失敗しました

422応答 · application/problem+json

Problem

422応答
{
  "$ref": "#/components/schemas/Problem"
}

500 予期しない内部エラーが発生しました

500応答 · application/problem+json

Problem

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

パスワードリセットメールをリクエストする

常に同じ 202 応答をアカウントの存在やライフサイクルの状態に関係なく、 有効 電子メールで返します。 有効またはロックされたアイデンティティのみがメールを受信します。

認証: パブリック

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

リクエストボディ・ · 必須条件

シェムリアップ · application/json
シェムリアップ
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "email"
  ],
  "properties": {
    "email": {
      "type": "string",
      "format": "email",
      "maxLength": 320
    }
  }
}

対応機種

202 リクエストは受け付けています。 応答は、アカウントが存在するかどうかを明らかにしません。

ヘッダー: Cache-Control, X-Request-Id

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

422 匿名認証の検証リクエストが失敗しました

ヘッダー: Cache-Control, X-Request-Id

422応答 · application/problem+json

Problem

422応答
{
  "$ref": "#/components/schemas/Problem"
}

429 匿名認証率制限が超過

ヘッダー: Cache-Control, Retry-After, X-Request-Id

429応答 · application/problem+json

Problem

429応答
{
  "$ref": "#/components/schemas/Problem"
}

500 予期しない匿名認証エラーが発生しました

ヘッダー: Cache-Control, X-Request-Id

500応答 · application/problem+json

Problem

500応答
{
  "$ref": "#/components/schemas/Problem"
}

503 匿名認証の依存性は一時的に利用できません。

ヘッダー: Cache-Control, X-Request-Id

503応答 · application/problem+json

Problem

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

新しいパスワードを設定し、既存のセッションを刷新

基本的にパスワードリセットトークンを消費し、新しいArgon2idクレデンシャルを格納し、既存のセッションをすべて取り消し、他のパスワードリセットトークンを無効化します。 ユーザーのログインやセッションの作成は行いません。

認証: パブリック

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

リクエストボディ・ · 必須条件

シェムリアップ · application/json

Password

シェムリアップ
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "token",
    "password"
  ],
  "properties": {
    "token": {
      "type": "string",
      "minLength": 32,
      "maxLength": 256,
      "writeOnly": true
    },
    "password": {
      "$ref": "#/components/schemas/Password"
    }
  }
}

対応機種

204 パスワードが更新されました。既存のセッションが再発されました

ヘッダー: Cache-Control, X-Request-Id

410 ワンタイムトークンは無効、期限切れ、無効化、既に使用済み、または同時確認レースを紛失します。 Problem.codeは`token_unavailable`です。

ヘッダー: Cache-Control, X-Request-Id

410応答 · application/problem+json

Problem

410応答
{
  "$ref": "#/components/schemas/Problem"
}

422 匿名認証の検証リクエストが失敗しました

ヘッダー: Cache-Control, X-Request-Id

422応答 · application/problem+json

Problem

422応答
{
  "$ref": "#/components/schemas/Problem"
}

429 匿名認証率制限が超過

ヘッダー: Cache-Control, Retry-After, X-Request-Id

429応答 · application/problem+json

Problem

429応答
{
  "$ref": "#/components/schemas/Problem"
}

500 予期しない匿名認証エラーが発生しました

ヘッダー: Cache-Control, X-Request-Id

500応答 · application/problem+json

Problem

500応答
{
  "$ref": "#/components/schemas/Problem"
}

503 匿名認証の依存性は一時的に利用できません。

ヘッダー: Cache-Control, X-Request-Id

503応答 · application/problem+json

Problem

503応答
{
  "$ref": "#/components/schemas/Problem"
}
GET/auth/sessions

現在のユーザのアクティブなセッションをリストする

認証: cookieSession

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

対応機種

200 セッション

ヘッダー: Cache-Control, X-Request-Id

200応答 · application/json

Session

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

401 認証が必要または無効

401応答 · application/problem+json

Problem

401応答
{
  "$ref": "#/components/schemas/Problem"
}
DELETE/auth/sessions

現在のセッションを除くすべてのセッションを再実行する

認証: cookieSession + csrfToken

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

対応機種

204 その他のセッションが再発

ヘッダー: Cache-Control, X-Request-Id

401 認証が必要または無効

401応答 · application/problem+json

Problem

401応答
{
  "$ref": "#/components/schemas/Problem"
}

403 認証が許可されていないか、CSRFの検証が失敗しました

403応答 · application/problem+json

Problem

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

1つのセッションを再実行する

認証: cookieSession + csrfToken

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

パラメーター

sessionId · path · 必須条件

シェムリアップ
シェムリアップ
{
  "type": "string",
  "pattern": "^ses_"
}

対応機種

204 セッションが再発しました。 現在のセッションだった場合、クッキーは消去されます。

ヘッダー: Set-Cookie, Cache-Control, X-Request-Id

401 認証が必要または無効

401応答 · application/problem+json

Problem

401応答
{
  "$ref": "#/components/schemas/Problem"
}

403 認証が許可されていないか、CSRFの検証が失敗しました

403応答 · application/problem+json

Problem

403応答
{
  "$ref": "#/components/schemas/Problem"
}

404 発信者によって発見されていない、または所有されていないリソース

404応答 · application/problem+json

Problem

404応答
{
  "$ref": "#/components/schemas/Problem"
}

409 リソースの状態または不在の競合

409応答 · application/problem+json

Problem

409応答
{
  "$ref": "#/components/schemas/Problem"
}

422 リクエストの検証が失敗しました

422応答 · application/problem+json

Problem

422応答
{
  "$ref": "#/components/schemas/Problem"
}

503 必要な依存性やカタログは一時的に利用できません。

503応答 · application/problem+json

Problem

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

機密操作のための現在のパスワードを確認します。

現在のサーバー側のセッションで、短命の最近の認証を録音します。

認証: cookieSession + csrfToken

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

リクエストボディ・ · 必須条件

シェムリアップ · application/json
シェムリアップ
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "password"
  ],
  "properties": {
    "password": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "writeOnly": true
    }
  }
}

対応機種

200 セッションは、最近の認証

ヘッダー: Cache-Control, X-Request-Id

200応答 · application/json

Reauthentication

200応答
{
  "$ref": "#/components/schemas/Reauthentication"
}

401 認証が必要または無効

401応答 · application/problem+json

Problem

401応答
{
  "$ref": "#/components/schemas/Problem"
}

403 認証が許可されていないか、CSRFの検証が失敗しました

403応答 · application/problem+json

Problem

403応答
{
  "$ref": "#/components/schemas/Problem"
}

429 レート、通貨、バッチ、または保留ジョブの制限が超過

ヘッダー: Retry-After

429応答 · application/problem+json

Problem

429応答
{
  "$ref": "#/components/schemas/Problem"
}
PATCH/auth/password

パスワードを変更し、現在のセッションを回転させる

認証: cookieSession + csrfToken

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

リクエストボディ・ · 必須条件

シェムリアップ · application/json

Password

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

対応機種

204 パスワードが変更されました。 リクエストされたときに、現在のセッションが回転し、他のセッションが再発されます。

ヘッダー: Set-Cookie, Cache-Control, X-Request-Id

401 認証が必要または無効

401応答 · application/problem+json

Problem

401応答
{
  "$ref": "#/components/schemas/Problem"
}

403 認証が許可されていないか、CSRFの検証が失敗しました

403応答 · application/problem+json

Problem

403応答
{
  "$ref": "#/components/schemas/Problem"
}

422 リクエストの検証が失敗しました

422応答 · application/problem+json

Problem

422応答
{
  "$ref": "#/components/schemas/Problem"
}

会員アカウント

GET/oauth/connections

現在のアカウントのコネクティッドアプリを一覧表示する

完全なセッションが必要です。 アカウントがコネクティッドなアプリがないときに空にしてください。 応答は無店です。

認証: cookieSession

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

対応機種

200 Connected appsの特長

200応答 · application/json

OAuthConnection

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

401 認証が必要または無効

401応答 · application/problem+json

Problem

401応答
{
  "$ref": "#/components/schemas/Problem"
}

403 認証が許可されていないか、CSRFの検証が失敗しました

403応答 · application/problem+json

Problem

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

接続されたアプリと専用のAPIキーを再読み込み

完全なセッション、CSRFおよび許可された起源は要求しました。 口座の所有権が強化されています。 応答は無店です。

認証: cookieSession + csrfToken

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

パラメーター

grantId · path · 必須条件

シェムリアップ
シェムリアップ
{
  "type": "string",
  "pattern": "^oag_[A-Za-z0-9_-]{8,}$"
}

対応機種

204 認可取得

401 認証が必要または無効

401応答 · application/problem+json

Problem

401応答
{
  "$ref": "#/components/schemas/Problem"
}

403 認証が許可されていないか、CSRFの検証が失敗しました

403応答 · application/problem+json

Problem

403応答
{
  "$ref": "#/components/schemas/Problem"
}

404 発信者によって発見されていない、または所有されていないリソース

404応答 · application/problem+json

Problem

404応答
{
  "$ref": "#/components/schemas/Problem"
}
GET/account

アカウント設定を読む

認証: cookieSession

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

対応機種

200 会員アカウント

200応答 · application/json

Account

200応答
{
  "$ref": "#/components/schemas/Account"
}

401 認証が必要または無効

401応答 · application/problem+json

Problem

401応答
{
  "$ref": "#/components/schemas/Problem"
}
PATCH/account

プロフィール設定の更新

認証: cookieSession + csrfToken

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

リクエストボディ・ · 必須条件

シェムリアップ · application/json

UpdateAccountRequest

シェムリアップ
{
  "$ref": "#/components/schemas/UpdateAccountRequest"
}

対応機種

200 更新されたアカウント

200応答 · application/json

Account

200応答
{
  "$ref": "#/components/schemas/Account"
}

401 認証が必要または無効

401応答 · application/problem+json

Problem

401応答
{
  "$ref": "#/components/schemas/Problem"
}

403 認証が許可されていないか、CSRFの検証が失敗しました

403応答 · application/problem+json

Problem

403応答
{
  "$ref": "#/components/schemas/Problem"
}

422 リクエストの検証が失敗しました

422応答 · application/problem+json

Problem

422応答
{
  "$ref": "#/components/schemas/Problem"
}
DELETE/account

スケジュールアカウントの削除と、既存のセッションとAPI Keysを全て削除

管理者アカウントには、削除前に監査されたオペレータワークフローを通じて、プラットフォームの役割を再取得する必要があります。 独自のアクティブ削除リクエストは、自然出土境界です。 同時認証のスケジュールは同じリクエストを返します。 セッションの再開後、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

猶予期間中にスケジュールされた削除をキャンセル

スケジュールされた対cancelledの比較およびセットを使用して下さい。 プロセッサのレースは、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 公開中の利用規約とプライバシーバージョン

不当な法的受諾を申し立て、マイグレーションゲートをクリアし、セッションを回転させます。 投稿されたバージョンのStaleは拒否されます。

認証: cookieSession + csrfToken

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

リクエストボディ・ · 必須条件

シェムリアップ · application/json

LegalAcceptanceRequest

シェムリアップ
{
  "$ref": "#/components/schemas/LegalAcceptanceRequest"
}

対応機種

200 法的受諾記録とセッションがフルモードに回転

ヘッダー: Set-Cookie, Cache-Control, X-Request-Id

200応答 · application/json

LoginResponse

200応答
{
  "$ref": "#/components/schemas/LoginResponse"
}

401 認証が必要または無効

401応答 · application/problem+json

Problem

401応答
{
  "$ref": "#/components/schemas/Problem"
}

403 認証が許可されていないか、CSRFの検証が失敗しました

403応答 · application/problem+json

Problem

403応答
{
  "$ref": "#/components/schemas/Problem"
}

404 発信者によって発見されていない、または所有されていないリソース

404応答 · application/problem+json

Problem

404応答
{
  "$ref": "#/components/schemas/Problem"
}

422 リクエストの検証が失敗しました

422応答 · application/problem+json

Problem

422応答
{
  "$ref": "#/components/schemas/Problem"
}

オンボーディング

GET/onboarding

再開可能なオンボーディングの進行状況を読む

認証: cookieSession

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

対応機種

200 現在のオンボーディング状態

ヘッダー: Cache-Control, X-Request-Id

200応答 · application/json

OnboardingProgress

200応答
{
  "$ref": "#/components/schemas/OnboardingProgress"
}

401 認証が必要または無効

ヘッダー: Cache-Control, X-Request-Id

401応答 · application/problem+json

Problem

401応答
{
  "$ref": "#/components/schemas/Problem"
}

500 予期しない内部エラーが発生しました

ヘッダー: Cache-Control, X-Request-Id

500応答 · application/problem+json

Problem

500応答
{
  "$ref": "#/components/schemas/Problem"
}

503 必要な依存関係やオンボーディングレコードは一時的に利用できません。

ヘッダー: Cache-Control, X-Request-Id

503応答 · application/problem+json

Problem

503応答
{
  "$ref": "#/components/schemas/Problem"
}
PATCH/onboarding

前進を後方に動かすことを可能にすることなく、アドバンスのオンボーディング

認証: cookieSession + csrfToken

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

リクエストボディ・ · 必須条件

シェムリアップ · application/json

UpdateOnboardingRequest

シェムリアップ
{
  "$ref": "#/components/schemas/UpdateOnboardingRequest"
}

対応機種

200 オンボーディング状態の更新

ヘッダー: Cache-Control, X-Request-Id

200応答 · application/json

OnboardingProgress

200応答
{
  "$ref": "#/components/schemas/OnboardingProgress"
}

401 認証が必要または無効

ヘッダー: Cache-Control, X-Request-Id

401応答 · application/problem+json

Problem

401応答
{
  "$ref": "#/components/schemas/Problem"
}

403 認証が許可されていないか、CSRFの検証が失敗しました

ヘッダー: Cache-Control, X-Request-Id

403応答 · application/problem+json

Problem

403応答
{
  "$ref": "#/components/schemas/Problem"
}

409 リソースの状態または不在の競合

ヘッダー: Cache-Control, X-Request-Id

409応答 · application/problem+json

Problem

409応答
{
  "$ref": "#/components/schemas/Problem"
}

422 リクエストの検証が失敗しました

ヘッダー: Cache-Control, X-Request-Id

422応答 · application/problem+json

Problem

422応答
{
  "$ref": "#/components/schemas/Problem"
}

500 予期しない内部エラーが発生しました

ヘッダー: Cache-Control, X-Request-Id

500応答 · application/problem+json

Problem

500応答
{
  "$ref": "#/components/schemas/Problem"
}

503 必要な依存関係やオンボーディングレコードは一時的に利用できません。

ヘッダー: Cache-Control, X-Request-Id

503応答 · application/problem+json

Problem

503応答
{
  "$ref": "#/components/schemas/Problem"
}

概要

GET/overview

アカウントダッシュボードの集計を読む

認証: cookieSession

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

対応機種

200 アカウントスコープの概要

ヘッダー: Cache-Control, X-Request-Id

200応答 · application/json

ConsoleOverview

200応答
{
  "$ref": "#/components/schemas/ConsoleOverview"
}

401 認証が必要または無効

ヘッダー: Cache-Control, X-Request-Id

401応答 · application/problem+json

Problem

401応答
{
  "$ref": "#/components/schemas/Problem"
}

500 予期しない内部エラーが発生しました

ヘッダー: Cache-Control, X-Request-Id

500応答 · application/problem+json

Problem

500応答
{
  "$ref": "#/components/schemas/Problem"
}

503 必要な依存関係やオンボーディングレコードは一時的に利用できません。

ヘッダー: Cache-Control, X-Request-Id

503応答 · application/problem+json

Problem

503応答
{
  "$ref": "#/components/schemas/Problem"
}

API Keysの特長

GET/api-access/identity

現在の API 鍵の所有権と再発の信頼性を検証

無料ヘッダーのみ API-key 読み込み。 account/key IDs および権威所有権を返す。 ボディ無し。要求 既存の/api-accessメタデータ応答を変更しません。 120/minuteアカウント読み取り制限をシェアします。 不当性はクローズされます。キープレフィックス、プラン、またはローカルの状態から所有権を侵害しないでください。 クエリパラメータは受け付けられません。 応答は保存されません。

認証: dataApiKey

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

対応機種

200 現在の API 鍵の所有権と再発の信頼性を検証

200応答 · application/json

APIKeyIdentity

200応答
{
  "$ref": "#/components/schemas/APIKeyIdentity"
}

400 拒否された要求;問題コードを点検して下さい。 決して失明に突然変異を繰り返しません。

400応答 · application/problem+json

Problem

400応答
{
  "$ref": "#/components/schemas/Problem"
}

401 拒否された要求;問題コードを点検して下さい。 決して失明に突然変異を繰り返しません。

401応答 · application/problem+json

Problem

401応答
{
  "$ref": "#/components/schemas/Problem"
}

403 拒否された要求;問題コードを点検して下さい。 決して失明に突然変異を繰り返しません。

403応答 · application/problem+json

Problem

403応答
{
  "$ref": "#/components/schemas/Problem"
}

409 拒否された要求;問題コードを点検して下さい。 決して失明に突然変異を繰り返しません。

409応答 · application/problem+json

Problem

409応答
{
  "$ref": "#/components/schemas/Problem"
}

410 拒否された要求;問題コードを点検して下さい。 決して失明に突然変異を繰り返しません。

410応答 · application/problem+json

Problem

410応答
{
  "$ref": "#/components/schemas/Problem"
}

422 拒否された要求;問題コードを点検して下さい。 決して失明に突然変異を繰り返しません。

422応答 · application/problem+json

Problem

422応答
{
  "$ref": "#/components/schemas/Problem"
}

429 拒否された要求;問題コードを点検して下さい。 決して失明に突然変異を繰り返しません。

429応答 · application/problem+json

Problem

429応答
{
  "$ref": "#/components/schemas/Problem"
}

503 拒否された要求;問題コードを点検して下さい。 決して失明に突然変異を繰り返しません。

503応答 · application/problem+json

Problem

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

APIキーメタデータ

認証: cookieSession

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

対応機種

200 秘密のないAPI Keys

200応答 · application/json

ApiKey

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

401 認証が必要または無効

401応答 · application/problem+json

Problem

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

APIキーを作成し、その秘密を一度に明らかにする

認証: cookieSession + csrfToken

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

パラメーター

Idempotency-Key · header · 必須条件

シェムリアップ
シェムリアップ
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

リクエストボディ・ · 必須条件

シェムリアップ · application/json

CreateApiKeyRequest

シェムリアップ
{
  "$ref": "#/components/schemas/CreateApiKeyRequest"
}

対応機種

201 作成; 同一の idempotent 再生は 5 分間同じ暗号化された応答を返すかもしれません

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は、7日以内に、旧鍵の有効期限よりも、将来的には必要です。

認証: 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 はクライアント IP ごとの分ごとの 120 要求を共有し、戻ります Cache-Control プライベート、非ストア。 通常のキーの最終使用追跡はまだ起こります。

認証: 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クレジット、72時間、1 request/second、バッチサイズ1。 ソーススコープの制限は、サーバー上での権限を維持します。 クエリパラメータは受け付けられません。 応答は保存されません。 エージェントのルートは管理のみで、機能が付与されます。 デプロイメントは、無効にすると404を返すことができます。 X-API-Keyはエージェントのルートに禁止されています。

認証: agentRegistrationProof

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

リクエストボディ・ · 必須条件

シェムリアップ · application/json

AgentRegistrationRequest

シェムリアップ
{
  "$ref": "#/components/schemas/AgentRegistrationRequest"
}

対応機種

201 一時的なAPIキー接続を作成または回復する

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のWebの起源で開き、コードを別に表示して下さい。 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

Acknowledge検証オーナーキーインストール

すでに候補者を保存し、独立して新鮮なプロセスでそれを検証する必要があります。 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 Acknowledge検証オーナーキーインストール

200応答 · application/json

AgentHandoff

200応答
{
  "$ref": "#/components/schemas/AgentHandoff"
}

400 拒否された要求;問題コードを点検して下さい。 決して失明に突然変異を繰り返しません。

400応答 · application/problem+json

Problem

400応答
{
  "$ref": "#/components/schemas/Problem"
}

401 拒否された要求;問題コードを点検して下さい。 決して失明に突然変異を繰り返しません。

401応答 · application/problem+json

Problem

401応答
{
  "$ref": "#/components/schemas/Problem"
}

403 拒否された要求;問題コードを点検して下さい。 決して失明に突然変異を繰り返しません。

403応答 · application/problem+json

Problem

403応答
{
  "$ref": "#/components/schemas/Problem"
}

409 拒否された要求;問題コードを点検して下さい。 決して失明に突然変異を繰り返しません。

409応答 · application/problem+json

Problem

409応答
{
  "$ref": "#/components/schemas/Problem"
}

410 拒否された要求;問題コードを点検して下さい。 決して失明に突然変異を繰り返しません。

410応答 · application/problem+json

Problem

410応答
{
  "$ref": "#/components/schemas/Problem"
}

422 拒否された要求;問題コードを点検して下さい。 決して失明に突然変異を繰り返しません。

422応答 · application/problem+json

Problem

422応答
{
  "$ref": "#/components/schemas/Problem"
}

429 拒否された要求;問題コードを点検して下さい。 決して失明に突然変異を繰り返しません。

429応答 · application/problem+json

Problem

429応答
{
  "$ref": "#/components/schemas/Problem"
}

503 拒否された要求;問題コードを点検して下さい。 決して失明に突然変異を繰り返しません。

503応答 · application/problem+json

Problem

503応答
{
  "$ref": "#/components/schemas/Problem"
}

カタログ

GET/catalog/sources

アカウント固有の価格設定なしで公開ソース機能をリストする

認証: パブリック

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

対応機種

200 パブリック ソース カタログ

ヘッダー: Cache-Control

200応答 · application/json

DataSource

200応答
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DataSource"
      }
    }
  }
}
GET/plans

公開USDの計画と価格をリスト

認証: パブリック

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

対応機種

200 パブリックプランカタログ

ヘッダー: Cache-Control

200応答 · application/json

PlanCatalog

200応答
{
  "$ref": "#/components/schemas/PlanCatalog"
}
GET/legal/current

サインアップに必要な現在の利用規約とプライバシーバージョンを読みます

認証: パブリック

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

対応機種

200 現在の法的バージョンのカタログ

ヘッダー: Cache-Control

200応答 · application/json

PublicLegalVersions

200応答
{
  "$ref": "#/components/schemas/PublicLegalVersions"
}

Billingの特長

GET/billing/subscription

効果的な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

ストライプ・ホスト・チェックアウト・セッションを作成する

サブスクリプションおよび公開されたクレジットパックは、priceIdを使用します。 カスタムのトップアップは、代わりにamountMinorを使用します (USDセント、$10を$ 999,999.99)。 サーバは、固定クレジット値でクレジットを計算し、プライベートワンタイムストライプ価格を作成します。 製品、提供者価格、通貨、成功URLおよびキャンセルURLはブラウザから受け入れられません。 クレジットは、見積金額の検証済みの有料イベントの後にのみ付与されます。

認証: cookieSession + csrfToken

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

パラメーター

Idempotency-Key · header · 必須条件

シェムリアップ
シェムリアップ
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

リクエストボディ・ · 必須条件

シェムリアップ · application/json
シェムリアップ
{
  "oneOf": [
    {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "priceId"
      ],
      "properties": {
        "priceId": {
          "type": "string",
          "pattern": "^prc_"
        },
        "purchaseType": {
          "type": "string",
          "enum": [
            "subscription",
            "top_up"
          ],
          "default": "subscription"
        }
      }
    },
    {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "amountMinor",
        "purchaseType"
      ],
      "properties": {
        "amountMinor": {
          "type": "integer",
          "minimum": 1000,
          "maximum": 99999999,
          "description": "Custom top-up amount in USD cents."
        },
        "purchaseType": {
          "type": "string",
          "const": "top_up"
        }
      }
    }
  ]
}

対応機種

201 ストライプチェックアウトセッション

201応答 · application/json

HostedSession

201応答
{
  "$ref": "#/components/schemas/HostedSession"
}

401 認証が必要または無効

401応答 · application/problem+json

Problem

401応答
{
  "$ref": "#/components/schemas/Problem"
}

403 認証が許可されていないか、CSRFの検証が失敗しました

403応答 · application/problem+json

Problem

403応答
{
  "$ref": "#/components/schemas/Problem"
}

409 リソースの状態または不在の競合

409応答 · application/problem+json

Problem

409応答
{
  "$ref": "#/components/schemas/Problem"
}

422 リクエストの検証が失敗しました

422応答 · application/problem+json

Problem

422応答
{
  "$ref": "#/components/schemas/Problem"
}

502 上流プロバイダが失敗しました

502応答 · application/problem+json

Problem

502応答
{
  "$ref": "#/components/schemas/Problem"
}

503 請求カタログまたはプロバイダは、構成されていないか、一時的に利用できません。

503応答 · application/problem+json

Problem

503応答
{
  "$ref": "#/components/schemas/Problem"
}
POST/billing/subscription-changes

現在のStripeサブスクリプションをより高い公開価格にアップグレードする

サーバは、FlashData価格がアクティブであることを検証します, 現在のライブモードで利用可能, USD-denominated, 再発, 同じ間隔, そして、厳密に現在のサブスクリプション価格よりも高価. 製品、プロバイダ価格、通貨、およびプロレーションオプションは、ブラウザから受け入れられません。 ローカルの資格とクレジットは、検証済みのプロバイダイベントが進行した後にのみ変更されます。

認証: 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 ストライプカスタマーポータルセッション

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 ストライプに提出されたキャンセル更新

202応答 · application/json

SubscriptionCancellationChange

202応答
{
  "$ref": "#/components/schemas/SubscriptionCancellationChange"
}

401 認証が必要または無効

401応答 · application/problem+json

Problem

401応答
{
  "$ref": "#/components/schemas/Problem"
}

403 認証が許可されていないか、CSRFの検証が失敗しました

403応答 · application/problem+json

Problem

403応答
{
  "$ref": "#/components/schemas/Problem"
}

404 発信者によって発見されていない、または所有されていないリソース

404応答 · application/problem+json

Problem

404応答
{
  "$ref": "#/components/schemas/Problem"
}

409 リソースの状態または不在の競合

409応答 · application/problem+json

Problem

409応答
{
  "$ref": "#/components/schemas/Problem"
}

422 リクエストの検証が失敗しました

422応答 · application/problem+json

Problem

422応答
{
  "$ref": "#/components/schemas/Problem"
}

502 上流プロバイダが失敗しました

502応答 · application/problem+json

Problem

502応答
{
  "$ref": "#/components/schemas/Problem"
}

503 請求カタログまたはプロバイダは、構成されていないか、一時的に利用できません。

503応答 · application/problem+json

Problem

503応答
{
  "$ref": "#/components/schemas/Problem"
}
GET/billing/invoices

リスト ストライプインボイスの投影

認証: cookieSession

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

パラメーター

cursor · query · オプション

シェムリアップ
シェムリアップ
{
  "type": "string",
  "maxLength": 512
}

limit · query · オプション

シェムリアップ
シェムリアップ
{
  "type": "integer",
  "minimum": 1,
  "maximum": 100,
  "default": 50
}

対応機種

200 インボイス

200応答 · application/json

Invoice · Page

200応答
{
  "allOf": [
    {
      "$ref": "#/components/schemas/Page"
    },
    {
      "type": "object",
      "properties": {
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Invoice"
          }
        }
      }
    }
  ]
}

401 認証が必要または無効

401応答 · application/problem+json

Problem

401応答
{
  "$ref": "#/components/schemas/Problem"
}
GET/billing/payments

リストアカウントスコープ付きトップアップと返金支払いの予測

認証: cookieSession

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

パラメーター

cursor · query · オプション

シェムリアップ
シェムリアップ
{
  "type": "string",
  "maxLength": 512
}

limit · query · オプション

シェムリアップ
シェムリアップ
{
  "type": "integer",
  "minimum": 1,
  "maximum": 100,
  "default": 50
}

対応機種

200 プロバイダーの秘密のないワンタイム決済履歴

200応答 · application/json

BillingPaymentPage

200応答
{
  "$ref": "#/components/schemas/BillingPaymentPage"
}

401 認証が必要または無効

401応答 · application/problem+json

Problem

401応答
{
  "$ref": "#/components/schemas/Problem"
}

クレジット

GET/api-access/balance

APIキーを使用してライブアカウント残高を読みます

すべてのAPIキーで共有された現在のクレジット残高をアカウントで読みます。 アクティブな予約は、利用可能な残高を減らすことができます。 リクエストが不要で、クエリパラメータやボディが不要です。 レスポンスはプライベートでキャッシュされず、アカウント読み取り率の制限が適用されます。

認証: dataApiKey

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

対応機種

200 署名された残高と非負債

200応答 · application/json

ApiAccessBalance

200応答
{
  "$ref": "#/components/schemas/ApiAccessBalance"
}

401 認証が必要または無効

401応答 · application/problem+json

Problem

401応答
{
  "$ref": "#/components/schemas/Problem"
}

422 リクエストの検証が失敗しました

422応答 · application/problem+json

Problem

422応答
{
  "$ref": "#/components/schemas/Problem"
}

429 あまりにも多くのアカウントが読み込まれます。 レート制限ウィンドウの後に再試行

503 必要な依存性やカタログは一時的に利用できません。

503応答 · application/problem+json

Problem

503応答
{
  "$ref": "#/components/schemas/Problem"
}
GET/api-access/pricing

APIのキーによって承認される源のための実際のアカウントの価格を読みます

APIキーで許可されたソースのアカウント率を読みます。 null価格は、ソースが利用できなくなったことを意味します。 request_countは、返されたアイテムではなく、クエリをカウントします。 ダウンロード料金はTBあたりです(10^12バイト)。 クレジットや容量を予約しません。 クレジットの請求は不要。 レスポンスはプライベートでキャッシュされず、アカウント読み取り率の制限が適用されます。

認証: dataApiKey

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

パラメーター

source · query · オプション

このキーに付与されたソース。 omit は、すべての付与されたソースを読み込みます。

シェムリアップ

ApiAccessSource

シェムリアップ
{
  "$ref": "#/components/schemas/ApiAccessSource"
}

request_count · query · オプション

呼び出しの整数を決定;ダウンロードサイズを推定しません。

シェムリアップ
シェムリアップ
{
  "type": "integer",
  "minimum": 1,
  "maximum": 100000,
  "default": 1
}

対応機種

200 口座プランとソース固有の価格

200応答 · application/json

ApiAccessPricing

200応答
{
  "$ref": "#/components/schemas/ApiAccessPricing"
}

401 認証が必要または無効

401応答 · application/problem+json

Problem

401応答
{
  "$ref": "#/components/schemas/Problem"
}

403 認証が許可されていないか、CSRFの検証が失敗しました

403応答 · application/problem+json

Problem

403応答
{
  "$ref": "#/components/schemas/Problem"
}

422 リクエストの検証が失敗しました

422応答 · application/problem+json

Problem

422応答
{
  "$ref": "#/components/schemas/Problem"
}

429 あまりにも多くのアカウントが読み込まれます。 レート制限ウィンドウの後に再試行

503 必要な依存性やカタログは一時的に利用できません。

503応答 · application/problem+json

Problem

503応答
{
  "$ref": "#/components/schemas/Problem"
}
GET/api-access/limits

APIキーを使用してアカウントプランの制限と現在の保留ジョブを読みます

通貨、バッチサイズ、保留ジョブの制限、および現在の保留カウントをお読みください。 これらの値は、リクエストを計画するのに役立ちますが、容量を予約しません。 リクエストが不要で、クエリパラメータやボディが不要です。 レスポンスはプライベートでキャッシュされず、アカウント読み取り率の制限が適用されます。

認証: dataApiKey

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

対応機種

200 天井と現在の保留カウントを計画する

200応答 · application/json

ApiAccessLimits

200応答
{
  "$ref": "#/components/schemas/ApiAccessLimits"
}

401 認証が必要または無効

401応答 · application/problem+json

Problem

401応答
{
  "$ref": "#/components/schemas/Problem"
}

422 リクエストの検証が失敗しました

422応答 · application/problem+json

Problem

422応答
{
  "$ref": "#/components/schemas/Problem"
}

429 あまりにも多くのアカウントが読み込まれます。 レート制限ウィンドウの後に再試行

503 必要な依存性やカタログは一時的に利用できません。

503応答 · application/problem+json

Problem

503応答
{
  "$ref": "#/components/schemas/Problem"
}
GET/usage

APIのキーによって承認される源のための記述の使用法を読んで下さい

X-API-Key でしか認証されていない、無料読み込み。 すべてのアカウントキーが含まれていますが、 コールキーに付与されたソースのみ。 クエリテキスト、キー、 支払いの詳細やその他のアカウント。 デフォルトは7日間です。 31 日の最大値です。 UTC Zのタイムスタンプを使用する必要があります。 から、包括的かつ排他的です。 丸みを抜いてから数分。 単独で、+ 7の日のデフォルトに。 どちらも、次の分から始まります。 アグレゲートは、最終的に 一貫した; update=false でも、最新のイベントが摂取されていないことを保証しません。 読まれた限界:クライアントIPごとの1分ごとの60の要求。

認証: 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 Ledger エントリ

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

口座の1生涯トライアルクレジットリクエストを提出する

申請書を提出する際には、試用額とユースケースが保存されます。

認証: cookieSession + csrfToken

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

パラメーター

Idempotency-Key · header · 必須条件

シェムリアップ
シェムリアップ
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

リクエストボディ・ · オプション

シェムリアップ · application/json
シェムリアップ
{
  "type": "object",
  "additionalProperties": false
}

対応機種

201 トライアルクレジット作成リクエストと、メールプロバイダに関係なく、資格のある検証アカウントで自動的に承認

ヘッダー: Cache-Control

201応答 · application/json

TrialCreditState

201応答
{
  "$ref": "#/components/schemas/TrialCreditState"
}

401 認証が必要または無効

ヘッダー: Cache-Control, X-Request-Id

401応答 · application/problem+json

Problem

401応答
{
  "$ref": "#/components/schemas/Problem"
}

403 認証が許可されていないか、CSRFの検証が失敗しました

ヘッダー: Cache-Control, X-Request-Id

403応答 · application/problem+json

Problem

403応答
{
  "$ref": "#/components/schemas/Problem"
}

409 リソースの状態または不在の競合

ヘッダー: Cache-Control, X-Request-Id

409応答 · application/problem+json

Problem

409応答
{
  "$ref": "#/components/schemas/Problem"
}

422 リクエストの検証が失敗しました

ヘッダー: Cache-Control, X-Request-Id

422応答 · application/problem+json

Problem

422応答
{
  "$ref": "#/components/schemas/Problem"
}

500 予期しない内部エラーが発生しました

ヘッダー: Cache-Control, X-Request-Id

500応答 · application/problem+json

Problem

500応答
{
  "$ref": "#/components/schemas/Problem"
}

503 必要な依存関係やオンボーディングレコードは一時的に利用できません。

ヘッダー: Cache-Control, X-Request-Id

503応答 · application/problem+json

Problem

503応答
{
  "$ref": "#/components/schemas/Problem"
}

配送について

GET/delivery/webhooks

保存完了コールバック URLs

認証: cookieSession

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

対応機種

200 コールバック URLs

200応答 · application/json

DeliveryWebhook

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

401 認証が必要または無効

401応答 · application/problem+json

Problem

401応答
{
  "$ref": "#/components/schemas/Problem"
}
POST/delivery/webhooks

完了コールバックを保存 URL

認証: cookieSession + csrfToken

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

リクエストボディ・ · 必須条件

シェムリアップ · application/json

CreateDeliveryWebhookRequest

シェムリアップ
{
  "$ref": "#/components/schemas/CreateDeliveryWebhookRequest"
}

対応機種

201 制作実績

201応答 · application/json

DeliveryWebhook

201応答
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "webhook"
  ],
  "properties": {
    "webhook": {
      "$ref": "#/components/schemas/DeliveryWebhook"
    }
  }
}

401 認証が必要または無効

401応答 · application/problem+json

Problem

401応答
{
  "$ref": "#/components/schemas/Problem"
}

422 リクエストの検証が失敗しました

422応答 · application/problem+json

Problem

422応答
{
  "$ref": "#/components/schemas/Problem"
}
DELETE/delivery/webhooks/{webhookId}

完了コールバックを削除 URL

認証: cookieSession + csrfToken

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

パラメーター

webhookId · path · 必須条件

シェムリアップ
シェムリアップ
{
  "type": "string",
  "pattern": "^cbk_[A-Za-z0-9_-]{8,}$"
}

対応機種

204 削除

401 認証が必要または無効

401応答 · application/problem+json

Problem

401応答
{
  "$ref": "#/components/schemas/Problem"
}

404 発信者によって発見されていない、または所有されていないリソース

404応答 · application/problem+json

Problem

404応答
{
  "$ref": "#/components/schemas/Problem"
}
POST/delivery/webhooks/{webhookId}/test

サンプルのダウンロード完了ペイロードを送信する

認証: cookieSession + csrfToken

サーバー: https://api.flashdata.dev/v2

サーバー: http://localhost:5000/v2

パラメーター

webhookId · path · 必須条件

シェムリアップ
シェムリアップ
{
  "type": "string",
  "pattern": "^cbk_[A-Za-z0-9_-]{8,}$"
}

対応機種

200 試みられたテスト

200応答 · application/json

DeliveryWebhook

200応答
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "statusCode",
    "webhook"
  ],
  "properties": {
    "statusCode": {
      "type": "integer",
      "minimum": 0
    },
    "webhook": {
      "$ref": "#/components/schemas/DeliveryWebhook"
    }
  }
}

401 認証が必要または無効

401応答 · application/problem+json

Problem

401応答
{
  "$ref": "#/components/schemas/Problem"
}

404 発信者によって発見されていない、または所有されていないリソース

404応答 · application/problem+json

Problem

404応答
{
  "$ref": "#/components/schemas/Problem"
}

求人情報

投稿、ステータス、結果例については、 Realtimeと非同期 · Batch リクエスト.

GET/jobs

リスト 現在のワークスペースのデータ API ジョブ

Cursor-paginated アクティブおよびアーカイブされた歴史。 最後の7日間にデフォルト値。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}

1つのデータを読む 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 または 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にリダイレクトします。クライアントは、R2から直接元のJSONを受け取ります。 Accept: text/plain 独立してリターン HTTP 200 元の結果フィールドにテキストを刻まれたようにします。 X-Respond-With: マークダウンは、Markdownコンテンツを選択します: application/jsonは、元のメタデータと一緒にコンテンツをラップし、結果を交換します。 text/plainは、メタデータを返し、Markdownが続きます。 Accept やグローバルワイルドカードのデフォルトを 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 または JSON にグローバルワイルドカードのデフォルトを欠落させます。 応答タイプは、UTF-8 を使用します。 明示的なcharset=utf-8 パラメータがサポートされています。

シェムリアップ
シェムリアップ
{
  "type": "string"
}

jobId · path · 必須条件

シェムリアップ
シェムリアップ
{
  "type": "string",
  "pattern": "^job_[A-Za-z0-9_-]+$"
}

対応機種

200 元のフィールドをプレーンテキストまたは Markdown で直接返します。デフォルトのリダイレクトをたどると、R2 から元の JSON を取得できます。

200応答 · application/json

MarkdownQueryResult

200応答
{
  "anyOf": [
    {
      "$ref": "#/components/schemas/MarkdownQueryResult"
    },
    {
      "type": "object",
      "additionalProperties": true
    }
  ]
}
200応答 · text/plain
200応答
{
  "type": "string"
}

302 JSONがX-Respond-Withなしで選ばれるとき、プライベートR2の元のJSONにリダイレクト

ヘッダー: 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"
}

Bulk 処理 API

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 上流データ 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."
    }
  }
}