Jelajahi dokumentasi
Referensi API
Referensi API Manajemen
Ramban titik akhir bagi akun, kunci, penagihan dan pekerjaan. Setiap titik akhir daftar sendiri otentikasi dan persyaratan akses.
Baca akun Anda dengan kunci API
API dasar URL adalah https://api.flashdata.dev/v2. Pembacaan bebas ini mengembalikan kunci dan akun IDs dan kepemilikan. Set FLASHDATA_API_KEY sebelum menjalankan perintah.
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'Diharapkan HTTP 200 sukses. Periksa baris otentikasi setiap titik akhir: dataApiKey menggunakan X-API-Key; cookieSession menggunakan sebuah sinyal dalam sesi peramban. Skema respon identitas
Unduh spesifikasi pelanggan OpenAPI. Ini mencakup pertanyaan, pekerjaan, rekening, API kunci dan tagihan.
Parameter kuiri dan kode permintaan didokumentasikan dalam Google dan YouTube API referensi.
Skema otentikasi
| Skema | Kebutuhan |
|---|---|
dataApiKey |
FlashData API kunci. Akses pekerjaan dibatasi untuk sumber lingkup kunci. |
cookieSession |
Sesi Opaque Web. Peramban tidak dapat membaca cookie ini. |
csrfToken |
apiKey |
agentRegistrationProof | Persist a cryptographically random 32-byte base64url bukti dan permintaan tepat sebelum mengirim; pulih hanya dengan bukti yang sama dan tubuh. Bukan tanda OAuth. |
agentSetupCredential | Untuk status dan hanya menciptakan pengaturan sementara. Bukan data kunci API. |
agentHandoffProof | Bukti yang digunakan untuk memulihkan kunci pemilik dan mengakui instalasi. Tidak pernah dikirim ke permintaan data. |
agentIdentityKey | Kunci FlashData API yang biasa dalam Pemuat Otorisasi, hanya pada identitas agen. Kueri data menggunakan X-API-Key sebagai gantinya. |
Sistem
GET/health
Kesehatan layanan
Otentikasi: Publik
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Respon
200 Sehat
200 respon · application/json
{
"$ref": "#/components/schemas/Health"
}GET/status
Baca ringkasan status komponen publik
Otentikasi: Publik
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Respon
200 Ringkasan status publik
Header: Cache-Control
200 respon · application/json
{
"$ref": "#/components/schemas/PublicStatus"
}Auth
GET/oauth/requests/{requestId}
Baca permintaan otorisasi aplikasi dan ikat ke sesi saat ini
Perlu sesi penuh. Permintaan berakhir setelah sepuluh menit. Response adalah no- toko.
Otentikasi: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
requestId · path · dibutuhkan
Skema
{
"type": "string",
"pattern": "^fdo_[A-Za-z0-9_-]{43}$"
}Respon
200 Hak akses aplikasi yang diminta
200 respon · application/json
{
"$ref": "#/components/schemas/OAuthConsent"
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Diotentikasi tetapi tidak diizinkan, atau validasi CSRF gagal
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan kadaluwarsa, digunakan, atau terikat ke sesi lain
410 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/oauth/requests/{requestId}
Atur atau tolak suatu permintaan otorisasi aplikasi
Sesi penuh, CSRF dan diperlukan Origin. Mengkonsumsi permintaan sekali. Response adalah no- toko.
Otentikasi: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
requestId · path · dibutuhkan
Skema
{
"type": "string",
"pattern": "^fdo_[A-Za-z0-9_-]{43}$"
}Meminta tubuh · dibutuhkan
Skema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"decision"
],
"properties": {
"decision": {
"type": "string",
"enum": [
"approve",
"deny"
]
}
}
}Respon
200 Terdaftar callback klien dengan kode atau penolakan, keadaan dan penerbit
200 respon · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"redirectUrl"
],
"properties": {
"redirectUrl": {
"type": "string",
"format": "uri"
}
}
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Diotentikasi tetapi tidak diizinkan, atau validasi CSRF gagal
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan otorisasi tidak tersedia; memulai koneksi baru
410 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi gagal
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/register
Buat akun FlashData yang tertunda
Terms dan Versi Privasi yang diajukan harus cocok dengan bundel hukum yang diterbitkan saat ini.
Otentikasi: Publik
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Meminta tubuh · dibutuhkan
Skema · application/json
{
"$ref": "#/components/schemas/RegisterRequest"
}Respon
201 Akun dibuat; verifikasi email diperlukan
Header: Cache-Control, X-Request-Id
201 respon · application/json
{
"$ref": "#/components/schemas/RegisterResponse"
}409 Kondisi sumber daya atau konflik idempotency
409 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi gagal
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Laju, konmata, batch, atau limit pekerjaan pending- terlampaui
Header: Retry-After
429 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Terjadi galat internal yang tak terduga
500 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Ketergantungan atau katalog yang diperlukan sementara tidak tersedia
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/login
Membuat sesi Web yang buram
Mengatur Secure, HttpOnly `__Host-fd_session` cookie. Akun yang tertunda menerima sesi email_verification terbatas untuk papan pengumuman verifikasi. Rekening yang benar-benar diverifikasi menerima satu kali Trial Credits pada login jika belum diberikan. Akun aktif menerima Sesi penuh kecuali identitas bermigrasi masih membutuhkan penerimaan hukum saat ini, dalam hal ini menerima dibatasi Sesi legal_acceptance. Sebuah akun dengan permintaan penghapusan dijadwalkan menerima sesi deletion_recovery terbatas. Akun penghapusan yang adalah processing/failed/completed, dan rekening ditangguhkan, menerima 403.
Otentikasi: Publik
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Meminta tubuh · dibutuhkan
Skema · application/json
{
"$ref": "#/components/schemas/LoginRequest"
}Respon
200 Diotentikasi
Header: Set-Cookie, Cache-Control, X-Request-Id
200 respon · application/json
{
"$ref": "#/components/schemas/LoginResponse"
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Login dilarang; Problem.code adalah email_not_verified, account_suspended, account_deletion_processing, account_deletion_failed, atau account_deleted
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi gagal
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}423 Akun sementara terkunci
Header: Retry-After
423 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Laju, konmata, batch, atau limit pekerjaan pending- terlampaui
Header: Retry-After
429 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/logout
Mengembalikan sesi saat ini
Otentikasi: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Respon
204 Sesi dibatalkan dan cookie dibersihkan
Header: Set-Cookie, Cache-Control, X-Request-Id
401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Diotentikasi tetapi tidak diizinkan, atau validasi CSRF gagal
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/auth/me
Baca akun dan pengguna saat ini
Otentikasi: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Respon
200 Akun kini
Header: Cache-Control, X-Request-Id
200 respon · application/json
{
"$ref": "#/components/schemas/Account"
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/auth/csrf
Dapatkan CSRF token terikat dengan sesi saat ini
Otentikasi: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Respon
200 CSRF token
Header: Cache-Control, X-Request-Id
200 respon · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"csrfToken"
],
"properties": {
"csrfToken": {
"type": "string",
"minLength": 32,
"readOnly": true
}
}
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/email-verifications
Permintaan atau mengirim ulang pesan verifikasi email
Untuk setiap email yang valid sintaksis, kembali respon yang sama terlepas dari apakah akun hilang, tertunda, aktif, ditangguhkan, atau dihapus. Rekening yang bisa di-tunda menerima rekaman satu kali setelah pengiriman ulang pendinginan.
Otentikasi: Publik
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Meminta tubuh · dibutuhkan
Skema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 320
}
}
}Respon
202 Permintaan diterima. Respon tidak mengungkapkan apakah ada akun.
Header: Cache-Control, X-Request-Id
202 respon · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"accepted"
],
"properties": {
"accepted": {
"type": "boolean",
"const": true
}
}
}422 Validasi permintaan otentikasi anonim gagal
Header: Cache-Control, X-Request-Id
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Batas kecepatan otentikasi anonymous terlampaui
Header: Cache-Control, Retry-After, X-Request-Id
429 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Terjadi galat otentikasi anonim yang tak diharapkan
Header: Cache-Control, X-Request-Id
500 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Ketergantungan otentikasi anonim sementara tidak tersedia
Header: Cache-Control, X-Request-Id
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/email-verifications/confirm
Verifikasi suatu email dan aktifkan akun
Atomically mengkonsumsi satu-waktu token dan mengaktifkan Akun dan Pengguna. Akun yang ada dan aturan trial-kredit berlaku. Tanpa sesi pendaftaran log pengguna secara eksplisit. Permintaan asal yang memungkinkan membawa sesi penandaan yang cocok dan X-CSRF-Token yang mungkin menerima cookie berputar Sesi untuk akun yang diverifikasi sama; tanda verifikasi saja tidak pernah menandatangani pada pengguna.
Otentikasi: Publik
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Meminta tubuh · dibutuhkan
Skema · application/json
{
"$ref": "#/components/schemas/TokenRequest"
}Respon
200 Akun diaktifkan
Header: Set-Cookie, Cache-Control, X-Request-Id
200 respon · application/json
{
"allOf": [
{
"$ref": "#/components/schemas/Account"
},
{
"type": "object",
"properties": {
"status": {
"const": "active"
},
"emailVerified": {
"const": true
}
}
}
]
}410 Satu token waktu tidak valid, kadaluarsa, tidak sah, sudah digunakan, atau kehilangan race konfirmasi kontemporer. Problem.code adalah `token_unavailable`.
Header: Cache-Control, X-Request-Id
410 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Validasi permintaan otentikasi anonim gagal
Header: Cache-Control, X-Request-Id
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Batas kecepatan otentikasi anonymous terlampaui
Header: Cache-Control, Retry-After, X-Request-Id
429 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Terjadi galat otentikasi anonim yang tak diharapkan
Header: Cache-Control, X-Request-Id
500 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Ketergantungan otentikasi anonim sementara tidak tersedia
Header: Cache-Control, X-Request-Id
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/email-verifications/session
Lanjutkan sesi pendaftaran asli setelah verifikasi surel
Membutuhkan Origin yang diperbolehkan dan CSRF token terikat ke sebuah sandi hidup - dikonfirmasi Email - verifikasi Sesi. Kembali tertunda sampai akun Sesi sendiri diverifikasi, termasuk verifikasi dalam peramban lain. Secara atom mencabut sesi pendaftaran dan mengeluarkan sesi penerimaan penuh atau tanpa kaki. Tidak menerima akun ID, email, sandi atau tanda verifikasi, lewat penerimaan hukum, atau kredit hibah.
Otentikasi: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Meminta tubuh · dibutuhkan
Skema · application/json
{
"type": "object",
"additionalProperties": false
}Respon
200 Sesi Signap diputar
Header: Set-Cookie, Cache-Control
200 respon · application/json
{
"$ref": "#/components/schemas/LoginResponse"
}202 Verifikasi surel tertunda; tidak ada Sesi baru
Header: Cache-Control
202 respon · application/json
{
"type": "object",
"required": [
"pending"
],
"additionalProperties": false,
"properties": {
"pending": {
"type": "boolean",
"const": true
}
}
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Diotentikasi tetapi tidak diizinkan, atau validasi CSRF gagal
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi gagal
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Terjadi galat internal yang tak terduga
500 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/password-resets
Meminta surel reset sandi
Selalu mengembalikan respon 202 yang sama untuk sebuah email yang valid secara sintaktikal terlepas dari eksistensi akun atau keadaan lifecycle. Hanya memenuhi syarat aktif atau identitas terkunci menerima surat.
Otentikasi: Publik
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Meminta tubuh · dibutuhkan
Skema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 320
}
}
}Respon
202 Permintaan diterima. Respon tidak mengungkapkan apakah ada akun.
Header: Cache-Control, X-Request-Id
202 respon · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"accepted"
],
"properties": {
"accepted": {
"type": "boolean",
"const": true
}
}
}422 Validasi permintaan otentikasi anonim gagal
Header: Cache-Control, X-Request-Id
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Batas kecepatan otentikasi anonymous terlampaui
Header: Cache-Control, Retry-After, X-Request-Id
429 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Terjadi galat otentikasi anonim yang tak diharapkan
Header: Cache-Control, X-Request-Id
500 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Ketergantungan otentikasi anonim sementara tidak tersedia
Header: Cache-Control, X-Request-Id
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/password-resets/confirm
Atur sandi baru dan batalkan sesi yang telah ada
Secara atomically mengkonsumsi token password- reset, menyimpan sebuah kredensial Argon2id baru, mencabut setiap Sesi yang ada, dan membatalkan token passwords-reset lainnya. Ini tidak log pengguna dalam atau membuat Sesi.
Otentikasi: Publik
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Meminta tubuh · dibutuhkan
Skema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"token",
"password"
],
"properties": {
"token": {
"type": "string",
"minLength": 32,
"maxLength": 256,
"writeOnly": true
},
"password": {
"$ref": "#/components/schemas/Password"
}
}
}Respon
204 Sandi dimutakhirkan; sesi yang ada dicabut
Header: Cache-Control, X-Request-Id
410 Satu token waktu tidak valid, kadaluarsa, tidak sah, sudah digunakan, atau kehilangan race konfirmasi kontemporer. Problem.code adalah `token_unavailable`.
Header: Cache-Control, X-Request-Id
410 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Validasi permintaan otentikasi anonim gagal
Header: Cache-Control, X-Request-Id
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Batas kecepatan otentikasi anonymous terlampaui
Header: Cache-Control, Retry-After, X-Request-Id
429 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Terjadi galat otentikasi anonim yang tak diharapkan
Header: Cache-Control, X-Request-Id
500 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Ketergantungan otentikasi anonim sementara tidak tersedia
Header: Cache-Control, X-Request-Id
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/auth/sessions
Daftar sesi aktif bagi pengguna saat ini
Otentikasi: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Respon
200 Sesi
Header: Cache-Control, X-Request-Id
200 respon · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Session"
}
}
}
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/auth/sessions
Mundurkan semua sesi kecuali yang sekarang
Otentikasi: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Respon
204 Sesi lain dibatalkan
Header: Cache-Control, X-Request-Id
401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Diotentikasi tetapi tidak diizinkan, atau validasi CSRF gagal
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/auth/sessions/{sessionId}
Membalik satu sesi
Otentikasi: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
sessionId · path · dibutuhkan
Skema
{
"type": "string",
"pattern": "^ses_"
}Respon
204 Sesi dibatalkan. Jika itu adalah Sesi saat ini, cookie dibersihkan.
Header: Set-Cookie, Cache-Control, X-Request-Id
401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Diotentikasi tetapi tidak diizinkan, atau validasi CSRF gagal
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon
404 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Kondisi sumber daya atau konflik idempotency
409 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi gagal
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Ketergantungan atau katalog yang diperlukan sementara tidak tersedia
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/re-authenticate
Verifikasi sandi kini bagi suatu operasi sensitif
Catatan pendek hidup kembali-auth bukti pada sesi server- saat ini.
Otentikasi: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Meminta tubuh · dibutuhkan
Skema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"password"
],
"properties": {
"password": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"writeOnly": true
}
}
}Respon
200 Sesi memiliki otentikasi baru-baru ini
Header: Cache-Control, X-Request-Id
200 respon · application/json
{
"$ref": "#/components/schemas/Reauthentication"
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Diotentikasi tetapi tidak diizinkan, atau validasi CSRF gagal
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Laju, konmata, batch, atau limit pekerjaan pending- terlampaui
Header: Retry-After
429 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}PATCH/auth/password
Ubah kata sandi dan putar sesi saat ini
Otentikasi: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Meminta tubuh · dibutuhkan
Skema · application/json
{
"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
}
}
}Respon
204 Sandi berubah; sesi saat ini diputar dan sesi lain dibatalkan ketika diminta
Header: Set-Cookie, Cache-Control, X-Request-Id
401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Diotentikasi tetapi tidak diizinkan, atau validasi CSRF gagal
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi gagal
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Akun
GET/oauth/connections
Daftar aplikasi yang tersambung akun saat ini
Perlu sesi penuh. Kosong ketika akun tidak memiliki aplikasi yang terhubung. Response adalah no- toko.
Otentikasi: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Respon
200 Connected apps
200 respon · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuthConnection"
}
}
}
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Diotentikasi tetapi tidak diizinkan, atau validasi CSRF gagal
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/oauth/connections/{grantId}
Mengembalikan aplikasi yang tersambung dan kunci API yang didedikasikan
Sesi penuh, CSRF dan diperlukan Origin. Kepemilikan rekening diberlakukan. Response adalah no- toko.
Otentikasi: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
grantId · path · dibutuhkan
Skema
{
"type": "string",
"pattern": "^oag_[A-Za-z0-9_-]{8,}$"
}Respon
204 Otorisasi dicabut
401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Diotentikasi tetapi tidak diizinkan, atau validasi CSRF gagal
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon
404 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/account
Baca pengaturan akun
Otentikasi: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Respon
200 Akun
200 respon · application/json
{
"$ref": "#/components/schemas/Account"
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}PATCH/account
Perbarui pengaturan profil
Otentikasi: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Meminta tubuh · dibutuhkan
Skema · application/json
{
"$ref": "#/components/schemas/UpdateAccountRequest"
}Respon
200 Akun yang dimutakhirkan
200 respon · application/json
{
"$ref": "#/components/schemas/Account"
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Diotentikasi tetapi tidak diizinkan, atau validasi CSRF gagal
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi gagal
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/account
Jadwalkan penghapusan akun dan batalkan semua sesi yang ada dan API Keys
Akun administrator harus memiliki peran platform mereka dibatalkan melalui operator audit alur kerja sebelum penghapusan dapat dijadwalkan. Permintaan penghapusan aktif yang unik adalah batas idempotensi alami. Jadwalnya dikonfirmasi mengembalikan permintaan yang sama. Setelah pembatalan Sesi, respon yang hilang ditemukan dengan log masuk deletion_recovery mode dan membaca GET /account/deletion; Sesi dibatalkan tidak pernah diterima untuk replay.
Otentikasi: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Meminta tubuh · dibutuhkan
Skema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"password",
"confirmation"
],
"properties": {
"password": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"writeOnly": true
},
"confirmation": {
"type": "string",
"const": "DELETE"
}
}
}Respon
202 Penghapusan dijadwalkan; sesi aktif dan kunci dibatalkan
202 respon · application/json
{
"$ref": "#/components/schemas/AccountDeletionRequest"
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Diotentikasi tetapi tidak diizinkan, atau validasi CSRF gagal
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Kondisi sumber daya atau konflik idempotency
409 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi gagal
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/account/deletion
Baca permintaan penghapusan akun saat ini
Otentikasi: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Respon
200 Permintaan penghapusan saat ini
200 respon · application/json
{
"$ref": "#/components/schemas/AccountDeletionRequest"
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon
404 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/account/deletion
Batalkan penghapusan yang dijadwalkan selama periode rahmat
Menggunakan penjadwalan -ke -dibatalkan perbandingan -and -set. Sebuah perlombaan prosesor mengembalikan 409; setelah sukses Sesi pemulihan diputar dan tidak dapat memutar ulang transisi lama.
Otentikasi: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Respon
204 Penghapusan dibatalkan, akun diaktifkan kembali, dan sesi pemulihan diputar sesuai dengan gerbang penerimaan kaki
Header: Set-Cookie, Cache-Control, X-Request-Id
401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Diotentikasi tetapi tidak diizinkan, atau validasi CSRF gagal
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon
404 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Kondisi sumber daya atau konflik idempotency
409 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/account/legal-acceptances
Accept versi Terminasi dan Privasi saat ini
Tambahkan penerimaan hukum yang tak bisa diubah, membersihkan gerbang migrasi, dan memutar Sesi. Versi pengajuan stale ditolak.
Otentikasi: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Meminta tubuh · dibutuhkan
Skema · application/json
{
"$ref": "#/components/schemas/LegalAcceptanceRequest"
}Respon
200 Penerimaan hukum direkam dan Sesi diputar ke mode penuh
Header: Set-Cookie, Cache-Control, X-Request-Id
200 respon · application/json
{
"$ref": "#/components/schemas/LoginResponse"
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Diotentikasi tetapi tidak diizinkan, atau validasi CSRF gagal
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon
404 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi gagal
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Onboarding
GET/onboarding
Baca resudable onboarding progress
Otentikasi: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Respon
200 Keadaan onboarding saat ini
Header: Cache-Control, X-Request-Id
200 respon · application/json
{
"$ref": "#/components/schemas/OnboardingProgress"
}401 Otentikasi diperlukan atau tak valid
Header: Cache-Control, X-Request-Id
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Terjadi galat internal yang tak terduga
Header: Cache-Control, X-Request-Id
500 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Sebuah dependensi yang diperlukan atau catatan onboarding sementara tidak tersedia
Header: Cache-Control, X-Request-Id
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}PATCH/onboarding
Advanonboarding tanpa memungkinkan kemajuan untuk bergerak mundur
Otentikasi: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Meminta tubuh · dibutuhkan
Skema · application/json
{
"$ref": "#/components/schemas/UpdateOnboardingRequest"
}Respon
200 Updated onboarding state
Header: Cache-Control, X-Request-Id
200 respon · application/json
{
"$ref": "#/components/schemas/OnboardingProgress"
}401 Otentikasi diperlukan atau tak valid
Header: Cache-Control, X-Request-Id
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Diotentikasi tetapi tidak diizinkan, atau validasi CSRF gagal
Header: Cache-Control, X-Request-Id
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Kondisi sumber daya atau konflik idempotency
Header: Cache-Control, X-Request-Id
409 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi gagal
Header: Cache-Control, X-Request-Id
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Terjadi galat internal yang tak terduga
Header: Cache-Control, X-Request-Id
500 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Sebuah dependensi yang diperlukan atau catatan onboarding sementara tidak tersedia
Header: Cache-Control, X-Request-Id
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Ringkasan
GET/overview
Baca kumpulan dashboard akun
Otentikasi: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Respon
200 Tatanan akunting-scoped
Header: Cache-Control, X-Request-Id
200 respon · application/json
{
"$ref": "#/components/schemas/ConsoleOverview"
}401 Otentikasi diperlukan atau tak valid
Header: Cache-Control, X-Request-Id
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Terjadi galat internal yang tak terduga
Header: Cache-Control, X-Request-Id
500 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Sebuah dependensi yang diperlukan atau catatan onboarding sementara tidak tersedia
Header: Cache-Control, X-Request-Id
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}API Keys
GET/api-access/identity
Verifikasi kepemilikan kunci API kini dan kesiapan yang berulang
Pembaca gratis - hanya API- kunci yang dibaca. Mengembalikan publik account/key IDs dan kepemilikan otoritatif. Tidak ada tubuh permintaan. Tidak mengubah respon metadata /api-access yang telah ada. Berbagi 120/minute batas baca. Gagal ditutup karena tidak tersedia; jangan infer kepemilikan dari awalan kunci, rencana, atau keadaan lokal. Tidak ada parameter query yang diterima. Respon adalah no- store.
Otentikasi: dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Respon
200 Verifikasi kepemilikan kunci API kini dan kesiapan yang berulang
200 respon · application/json
{
"$ref": "#/components/schemas/APIKeyIdentity"
}400 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
400 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
409 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
410 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
429 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-keys
Metadata Kunci API Daftar
Otentikasi: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Respon
200 API Keys tanpa rahasia
200 respon · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiKey"
}
}
}
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/api-keys
Buat kunci API dan ungkapkan rahasianya sekali
Otentikasi: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
Idempotency-Key · header · dibutuhkan
Skema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Meminta tubuh · dibutuhkan
Skema · application/json
{
"$ref": "#/components/schemas/CreateApiKeyRequest"
}Respon
201 Dibuat; replay idempoten yang sama dapat mengembalikan respon terenkripsi yang sama selama lima menit
201 respon · application/json
{
"$ref": "#/components/schemas/ApiKeyCreated"
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Diotentikasi tetapi tidak diizinkan, atau validasi CSRF gagal
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Kondisi sumber daya atau konflik idempotency
409 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi gagal
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Ketergantungan atau katalog yang diperlukan sementara tidak tersedia
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/api-keys/{keyId}
Buka Kunci API
Otentikasi: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
keyId · path · dibutuhkan
Skema
{
"type": "string",
"pattern": "^key_"
}Respon
204 Dicabut
401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Diotentikasi tetapi tidak diizinkan, atau validasi CSRF gagal
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon
404 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Ketergantungan atau katalog yang diperlukan sementara tidak tersedia
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/api-keys/{keyId}/rotate
Buat kunci pengganti dan jadwal pembatalan kunci lama
Membuat kunci baru dan tetap aktif sampai revokeOldAt. Secara baku, tumpang tindih berlangsung 24 jam atau sampai kunci lama berakhir, mana yang lebih awal. Sebuah revokeOldAt kustom harus di masa depan, dalam waktu tujuh hari, dan tidak lebih dari kunci tua berakhir.
Otentikasi: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
keyId · path · dibutuhkan
Skema
{
"type": "string",
"pattern": "^key_"
}Idempotency-Key · header · dibutuhkan
Skema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Meminta tubuh · opsional
Skema · 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."
}
}
}Respon
201 Penggantian dibuat; rahasia dikembalikan sekali
201 respon · application/json
{
"$ref": "#/components/schemas/ApiKeyCreated"
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Diotentikasi tetapi tidak diizinkan, atau validasi CSRF gagal
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon
404 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Kondisi sumber daya atau konflik idempotency
409 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi gagal
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Ketergantungan atau katalog yang diperlukan sementara tidak tersedia
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-access
Baca panggilan API sumber yang sah dan asal-usul hasil
Free, header-only X-API-Key authentication. Mengembalikan hanya diberikan publik nama sumber dan tanda tangan terkonfigurasi -hasil asal penyimpanan (null jika tidak tersedia). Tidak ada akun ID, kunci ID, rahasia atau kredensial penyimpanan dikembalikan. MCP lokal merevalidasi titik akhir ini sebelum setiap penemuan alat dan panggilan, termasuk hasil yang tercache dibaca. Tak ada parameter permintaan atau tubuh permintaan yang diterima. Semua rute /api-access berbagi permintaan 120 per menit per klien IP dan kembali Cache-Kontrol pribadi, no-store. Kunci normal terakhir yang digunakan pelacakan masih terjadi.
Otentikasi: dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Respon
200 Sumber publik dan asal hasil yang sah
200 respon · application/json
{
"$ref": "#/components/schemas/ApiAccess"
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi gagal
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Terlalu banyak akun dibaca; coba lagi setelah jendela rate- batas
503 Ketergantungan atau katalog yang diperlukan sementara tidak tersedia
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Sambungan Agen
GET/agent-connections/capabilities
Temukan protokol 2 onboarding tersedia
Tidak ada parameter query yang diterima. Respon adalah no- store. Rute agen adalah pengelolaan - hanya dan kelayakan; pengangkatan dapat mengembalikan 404 ketika dinonaktifkan. X-API-Key dilarang pada rute agen.
Otentikasi: Publik
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Respon
200 Temukan protokol 2 onboarding tersedia
200 respon · application/json
{
"$ref": "#/components/schemas/AgentCapabilities"
}400 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
400 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
409 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
410 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
429 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/registrations
Buat atau pulihkan sambungan kunci sementara API-@@
Persist bukti pendaftaran dan masukan tepat sebelum POST. Bukti yang sama dan tubuh memulihkan percobaan yang sama; mengubah hasil masukan konflik. Sidang sementara: 1 Kredit, 72 jam, 1 request/second, ukuran batch 1. Batas lingkup sumber tetap berwibawa pada server. Tidak ada parameter query yang diterima. Respon adalah no- store. Rute agen adalah pengelolaan - hanya dan kelayakan; pengangkatan dapat mengembalikan 404 ketika dinonaktifkan. X-API-Key dilarang pada rute agen.
Otentikasi: agentRegistrationProof
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Meminta tubuh · dibutuhkan
Skema · application/json
{
"$ref": "#/components/schemas/AgentRegistrationRequest"
}Respon
201 Buat atau pulihkan sambungan kunci sementara API-@@
201 respon · application/json
{
"$ref": "#/components/schemas/AgentRegistration"
}400 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
400 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
409 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
410 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
429 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/owned
Daftar koneksi browser- yang dimiliki
Tidak ada parameter query yang diterima. Respon adalah no- store. Rute agen adalah pengelolaan - hanya dan kelayakan; pengangkatan dapat mengembalikan 404 ketika dinonaktifkan. X-API-Key dilarang pada rute agen. Operasi Browser- dimiliki. Diperlukan Sesi yang diverifikasi penuh; penelepon tidak boleh mengganti kunci API atau bukti.
Otentikasi: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Respon
200 Daftar koneksi browser- yang dimiliki
200 respon · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"connections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentConnection"
}
}
},
"required": [
"connections"
]
}400 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
400 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
409 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
410 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
429 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/{connectionId}
Baca status koneksi sementara
Tidak ada parameter query yang diterima. Respon adalah no- store. Rute agen adalah pengelolaan - hanya dan kelayakan; pengangkatan dapat mengembalikan 404 ketika dinonaktifkan. X-API-Key dilarang pada rute agen.
Otentikasi: agentSetupCredential
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
connectionId · path · dibutuhkan
Skema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Respon
200 Baca status koneksi sementara
200 respon · application/json
{
"$ref": "#/components/schemas/AgentConnectionResponse"
}400 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
400 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
409 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
410 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
429 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/agent-connections/{connectionId}
Mengembalikan koneksi yang dimiliki
Tidak ada parameter query yang diterima. Respon adalah no- store. Rute agen adalah pengelolaan - hanya dan kelayakan; pengangkatan dapat mengembalikan 404 ketika dinonaktifkan. X-API-Key dilarang pada rute agen. Operasi Browser- dimiliki. Diperlukan Sesi yang diverifikasi penuh; penelepon tidak boleh mengganti kunci API atau bukti.
Otentikasi: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
connectionId · path · dibutuhkan
Skema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Origin · header · dibutuhkan
Skema
{
"type": "string"
}X-CSRF-Token · header · dibutuhkan
Skema
{
"type": "string"
}Respon
204 Mengembalikan koneksi yang dimiliki
400 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
400 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
409 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
410 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
429 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/{connectionId}/identity
Verifikasi data kini kunci API untuk suatu koneksi
Tidak ada parameter query yang diterima. Respon adalah no- store. Rute agen adalah pengelolaan - hanya dan kelayakan; pengangkatan dapat mengembalikan 404 ketika dinonaktifkan. X-API-Key dilarang pada rute agen.
Otentikasi: agentIdentityKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
connectionId · path · dibutuhkan
Skema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Respon
200 Verifikasi data kini kunci API untuk suatu koneksi
200 respon · application/json
{
"$ref": "#/components/schemas/AgentConnectionResponse"
}400 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
400 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
409 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
410 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
429 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/{connectionId}/onboarding
Keadaan onboarding dapat dikembalikan
Tidak ada parameter query yang diterima. Respon adalah no- store. Rute agen adalah pengelolaan - hanya dan kelayakan; pengangkatan dapat mengembalikan 404 ketika dinonaktifkan. X-API-Key dilarang pada rute agen.
Otentikasi: agentHandoffProof
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
connectionId · path · dibutuhkan
Skema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Respon
200 Keadaan onboarding dapat dikembalikan
200 respon · application/json
{
"$ref": "#/components/schemas/AgentOnboardingStatus"
}400 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
400 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
409 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
410 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
429 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/{connectionId}/claims
Buat sebuah klaim persetujuan peramban
Buka claimPath pada FlashData terpercaya asal web dan tampilkan kode secara terpisah. Jangan pernah menempatkan kredensial atau kode konfirmasi dalam URL. Tidak ada parameter query yang diterima. Respon adalah no- store. Rute agen adalah pengelolaan - hanya dan kelayakan; pengangkatan dapat mengembalikan 404 ketika dinonaktifkan. X-API-Key dilarang pada rute agen.
Otentikasi: agentSetupCredential
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
connectionId · path · dibutuhkan
Skema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Meminta tubuh · dibutuhkan
Skema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {},
"required": []
}Respon
201 Buat sebuah klaim persetujuan peramban
201 respon · application/json
{
"$ref": "#/components/schemas/AgentClaim"
}400 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
400 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
409 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
410 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
429 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/claims/{claimId}/confirm
Konfirmasikan kode klaim dalam sesi peramban yang diverifikasi
Tidak ada parameter query yang diterima. Respon adalah no- store. Rute agen adalah pengelolaan - hanya dan kelayakan; pengangkatan dapat mengembalikan 404 ketika dinonaktifkan. X-API-Key dilarang pada rute agen. Operasi Browser- dimiliki. Diperlukan Sesi yang diverifikasi penuh; penelepon tidak boleh mengganti kunci API atau bukti.
Otentikasi: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
claimId · path · dibutuhkan
Skema
{
"type": "string",
"pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}Origin · header · dibutuhkan
Skema
{
"type": "string"
}X-CSRF-Token · header · dibutuhkan
Skema
{
"type": "string"
}Meminta tubuh · dibutuhkan
Skema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"pattern": "^\\d{8}$"
}
},
"required": [
"code"
]
}Respon
200 Konfirmasikan kode klaim dalam sesi peramban yang diverifikasi
200 respon · application/json
{
"$ref": "#/components/schemas/AgentBrowserClaim"
}400 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
400 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
409 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
410 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
429 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/claims/{claimId}
Baca klaim yang dikonfirmasi dalam sesi peramban
Tidak ada parameter query yang diterima. Respon adalah no- store. Rute agen adalah pengelolaan - hanya dan kelayakan; pengangkatan dapat mengembalikan 404 ketika dinonaktifkan. X-API-Key dilarang pada rute agen. Operasi Browser- dimiliki. Diperlukan Sesi yang diverifikasi penuh; penelepon tidak boleh mengganti kunci API atau bukti.
Otentikasi: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
claimId · path · dibutuhkan
Skema
{
"type": "string",
"pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}Respon
200 Baca klaim yang dikonfirmasi dalam sesi peramban
200 respon · application/json
{
"$ref": "#/components/schemas/AgentClaimView"
}400 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
400 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
409 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
410 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
429 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/claims/{claimId}/approve
Menegaskan pengurangan lingkup dan akuntansi-pembiayaan keseimbangan
Tidak ada parameter query yang diterima. Respon adalah no- store. Rute agen adalah pengelolaan - hanya dan kelayakan; pengangkatan dapat mengembalikan 404 ketika dinonaktifkan. X-API-Key dilarang pada rute agen. Operasi Browser- dimiliki. Diperlukan Sesi yang diverifikasi penuh; penelepon tidak boleh mengganti kunci API atau bukti.
Otentikasi: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
claimId · path · dibutuhkan
Skema
{
"type": "string",
"pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}Origin · header · dibutuhkan
Skema
{
"type": "string"
}X-CSRF-Token · header · dibutuhkan
Skema
{
"type": "string"
}Meminta tubuh · dibutuhkan
Skema · application/json
{
"$ref": "#/components/schemas/AgentApproval"
}Respon
200 Menegaskan pengurangan lingkup dan akuntansi-pembiayaan keseimbangan
200 respon · application/json
{
"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 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
400 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
409 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
410 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
429 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/{connectionId}/handoff
Kembalikan kunci pemilik yang disetujui API
Kunci kandidat kadaluarsa pada 24 jam sampai alarm instalasi. Secara atom, isi ulang dalam proses baru dan verifikasi identitas sebelum menyerang. Kandidat pengiriman yang berulang pulih yang sama; dikonfirmasi kembali pengiriman tanda terima tanpa kredensial. Tidak ada parameter query yang diterima. Respon adalah no- store. Rute agen adalah pengelolaan - hanya dan kelayakan; pengangkatan dapat mengembalikan 404 ketika dinonaktifkan. X-API-Key dilarang pada rute agen.
Otentikasi: agentHandoffProof
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
connectionId · path · dibutuhkan
Skema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Meminta tubuh · dibutuhkan
Skema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {},
"required": []
}Respon
200 Kembalikan kunci pemilik yang disetujui API
200 respon · application/json
{
"$ref": "#/components/schemas/AgentHandoff"
}400 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
400 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
409 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
410 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
429 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/{connectionId}/handoff/ack
Konfirmasi telah diverifikasi instalasi kunci-pemilik
Penelepon pasti sudah menyelamatkan kandidat dan secara independen diverifikasi dalam proses yang baru. Keberhasilan tanda bahaya terpasang, menghapus kunci kandidat kadaluarsa dan menghapus bahan kredensial recoverable. Paket berulang-ulang adalah idempoten. Tidak ada parameter query yang diterima. Respon adalah no- store. Rute agen adalah pengelolaan - hanya dan kelayakan; pengangkatan dapat mengembalikan 404 ketika dinonaktifkan. X-API-Key dilarang pada rute agen.
Otentikasi: agentHandoffProof
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
connectionId · path · dibutuhkan
Skema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Meminta tubuh · dibutuhkan
Skema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"apiKey": {
"type": "string"
}
},
"required": [
"apiKey"
]
}Respon
200 Konfirmasi telah diverifikasi instalasi kunci-pemilik
200 respon · application/json
{
"$ref": "#/components/schemas/AgentHandoff"
}400 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
400 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
409 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
410 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
429 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Permintaan ditolak; memeriksa kode Masalah. Jangan pernah mencoba kembali mutasi secara membabi buta.
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Katalog
GET/catalog/sources
Daftar kemampuan sumber publik tanpa akunt - pricing spesifik
Otentikasi: Publik
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Respon
200 Katalog sumber publik
Header: Cache-Control
200 respon · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSource"
}
}
}
}GET/plans
Daftar publik USD rencana dan harga
Otentikasi: Publik
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Respon
200 katalog rencana publik
Header: Cache-Control
200 respon · application/json
{
"$ref": "#/components/schemas/PlanCatalog"
}GET/legal/current
Baca Terms saat ini dan Versi Privasi yang diperlukan untuk pendaftaran
Otentikasi: Publik
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Respon
200 Katalog versi legal saat ini
Header: Cache-Control
200 respon · application/json
{
"$ref": "#/components/schemas/PublicLegalVersions"
}Billing
GET/billing/subscription
Baca langganan Stripe efektif
Otentikasi: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Respon
200 Berlangganan atau hak PAYG
200 respon · application/json
{
"$ref": "#/components/schemas/Subscription"
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/checkout-sessions
Buat Sesi Checkout Stripe- host
Langganan dan paket kredit yang dipublikasikan menggunakan priceId. Isi ulang dengan jumlah khusus menggunakan amountMinor (sen USD, $10 hingga $999,999.99); server menghitung kredit berdasarkan nilai kredit tetap dan membuat harga Stripe privat untuk satu pembayaran. Produk, harga penyedia, mata uang, URL sukses, dan URL pembatalan tidak pernah diterima dari browser. Kredit hanya diberikan setelah peristiwa pembayaran sejumlah penawaran berhasil diverifikasi.
Otentikasi: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
Idempotency-Key · header · dibutuhkan
Skema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Meminta tubuh · dibutuhkan
Skema · 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"
}
}
}
]
}Respon
201 Sesi Checkout Stripe
201 respon · application/json
{
"$ref": "#/components/schemas/HostedSession"
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Diotentikasi tetapi tidak diizinkan, atau validasi CSRF gagal
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Kondisi sumber daya atau konflik idempotency
409 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi gagal
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Penyedia upstream gagal
502 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Katalog atau penyedia penagihan tidak dikonfigurasi atau sementara tidak tersedia
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/subscription-changes
Tingkatkan langganan Stripe saat ini ke harga yang lebih tinggi yang diterbitkan
Server memastikan bahwa harga FlashData sedang aktif, tersedia dalam mode hidup saat ini, USD-denominated, terulang, interval yang sama, dan secara ketat lebih mahal daripada harga subscription saat ini. Produk, harga penyedia, opsi mata uang dan prorasi tidak pernah diterima dari peramban. Hak lokal dan kredit hanya berubah setelah diverifikasi peristiwa penyedia diproyeksikan.
Otentikasi: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
Idempotency-Key · header · dibutuhkan
Skema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Meminta tubuh · dibutuhkan
Skema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"priceId"
],
"properties": {
"priceId": {
"type": "string",
"pattern": "^prc_"
}
}
}Respon
201 Perubahan subscription diajukan ke Stripe
201 respon · application/json
{
"$ref": "#/components/schemas/SubscriptionChange"
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Diotentikasi tetapi tidak diizinkan, atau validasi CSRF gagal
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon
404 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Kondisi sumber daya atau konflik idempotency
409 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi gagal
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Penyedia upstream gagal
502 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Katalog atau penyedia penagihan tidak dikonfigurasi atau sementara tidak tersedia
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/portal-sessions
Buat Sesi Portal Pelanggan Stripe
Otentikasi: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
Idempotency-Key · header · dibutuhkan
Skema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Respon
201 Sesi Portal Pelanggan Stripe
201 respon · application/json
{
"$ref": "#/components/schemas/HostedSession"
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Diotentikasi tetapi tidak diizinkan, atau validasi CSRF gagal
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon
404 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Kondisi sumber daya atau konflik idempotency
409 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Penyedia upstream gagal
502 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Katalog atau penyedia penagihan tidak dikonfigurasi atau sementara tidak tersedia
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/subscription-cancellation
Jadwalkan atau batalkan pembatalan dari langganan yang telah dibayar
Tatanan cancelAtPeriodEnd ke true jadwal pembatalan pada akhir periode penagihan saat ini; false tetap berlangganan. Entities update setelah diverifikasi Stripe subscription event. Titik akhir ini tidak pernah membatalkan segera atau isu pengembalian dana.
Otentikasi: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
Idempotency-Key · header · dibutuhkan
Skema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Meminta tubuh · dibutuhkan
Skema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"cancelAtPeriodEnd"
],
"properties": {
"cancelAtPeriodEnd": {
"type": "boolean"
}
}
}Respon
202 Pemutakhiran pembatalan diajukan ke Stripe
202 respon · application/json
SubscriptionCancellationChange
{
"$ref": "#/components/schemas/SubscriptionCancellationChange"
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Diotentikasi tetapi tidak diizinkan, atau validasi CSRF gagal
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon
404 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Kondisi sumber daya atau konflik idempotency
409 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi gagal
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Penyedia upstream gagal
502 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Katalog atau penyedia penagihan tidak dikonfigurasi atau sementara tidak tersedia
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/billing/invoices
Daftar proyeksi faktur Stripe
Otentikasi: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
cursor · query · opsional
Skema
{
"type": "string",
"maxLength": 512
}limit · query · opsional
Skema
{
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}Respon
200 Invoices
401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/billing/payments
Daftar akun yang ditelusuri ke atas dan mengembalikan proyeksi pembayaran
Otentikasi: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
cursor · query · opsional
Skema
{
"type": "string",
"maxLength": 512
}limit · query · opsional
Skema
{
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}Respon
200 Satu-waktu riwayat pembayaran tanpa rahasia penyedia
200 respon · application/json
{
"$ref": "#/components/schemas/BillingPaymentPage"
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Kredit
GET/api-access/balance
Baca saldo akun langsung menggunakan kunci API
Baca saldo kredit yang dibagikan oleh semua API kunci di rekening Anda. Pendaftaran aktif dapat mengurangi keseimbangan yang tersedia. Permintaan ini biaya tidak ada Credits dan tidak membutuhkan parameter query atau tubuh. Respon bersifat pribadi dan tidak cache; akuntansi - batas rate baca berlaku.
Otentikasi: dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Respon
200 Saldo yang ditandatangani dan Kredit yang tak negatif
200 respon · application/json
{
"$ref": "#/components/schemas/ApiAccessBalance"
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi gagal
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Terlalu banyak akun dibaca; coba lagi setelah jendela rate- batas
503 Ketergantungan atau katalog yang diperlukan sementara tidak tersedia
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-access/pricing
Baca harga aktual akun bagi sumber yang diijinkan oleh kunci API
Baca tingkat akun anda untuk sumber yang diijinkan oleh kunci API. A null Harga berarti sumber tidak tersedia. request_count jumlah query, bukan mengembalikan item; tingkat download per TB (10^12 byte). Perkiraan tidak cadangan Credits atau kapasitas. Permintaan ini tidak ada biaya Credits. Respon bersifat pribadi dan tidak cache; akuntansi - batas rate baca berlaku.
Otentikasi: dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
source · query · opsional
Sumber yang diberikan ke kunci ini; omit untuk membaca semua sumber yang diberikan.
Skema
{
"$ref": "#/components/schemas/ApiAccessSource"
}request_count · query · opsional
Jumlah panggilan integer desimal; tidak memperkirakan ukuran unduh.
Skema
{
"type": "integer",
"minimum": 1,
"maximum": 100000,
"default": 1
}Respon
200 Rencana akun dan sumber-harga spesifik
200 respon · application/json
{
"$ref": "#/components/schemas/ApiAccessPricing"
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Diotentikasi tetapi tidak diizinkan, atau validasi CSRF gagal
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi gagal
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Terlalu banyak akun dibaca; coba lagi setelah jendela rate- batas
503 Ketergantungan atau katalog yang diperlukan sementara tidak tersedia
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-access/limits
Batasi perencanaan akun dan tugas yang tertunda saat ini menggunakan kunci API
Baca konkuenmu, ukuran kelelawar dan batas pekerjaan, ditambah jumlah yang tertunda saat ini. Nilai-nilai ini membantu rencana permintaan tetapi tidak cadangan kapasitas. Permintaan ini biaya tidak ada Credits dan tidak membutuhkan parameter query atau tubuh. Respon bersifat pribadi dan tidak cache; akuntansi - batas rate baca berlaku.
Otentikasi: dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Respon
200 Rencana langit-langit dan saat ini menghitung tertunda
200 respon · application/json
{
"$ref": "#/components/schemas/ApiAccessLimits"
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi gagal
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Terlalu banyak akun dibaca; coba lagi setelah jendela rate- batas
503 Ketergantungan atau katalog yang diperlukan sementara tidak tersedia
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/usage
Penggunaan akun untuk sumber yang diijinkan oleh kunci API
Pembacaan gratis, hanya dikonfirmasi oleh X-API-Key. Sertakan semua kunci akun tapi hanya sumber yang diberikan ke kunci pemanggilan. Tidak mengembalikan teks permintaan, kunci, rincian pembayaran atau akun lain. Baku sampai tujuh hari; maksimum 31 hari. Tanggal harus menggunakan penanda waktu UTC Z. Dari inklusif dan eksklusif; keduanya dibulatkan ke menit. Dengan dari saja, ke default ke dari + 7 hari. Dengan tidak keduanya, adalah awal dari menit berikutnya. Agregates akhirnya konsisten; bahkan pemutakhiran = false tidak menjamin semua peristiwa baru-baru ini yang tertelan. Batas baca: permintaan 60 per menit per klien IP.
Otentikasi: dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
source · query · opsional
Sebuah sumber katalog yang tepat diberikan ke kunci pemanggilan; diabaikan berarti semua sumber yang diberikan.
Skema
{
"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 · opsional
Skema
{
"type": "string",
"format": "date-time"
}to · query · opsional
Skema
{
"type": "string",
"format": "date-time"
}Respon
200 Jumlah permintaan tergulung dan Credits terisi, dengan informasi kesegaran
200 respon · application/json
{
"$ref": "#/components/schemas/ApiKeyUsage"
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Diotentikasi tetapi tidak diizinkan, atau validasi CSRF gagal
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi gagal
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Terlalu banyak penggunaan dibaca; coba lagi setelah rate- batas jendela
503 Ketergantungan atau katalog yang diperlukan sementara tidak tersedia
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/credits/balance
Baca kredit saat ini yang tersedia dan disimpan
Otentikasi: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Respon
200 Saldo kredit
200 respon · application/json
{
"$ref": "#/components/schemas/CreditBalance"
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/credits/policy
Baca kartu kredit akun yang efektif dan kebijakan pengisian
Otentikasi: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Respon
200 Kebijakan kredit efektif
200 respon · application/json
{
"$ref": "#/components/schemas/CreditPolicy"
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/credits/transactions
Daftar entri buku besar kredit
Otentikasi: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
cursor · query · opsional
Skema
{
"type": "string",
"maxLength": 512
}limit · query · opsional
Skema
{
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}type · query · opsional
Skema
{
"$ref": "#/components/schemas/CreditEntryType"
}Respon
200 Entri ledger
200 respon · application/json
{
"allOf": [
{
"$ref": "#/components/schemas/Page"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditTransaction"
}
}
}
}
]
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Percobaan Credits
GET/trial-credit-request
Baca Ujicoba Kredit dan permintaan seumur hidup rekening
Otentikasi: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Respon
200 Saat ini eligibilitas, hibah yang dikonfigurasi, dan keadaan permintaan
Header: Cache-Control
200 respon · application/json
{
"$ref": "#/components/schemas/TrialCreditState"
}401 Otentikasi diperlukan atau tak valid
Header: Cache-Control, X-Request-Id
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Terjadi galat internal yang tak terduga
Header: Cache-Control, X-Request-Id
500 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Sebuah dependensi yang diperlukan atau catatan onboarding sementara tidak tersedia
Header: Cache-Control, X-Request-Id
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/trial-credit-request
Ajukan permintaan satu rekening seumur hidup Trial Credit
Jumlah percobaan dan penggunaan kasus disimpan ketika Anda mengirimkan permintaan.
Otentikasi: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
Idempotency-Key · header · dibutuhkan
Skema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Meminta tubuh · opsional
Skema · application/json
{
"type": "object",
"additionalProperties": false
}Respon
201 Permintaan Ujicoba Kredit dibuat dan secara otomatis disetujui untuk akun yang diverifikasi, terlepas dari penyedia email
Header: Cache-Control
201 respon · application/json
{
"$ref": "#/components/schemas/TrialCreditState"
}401 Otentikasi diperlukan atau tak valid
Header: Cache-Control, X-Request-Id
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Diotentikasi tetapi tidak diizinkan, atau validasi CSRF gagal
Header: Cache-Control, X-Request-Id
403 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Kondisi sumber daya atau konflik idempotency
Header: Cache-Control, X-Request-Id
409 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi gagal
Header: Cache-Control, X-Request-Id
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Terjadi galat internal yang tak terduga
Header: Cache-Control, X-Request-Id
500 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Sebuah dependensi yang diperlukan atau catatan onboarding sementara tidak tersedia
Header: Cache-Control, X-Request-Id
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Pengiriman
GET/delivery/webhooks
Daftar pelengkapan callback yang disimpan URLs
Otentikasi: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Respon
200 Callback URLs
200 respon · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeliveryWebhook"
}
}
}
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/delivery/webhooks
Simpan callback lengkap URL
Otentikasi: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Meminta tubuh · dibutuhkan
Skema · application/json
{
"$ref": "#/components/schemas/CreateDeliveryWebhookRequest"
}Respon
201 Dibuat
201 respon · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"webhook"
],
"properties": {
"webhook": {
"$ref": "#/components/schemas/DeliveryWebhook"
}
}
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi gagal
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/delivery/webhooks/{webhookId}
Hapus callback lengkap URL
Otentikasi: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
webhookId · path · dibutuhkan
Skema
{
"type": "string",
"pattern": "^cbk_[A-Za-z0-9_-]{8,}$"
}Respon
204 Dibuang
401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon
404 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/delivery/webhooks/{webhookId}/test
Kirim sampel download- complete payload
Otentikasi: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
webhookId · path · dibutuhkan
Skema
{
"type": "string",
"pattern": "^cbk_[A-Za-z0-9_-]{8,}$"
}Respon
200 Uji dicoba
200 respon · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"statusCode",
"webhook"
],
"properties": {
"statusCode": {
"type": "integer",
"minimum": 0
},
"webhook": {
"$ref": "#/components/schemas/DeliveryWebhook"
}
}
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon
404 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Pekerjaan
Untuk pengajuan, status, dan contoh hasil, lihat Realtime dan async · permintaan Batch.
GET/jobs
Daftar Data API tugas untuk area kerja saat ini
Kursor- paginasi aktif dan arsip sejarah. Baku untuk tujuh hari terakhir; setiap jangkauan tanggal UTC terbatas pada hari 31. Dari adalah inklusif dan untuk eksklusif, pada presisi menit. Ringkasan dijaga asinkron dan mungkin lag gangguan pencernaan.
Otentikasi: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
cursor · query · opsional
Skema
{
"type": "string",
"minLength": 1,
"maxLength": 512
}limit · query · opsional
Skema
{
"type": "integer",
"minimum": 1,
"maximum": 50
}source · query · opsional
Skema
{
"type": "string",
"pattern": "^(google|youtube|google_[a-z]+|youtube_[a-z_]+)$"
}status · query · opsional
Skema
{
"type": "string",
"enum": [
"completed",
"failed",
"pending",
"processing"
]
}mode · query · opsional
Skema
{
"type": "string",
"enum": [
"async",
"batch",
"realtime"
]
}from · query · opsional
Skema
{
"type": "string",
"format": "date-time"
}to · query · opsional
Skema
{
"type": "string",
"format": "date-time"
}Respon
200 Halaman tugas
200 respon · application/json
{
"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 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi gagal
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/jobs/{jobId}
Baca satu Data API
Baca job.status untuk memeriksa kemajuan dan job.error jika pemrosesan gagal. JSON adalah baku; gunakan Accept: text/plain untuk teks dapat dibaca. X-Respond-With diabaikan di sini. Ikuti Retry-After ketika diberikan sebelum memeriksa lagi.
Otentikasi: cookieSession atau dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
Accept · header · opsional
application/json mengembalikan respon asli yang terstruktur; text/plain mengembalikan ruas yang sama dengan teks biasa yang tidak tertembus. Batas standar media dan berat q didukung; kurang Accept atau baku global wildcard pada JSON. X-Respond-With diabaikan pada penyerahan dan pekerjaan status titik akhir. Kesalahan tetap terstruktur JSON. Kedua tipe respon menggunakan UTF-8; sebuah set karakter eksplisit = utf - 8 parameter didukung.
Skema
{
"type": "string"
}jobId · path · dibutuhkan
Skema
{
"type": "string",
"pattern": "^job_[A-Za-z0-9_-]+$"
}Respon
200 Rincian tugas
200 respon · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"job"
],
"properties": {
"job": {
"$ref": "#/components/schemas/ConsoleJob"
}
}
}200 respon · text/plain
{
"type": "string"
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon
404 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}406 Baik application/json maupun text/plain tidak dapat diterima; respon adalah JSON
406 respon · application/json
{
"$ref": "#/components/schemas/QueryRepresentationError"
}GET/jobs/{jobId}/results
Unduh hasil async yang komplit
Secara baku, otentikasi akses dan redireksi ke sebuah privat R2 URL; klien-klien yang asli menerima JSON langsung dari R2. Accept: text/plain secara independen mengembalikan HTTP 200 dengan ruas hasil aslinya sebagai teks biasa yang tidak tertembus. X-Respond-With: markdown memilih isi Markdown: application/json membungkusnya dalam isi bersama metadata asli, menggantikan hasil; text/plain mengembalikan metadata diikuti dengan Markdown. Hilang Accept atau baku nilai global untuk JSON. Pemformatan tidak mengirimkan kuiri atau kredit query charge lain. Hasil tersimpan kadaluarsa 24 jam setelah selesai. Kesalahan tetap terstruktur JSON.
Otentikasi: cookieSession atau dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
X-Respond-With · header · opsional
Atur ke markdown untuk mengembalikan isi hasil sebagai Markdown. Abaikan untuk mempertahankan bidang hasil asli. Accept memilih secara independen JSON atau teks biasa. Hanya kueri realtime dan hasil pekerjaan selesai membaca dukungan header ini. Ini tidak mengubah pengiriman pekerjaan, status, akun APIs, callback, berkas Bulk, unduhan biner, atau protokol MCP respon.
Skema
{
"type": "string",
"enum": [
"markdown"
]
}Accept · header · opsional
Pilih application/json atau text/plain secara independen dari X-Respond-With. Tanpa X-Respond-With, text/plain mengembalikan medan asli dengan indentasi; JSON mempertahankan ruas respon asli (selesai-hasil membaca redirect ke penyimpanan). Dengan markdown, isi JSON kembali plus metadata dan teks biasa mengembalikan metadata diikuti oleh Markdown. Batas standar media dan berat q didukung; kurang Accept atau baku global wildcard pada JSON. Kedua tipe respon menggunakan UTF-8; sebuah set karakter eksplisit = utf - 8 parameter didukung.
Skema
{
"type": "string"
}jobId · path · dibutuhkan
Skema
{
"type": "string",
"pattern": "^job_[A-Za-z0-9_-]+$"
}Respon
200 Ruas asli teks plain- atau Markdown kembali secara langsung; asli JSON dari R2 setelah mengikuti redirect baku
200 respon · application/json
{
"anyOf": [
{
"$ref": "#/components/schemas/MarkdownQueryResult"
},
{
"type": "object",
"additionalProperties": true
}
]
}200 respon · text/plain
{
"type": "string"
}302 Ubah ke aslinya JSON secara pribadi R2 penyimpanan ketika JSON dipilih tanpa X-Respond-With
Header: Location
400 Nilai X-Respond-With tidak didukung; respon adalah JSON
400 respon · application/json
{
"$ref": "#/components/schemas/QueryRepresentationError"
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon
404 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}406 Baik application/json maupun text/plain tidak dapat diterima; respon adalah JSON
406 respon · application/json
{
"$ref": "#/components/schemas/QueryRepresentationError"
}409 Kondisi sumber daya atau konflik idempotency
409 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Hasil kadaluarsa
410 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Pekerjaan gagal. Jika alasan kegagalan telah disimpan, respons menyertakannya dalam properti detail.
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Ketergantungan atau katalog yang diperlukan sementara tidak tersedia
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}API pemrosesan Bulk
Bulk titik akhir yang berdedikasi memiliki referensi dengan parameter, contoh permintaan dan skema respon. Buka Bulk memproses API
GET /v2/bulk-jobs· Daftar tugas besar YouTubePOST /v2/bulk-jobs· Buat Bulk tugas dan mendapatkan file upload URLGET /v2/bulk-jobs/{bulkId}· Baca jumlah tugas besar dan kumpulanPATCH /v2/bulk-jobs/{bulkId}· Ubah pengaturan video yang belum dimulaiDELETE /v2/bulk-jobs/{bulkId}· Batalkan pekerjaan BulkPOST /v2/bulk-jobs/{bulkId}/start· Mulai memindai berkas YouTube ID yang diunggahPOST /v2/bulk-jobs/{bulkId}/pause· Jeda pekerjaan BulkPOST /v2/bulk-jobs/{bulkId}/resume· Lanjutkan pekerjaan secara manual atau otomatis jeda besarGET /v2/bulk-jobs/{bulkId}/results· Unduh daftar massa yang telah selesaiGET /v2/bulk-jobs/{bulkId}/results/{partNumber}· Unduh satu bagian hasil besar NDJSON terkompresi gzip-
Playground
POST/playground/run
Jalankan kuiri taman bermain sebagai area kerja kini
Otentikasi: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Meminta tubuh · dibutuhkan
Skema · 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
}
}
}Respon
200 Respon Upstream Data API yang ditangkap untuk taman bermain
200 respon · application/json
{
"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 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi gagal
422 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/playground/jobs/{jobId}/download
Unduh artefak Playground yang telah selesai pada peramban saat ini
Otentikasi: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
jobId · path · dibutuhkan
Skema
{
"type": "string",
"pattern": "^job_[A-Za-z0-9_-]+$"
}Respon
200 Artifak peramban sementara-unduh
Header: Content-Disposition, Content-Length
200 respon · application/octet-stream
{
"type": "string",
"format": "binary"
}401 Otentikasi diperlukan atau tak valid
401 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon
404 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Kondisi sumber daya atau konflik idempotency
409 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Artifak sementara telah berakhir
410 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Ketergantungan atau katalog yang diperlukan sementara tidak tersedia
503 respon · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Definisi skema
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
{
"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
{
"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
{
"type": "object",
"additionalProperties": false,
"properties": {
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"allowAccountBalance": {
"const": true
}
},
"required": [
"scopes",
"allowAccountBalance"
]
}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
{
"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
{
"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
{
"type": "object",
"additionalProperties": false,
"required": [
"connection"
],
"properties": {
"connection": {
"$ref": "#/components/schemas/AgentConnection"
},
"handoff": {
"type": "object",
"additionalProperties": false,
"required": [
"status"
],
"properties": {
"status": {
"type": "string"
}
}
}
}
}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
{
"type": "object",
"additionalProperties": false,
"properties": {
"connection": {
"$ref": "#/components/schemas/AgentConnection"
}
},
"required": [
"connection"
]
}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
{
"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
{
"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
{
"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
{
"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
{
"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
{
"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
{
"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
{
"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
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"billingMode": {
"type": "string"
},
"status": {
"type": "string"
}
}
}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
{
"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
{
"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
{
"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
{
"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
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"pagination"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillingPayment"
}
},
"pagination": {
"$ref": "#/components/schemas/Pagination"
}
}
}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
{
"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
{
"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
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"pagination"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkJob"
}
},
"pagination": {
"$ref": "#/components/schemas/Pagination"
}
}
}BulkJobResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"job"
],
"properties": {
"job": {
"$ref": "#/components/schemas/BulkJob"
}
}
}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
{
"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
{
"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
{
"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
{
"type": "object",
"additionalProperties": false,
"required": [
"name",
"url"
],
"properties": {
"name": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
}
}
}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
{
"type": "string",
"enum": [
"subscription_grant",
"topup_grant",
"payment_reversal",
"admin_adjustment",
"trial_grant"
]
}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
{
"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
{
"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
{
"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
{
"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
{
"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
{
"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"
}
}
}JobLink
{
"type": "object",
"additionalProperties": false,
"required": [
"rel",
"href",
"method"
],
"properties": {
"rel": {
"type": "string",
"enum": [
"self",
"results",
"content",
"download"
]
},
"href": {
"type": "string",
"format": "uri"
},
"method": {
"type": "string",
"const": "GET"
},
"expires_at": {
"type": "string",
"format": "date-time"
},
"filename": {
"type": "string"
},
"content_type": {
"type": "string"
},
"size_bytes": {
"type": "integer",
"minimum": 1
}
}
}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
{
"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
{
"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
{
"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
{
"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
{
"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
{
"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
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"pagination"
],
"properties": {
"data": {
"type": "array",
"items": {}
},
"pagination": {
"$ref": "#/components/schemas/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
{
"type": "string",
"minLength": 8,
"maxLength": 128,
"writeOnly": true
}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
{
"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
{
"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
{
"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
{
"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
{
"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
{
"type": "object",
"additionalProperties": false,
"required": [
"field",
"code",
"message"
],
"properties": {
"field": {
"type": "string"
},
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}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
{
"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
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"name",
"status"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"operational",
"degraded",
"outage"
]
}
}
}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
{
"type": "object",
"required": [
"error",
"code",
"message"
],
"properties": {
"error": {
"type": "boolean",
"const": true
},
"code": {
"type": "string",
"enum": [
"unsupported_representation",
"not_acceptable"
]
},
"message": {
"type": "string"
}
}
}Reauthentication
{
"type": "object",
"additionalProperties": false,
"required": [
"reauthenticatedUntil"
],
"properties": {
"reauthenticatedUntil": {
"type": "string",
"format": "date-time"
}
}
}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
{
"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
{
"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
{
"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
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"cancelAtPeriodEnd",
"status"
],
"properties": {
"id": {
"type": "string",
"pattern": "^sub_"
},
"cancelAtPeriodEnd": {
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"submitted"
]
}
}
}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
{
"type": "object",
"additionalProperties": false,
"required": [
"token"
],
"properties": {
"token": {
"type": "string",
"minLength": 32,
"maxLength": 256,
"writeOnly": true
}
}
}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
{
"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
{
"type": "string",
"enum": [
"pending",
"approved",
"rejected"
]
}UpdateAccountRequest
{
"type": "object",
"additionalProperties": false,
"minProperties": 1,
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 80
}
}
}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
{
"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
{
"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."
}
}
}