Semak dokumentasi
Rujukan API
Referensi manajemen API
Jelajahi titik akhir untuk rekening, kunci, tagihan dan pekerjaan. Setiap endpoint mencantumkan autentikasi dan persyaratan aksesnya sendiri.
Lun_ah Baca akun Anda dengan kunci API
Manajemen API basis URL adalah https://api.flashdata.dev/v2. Bacaan bebas ini mengembalikan kunci dan akun IDs dan kepemilikan saat ini. 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'Expect HTTP 200 untuk sukses. Periksa setiap baris Pengesahan setiap titik akhir: dataApiKey menggunakan X-API-Key; cookieSession menggunakan sesi signed-in browser. Skema respon identitasnya
Mengeluarkan spesifikasi OpenAPI pelanggan. Ini meliputi kueri, pekerjaan, rekening, kunci API dan tagihan.
Parameter pertanyaan dan kode permintaan didokumentasikan dalam Google Dan YouTube Referensi API.
Skema pengesahan skema
| Scheme | Keperluan Keperluan Kemurtadan |
|---|---|
dataApiKey |
Kunci FlashData API. Akses Job dibatasi untuk sumber kunci skop. |
cookieSession |
Sesi Web Opaque. Pelayar tidak bisa membaca kue ini. |
csrfToken |
apiKey |
agentRegistrationProof | Secara kriptografi, cryptographically random 32-byte base64url proof and exact request BEFORE pengiriman; recover hanya dengan bukti dan tubuh yang sama. Bukan token OAuth. |
agentSetupCredential | Kelayakan penyiapan sementara untuk status dan klaim penciptaan saja. Bukan kunci API. |
agentHandoffProof | Proof digunakan untuk memulihkan kunci pemilik dan mengakui instalasi. Tak pernah dikirim ke pertanyaan data. |
agentIdentityKey | Kunci FlashData API dalam Authorization Bearer, hanya pada identitas agen. Queries data menggunakan X-API-Key sebagai gantinya. |
Sistem
GET/health
Kesehatan pelayanan
Pengesahan Autentikasi Auster: Publik
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Balasan
200 Kesehatan
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/Health"
}GET/status
Woady Baca ringkasan status komponen publik
Pengesahan Autentikasi Auster: Publik
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Balasan
200 Ringkasan status publik mesum
Pengepala: Cache-Control
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/PublicStatus"
}Amerika Serikat
GET/oauth/requests/{requestId}
Otorisasi aplikasi telah dibaca dan dipadatkan ke sesi saat ini
Sesi penuh diperlukan. Permintaan untuk korban berakhir setelah sepuluh menit. Sambutan palsu.
Pengesahan Autentikasi Auster: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
requestId · path · diperlukan
Schema
{
"type": "string",
"pattern": "^fdo_[A-Za-z0-9_-]{43}$"
}Balasan
200 Hak app yang diminta LUCue
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/OAuthConsent"
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Disahihkan tetapi tidak diizinkan, atau validasi CSRF gagal
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan kedaluwarsa, digunakan, atau terikat ke sesi lain
Tanggapan 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/oauth/requests/{requestId}
Aquirove atau menyangkal permintaan otorisasi aplikasi
Sesi penuh, CSRF dan yang diizinkan untuk Origin diperlukan. Memenuhi permintaan itu sekali. Sambutan palsu.
Pengesahan Autentikasi Auster: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
requestId · path · diperlukan
Schema
{
"type": "string",
"pattern": "^fdo_[A-Za-z0-9_-]{43}$"
}Badan permintaan · diperlukan
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"decision"
],
"properties": {
"decision": {
"type": "string",
"enum": [
"approve",
"deny"
]
}
}
}Balasan
200 Panggilan balik klien terdaftar dengan kode atau penolakan, negara dan penerbit
Tanggapan 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"redirectUrl"
],
"properties": {
"redirectUrl": {
"type": "string",
"format": "uri"
}
}
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Disahihkan tetapi tidak diizinkan, atau validasi CSRF gagal
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan otorisasi tidak tersedia; memulai sambungan baru
Tanggapan 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi quest gagal
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/register
Gagal membangun akun FlashData yang tertunda
Versi Terminologi dan Privasi yang telah diajukan harus sesuai dengan bundel hukum yang diterbitkan saat ini.
Pengesahan Autentikasi Auster: Publik
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Badan permintaan · diperlukan
Schema · application/json
{
"$ref": "#/components/schemas/RegisterRequest"
}Balasan
201 Akun ukir; verifikasi email diperlukan
Pengepala: Cache-Control, X-Request-Id
Tanggapan 201 · application/json
{
"$ref": "#/components/schemas/RegisterResponse"
}409 Keadaan Sumber Daya Sumber Daya atau konflik yang tidak menguntungkan
Tanggapan 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi quest gagal
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Kadar, konkurrensi, batch, atau batas kerja tertunda terlampaui
Pengepala: Retry-After
Tanggapan 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Terjadi kesalahan internal yang tidak terduga
Tanggapan 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 TLS Sebuah dependensi atau katalog yang diperlukan tidak tersedia sementara
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/login
** Membuat sesi Web legap
- Kau sudah aman, HttpOnly `__Host-fd_session`. Akun yang Ditunda XEVE menerima sesi email_verification terlarang untuk papan tulis verifikasi. Rekening yang dapat diverifikasi yang dapat dihapus menerima kredit trial satu kali mereka saat log masuk jika belum diberikan. Akun aktif yang aktif Mereka menerima sesi penuh kecuali identitasnya masih membutuhkan Penerimaan hukum saat ini, dalam hal ini menerima pembatasan Sesi legal_acceptance. Akun yang berisi permintaan pembatalan yang dijadwalkan 289 menerima sesi deletion_recovery terlarang. Akun-akun palsu siapa yang namanya adalah... ¡processing/failed/completed, dan rekening yang ditangguhkan, menerima 403.
Pengesahan Autentikasi Auster: Publik
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Badan permintaan · diperlukan
Schema · application/json
{
"$ref": "#/components/schemas/LoginRequest"
}Balasan
200 Disahkan
Pengepala: Set-Cookie, Cache-Control, X-Request-Id
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/LoginResponse"
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Log masuk dilarang; Problem.code adalah email_not_verified, account_suspended, account_deletion_processing, account_deletion_failed, atau account_deleted
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi quest gagal
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}423 Akun sementara dikunci
Pengepala: Retry-After
Tanggapan 423 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Kadar, konkurrensi, batch, atau batas kerja tertunda terlampaui
Pengepala: Retry-After
Tanggapan 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/logout
Membatalkan sesi saat ini
Pengesahan Autentikasi Auster: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Balasan
204 Sesi Keisahan Dibatalkan dan kuki dibersihkan
Pengepala: Set-Cookie, Cache-Control, X-Request-Id
401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Disahihkan tetapi tidak diizinkan, atau validasi CSRF gagal
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/auth/me
Keperluan Baca akun dan pengguna saat ini
Pengesahan Autentikasi Auster: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Balasan
200 Akun saat ini
Pengepala: Cache-Control, X-Request-Id
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/Account"
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/auth/csrf
Dapatkan token CSRF terikat ke sesi saat ini
Pengesahan Autentikasi Auster: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Balasan
200 token CSRF
Pengepala: Cache-Control, X-Request-Id
Tanggapan 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"csrfToken"
],
"properties": {
"csrfToken": {
"type": "string",
"minLength": 32,
"readOnly": true
}
}
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/email-verifications
Permintaan atau kirim kembali pesan pengesahan email
Untuk setiap email yang sah secara sintaktis, mengembalikan respon yang sama terlepas dari apakah akun hilang, tertunda, aktif, ditangguhkan, atau dihapus. Rekening yang tak bisa ditunda menerima satu kali link yang diputar setelah pendinginan kembali.
Pengesahan Autentikasi Auster: Publik
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Badan permintaan · diperlukan
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 320
}
}
}Balasan
202 Permintaan diterima. Tanggapannya tidak menyingkapkan apakah ada kisah.
Pengepala: Cache-Control, X-Request-Id
Tanggapan 202 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"accepted"
],
"properties": {
"accepted": {
"type": "boolean",
"const": true
}
}
}422 Pengesahan permintaan otentikasi anonymous gagal
Pengepala: Cache-Control, X-Request-Id
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Melebihi batas tingkat autentikasi anonymous
Pengepala: Cache-Control, Retry-After, X-Request-Id
Tanggapan 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Terjadi galat pengesahan tak terduga tanpa nama
Pengepala: Cache-Control, X-Request-Id
Tanggapan 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Dependensi authentikasi tanpa nama tidak tersedia sementara
Pengepala: Cache-Control, X-Request-Id
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/email-verifications/confirm
Sahkan email dan aktifkan akun
Secara atomik mengkonsumsi token satu kali dan mengaktifkan Akun dan Pengguna. \"Akun Terwujud dan Peraturan Mendagri-Kerja-Kredit\" (PDF) (PDF). Log masuk tanpa pendaftaran Sesi pengguna secara eksplisit. Permintaan yang diizinkan-origin yang membawa sesi pendaftaran yang sesuai dan X-CSRF-Token nya mungkin menerima kue Sesi diputar untuk akun yang sama diverifikasi; token verifikasi saja tidak pernah tanda dalam pengguna.
Pengesahan Autentikasi Auster: Publik
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Badan permintaan · diperlukan
Schema · application/json
{
"$ref": "#/components/schemas/TokenRequest"
}Balasan
200 Akun tidak diaktifkan
Pengepala: Set-Cookie, Cache-Control, X-Request-Id
Tanggapan 200 · application/json
{
"allOf": [
{
"$ref": "#/components/schemas/Account"
},
{
"type": "object",
"properties": {
"status": {
"const": "active"
},
"emailVerified": {
"const": true
}
}
}
]
}410 Token satu kali tidak sah, kedaluwarsa, tidak sah, sudah digunakan, atau hilang sebuah balapan konfirmasi koncurrent. Problem.code adalah `token_unavailable`.
Pengepala: Cache-Control, X-Request-Id
Tanggapan 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Pengesahan permintaan otentikasi anonymous gagal
Pengepala: Cache-Control, X-Request-Id
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Melebihi batas tingkat autentikasi anonymous
Pengepala: Cache-Control, Retry-After, X-Request-Id
Tanggapan 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Terjadi galat pengesahan tak terduga tanpa nama
Pengepala: Cache-Control, X-Request-Id
Tanggapan 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Dependensi authentikasi tanpa nama tidak tersedia sementara
Pengepala: Cache-Control, X-Request-Id
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/email-verifications/session
Teruskan sesi pendaftaran asli setelah verifikasi email
Memerlukan Origin yang diizinkan dan token CSRF terikat ke password-authentikasi langsung Sesi verifikasi-email. Kembalinya kembali tertunda sampai akun milik Sesi sendiri diverifikasi, termasuk verifikasi di peramban lain. Secara atomik mencabut sesi pendaftaran dan mengeluarkan sesi penerimaan hukum atau baru. Tidak menerima akun ID, email, password atau verifikasi token, bypass penerimaan hukum, atau kredit hibah.
Pengesahan Autentikasi Auster: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Badan permintaan · diperlukan
Schema · application/json
{
"type": "object",
"additionalProperties": false
}Balasan
200 Sesi Signup signup dikilas
Pengepala: Set-Cookie, Cache-Control
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/LoginResponse"
}202 verifikasi e- mel Email tertunda; tidak ada sesi baru
Pengepala: Cache-Control
Tanggapan 202 · application/json
{
"type": "object",
"required": [
"pending"
],
"additionalProperties": false,
"properties": {
"pending": {
"type": "boolean",
"const": true
}
}
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Disahihkan tetapi tidak diizinkan, atau validasi CSRF gagal
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi quest gagal
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Terjadi kesalahan internal yang tidak terduga
Tanggapan 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/password-resets
Permintaan kata sandi reset email
2) Selalu mengembalikan respon 202 yang sama untuk email yang sah secara sintaktis terlepas dari keberadaan akun atau keadaan siklus hidup. Hanya identitas yang dapat dipilih aktif atau terkunci menerima surat.
Pengesahan Autentikasi Auster: Publik
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Badan permintaan · diperlukan
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 320
}
}
}Balasan
202 Permintaan diterima. Tanggapannya tidak menyingkapkan apakah ada kisah.
Pengepala: Cache-Control, X-Request-Id
Tanggapan 202 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"accepted"
],
"properties": {
"accepted": {
"type": "boolean",
"const": true
}
}
}422 Pengesahan permintaan otentikasi anonymous gagal
Pengepala: Cache-Control, X-Request-Id
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Melebihi batas tingkat autentikasi anonymous
Pengepala: Cache-Control, Retry-After, X-Request-Id
Tanggapan 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Terjadi galat pengesahan tak terduga tanpa nama
Pengepala: Cache-Control, X-Request-Id
Tanggapan 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Dependensi authentikasi tanpa nama tidak tersedia sementara
Pengepala: Cache-Control, X-Request-Id
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/password-resets/confirm
Lundon Tetapkan kata sandi baru dan batalkan sesi yang ada
Secara atomik mengkonsumsi token reset-sandi, menyimpan kredensial Argon2id baru, mencabut setiap Sesi yang ada, dan tidak mensahkan token reset sandi lainnya. Ia tidak log pengguna masuk atau membuat Sesi.
Pengesahan Autentikasi Auster: Publik
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Badan permintaan · diperlukan
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"token",
"password"
],
"properties": {
"token": {
"type": "string",
"minLength": 32,
"maxLength": 256,
"writeOnly": true
},
"password": {
"$ref": "#/components/schemas/Password"
}
}
}Balasan
204 Kata sandi diperbarui; sesi ada telah dibatalkan
Pengepala: Cache-Control, X-Request-Id
410 Token satu kali tidak sah, kedaluwarsa, tidak sah, sudah digunakan, atau hilang sebuah balapan konfirmasi koncurrent. Problem.code adalah `token_unavailable`.
Pengepala: Cache-Control, X-Request-Id
Tanggapan 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Pengesahan permintaan otentikasi anonymous gagal
Pengepala: Cache-Control, X-Request-Id
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Melebihi batas tingkat autentikasi anonymous
Pengepala: Cache-Control, Retry-After, X-Request-Id
Tanggapan 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Terjadi galat pengesahan tak terduga tanpa nama
Pengepala: Cache-Control, X-Request-Id
Tanggapan 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Dependensi authentikasi tanpa nama tidak tersedia sementara
Pengepala: Cache-Control, X-Request-Id
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/auth/sessions
Daftar sesi aktif untuk pengguna saat ini
Pengesahan Autentikasi Auster: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Balasan
200 Sesi-Sesi
Pengepala: Cache-Control, X-Request-Id
Tanggapan 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Session"
}
}
}
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/auth/sessions
Dibatalkan semua sesi kecuali yang sekarang
Pengesahan Autentikasi Auster: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Balasan
204 Sesi-sesi lain lain dicabut
Pengepala: Cache-Control, X-Request-Id
401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Disahihkan tetapi tidak diizinkan, atau validasi CSRF gagal
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/auth/sessions/{sessionId}
Batal Batal satu sesi
Pengesahan Autentikasi Auster: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
sessionId · path · diperlukan
Schema
{
"type": "string",
"pattern": "^ses_"
}Balasan
204 Sesi pertama dibatalkan. Jika itu Sesi saat ini, kue dibersihkan.
Pengepala: Set-Cookie, Cache-Control, X-Request-Id
401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Disahihkan tetapi tidak diizinkan, atau validasi CSRF gagal
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon
Tanggapan 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Keadaan Sumber Daya Sumber Daya atau konflik yang tidak menguntungkan
Tanggapan 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi quest gagal
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 TLS Sebuah dependensi atau katalog yang diperlukan tidak tersedia sementara
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/re-authenticate
Sahkan kata sandi saat ini untuk operasi sensitif
Mereka mencatatkan beberapa bukti baru-baru ini pada sesi sisi-server saat ini.
Pengesahan Autentikasi Auster: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Badan permintaan · diperlukan
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"password"
],
"properties": {
"password": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"writeOnly": true
}
}
}Balasan
200 Sesi baru-baru ini memiliki otentikasi
Pengepala: Cache-Control, X-Request-Id
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/Reauthentication"
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Disahihkan tetapi tidak diizinkan, atau validasi CSRF gagal
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Kadar, konkurrensi, batch, atau batas kerja tertunda terlampaui
Pengepala: Retry-After
Tanggapan 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}PATCH/auth/password
%sMasukkan kata laluan dan putar sesi saat ini
Pengesahan Autentikasi Auster: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Badan permintaan · diperlukan
Schema · 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
}
}
}Balasan
204 Kata sandi berubah; sesi saat ini diputar dan sesi lain dibatalkan ketika diminta
Pengepala: Set-Cookie, Cache-Control, X-Request-Id
401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Disahihkan tetapi tidak diizinkan, atau validasi CSRF gagal
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi quest gagal
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Akun
GET/oauth/connections
Daftarkan aplikasi yang tersambung akun ini
Sesi penuh diperlukan. Kosong ketika akun tidak memiliki aplikasi yang tersambung. Sambutan palsu.
Pengesahan Autentikasi Auster: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Balasan
200 Connected apps
Tanggapan 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuthConnection"
}
}
}
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Disahihkan tetapi tidak diizinkan, atau validasi CSRF gagal
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/oauth/connections/{grantId}
Membatalkan aplikasi bersambung dan kunci API yang didedikasikan
Sesi penuh, CSRF dan yang diizinkan untuk Origin diperlukan. Hak kepemilikan rekening telah ditegakkan. Sambutan palsu.
Pengesahan Autentikasi Auster: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
grantId · path · diperlukan
Schema
{
"type": "string",
"pattern": "^oag_[A-Za-z0-9_-]{8,}$"
}Balasan
204 otorisasi otorisasi dibatalkan
401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Disahihkan tetapi tidak diizinkan, atau validasi CSRF gagal
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon
Tanggapan 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/account
Tetapan akun Baca Tofica
Pengesahan Autentikasi Auster: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Balasan
200 Akun
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/Account"
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}PATCH/account
Tetapan profil utdatefix
Pengesahan Autentikasi Auster: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Badan permintaan · diperlukan
Schema · application/json
{
"$ref": "#/components/schemas/UpdateAccountRequest"
}Balasan
200 Akun yang dimutakhirkan oleh folder ini
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/Account"
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Disahihkan tetapi tidak diizinkan, atau validasi CSRF gagal
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi quest gagal
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/account
Rekening jadwal update menghapus dan mencabut semua sesi yang ada dan API Keys
Rekening deministrator harus memiliki peran platform mereka dicabut melalui alur kerja operator teraudit sebelum penghapusan dapat dijadwalkan. Permintaan penghapusan aktif yang unik adalah batas ketakberdayaan alami. Jadwal yang telah disahkan kembali permintaan yang sama. Setelah pembatalan sesi, respon yang hilang dipulihkan dengan masuk ke deletion_recovery Mode dan pembacaan vindon GET /account/deletion; Sesi-Sissi yang dicabut tidak pernah diterima untuk replay.
Pengesahan Autentikasi Auster: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Badan permintaan · diperlukan
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"password",
"confirmation"
],
"properties": {
"password": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"writeOnly": true
},
"confirmation": {
"type": "string",
"const": "DELETE"
}
}
}Balasan
202 Penghapusan jadwal; sesi aktif dan kunci dibatalkan
Tanggapan 202 · application/json
{
"$ref": "#/components/schemas/AccountDeletionRequest"
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Disahihkan tetapi tidak diizinkan, atau validasi CSRF gagal
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Keadaan Sumber Daya Sumber Daya atau konflik yang tidak menguntungkan
Tanggapan 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi quest gagal
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/account/deletion
Luncurkan permintaan penghapusan akun
Pengesahan Autentikasi Auster: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Balasan
200 Permintaan penghapusan saat ini
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/AccountDeletionRequest"
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon
Tanggapan 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/account/deletion
Akan ada pembatalan yang dijadwalkan pada periode rahmat
Mereka menggunakan jadwal untuk-dibatalkan-dibandingkan-dan-set. Perlombaan prosesor mengembalikan 409; setelah sukses Sesi pemulihan diputar dan tidak dapat memutar ulang transisi lama.
Pengesahan Autentikasi Auster: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Balasan
204 Pembuangan dibatalkan, rekening diaktifkan kembali, dan sesi pemulihan diputar menurut gerbang penerimaan hukum
Pengepala: Set-Cookie, Cache-Control, X-Request-Id
401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Disahihkan tetapi tidak diizinkan, atau validasi CSRF gagal
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon
Tanggapan 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Keadaan Sumber Daya Sumber Daya atau konflik yang tidak menguntungkan
Tanggapan 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/account/legal-acceptances
Accept Versi Term dan Privasi yang kini diterbitkan
1) Menempatkan penerimaan undang-undang yang tidak dapat diubah, membersihkan gerbang migrasi, dan memutar Sesi. Versi-versi yang diajukan Stale ditolak.
Pengesahan Autentikasi Auster: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Badan permintaan · diperlukan
Schema · application/json
{
"$ref": "#/components/schemas/LegalAcceptanceRequest"
}Balasan
200 Penerimaan Hukum Legal Legal mencatat dan Sesi diputar ke mode penuh
Pengepala: Set-Cookie, Cache-Control, X-Request-Id
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/LoginResponse"
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Disahihkan tetapi tidak diizinkan, atau validasi CSRF gagal
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon
Tanggapan 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi quest gagal
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Onboarding
GET/onboarding
Bould Read resumotable onboarding progress
Pengesahan Autentikasi Auster: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Balasan
200 Status onboarding saat ini
Pengepala: Cache-Control, X-Request-Id
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/OnboardingProgress"
}401 Pengesahan diperlukan atau tidak sah
Pengepala: Cache-Control, X-Request-Id
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Terjadi kesalahan internal yang tidak terduga
Pengepala: Cache-Control, X-Request-Id
Tanggapan 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Catatan ketergantungan atau onboarding yang diperlukan tidak tersedia sementara
Pengepala: Cache-Control, X-Request-Id
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}PATCH/onboarding
AWAL Maju diboarding tanpa memungkinkan kemajuan untuk bergerak mundur
Pengesahan Autentikasi Auster: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Badan permintaan · diperlukan
Schema · application/json
{
"$ref": "#/components/schemas/UpdateOnboardingRequest"
}Balasan
200 Updated onboarding state
Pengepala: Cache-Control, X-Request-Id
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/OnboardingProgress"
}401 Pengesahan diperlukan atau tidak sah
Pengepala: Cache-Control, X-Request-Id
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Disahihkan tetapi tidak diizinkan, atau validasi CSRF gagal
Pengepala: Cache-Control, X-Request-Id
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Keadaan Sumber Daya Sumber Daya atau konflik yang tidak menguntungkan
Pengepala: Cache-Control, X-Request-Id
Tanggapan 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi quest gagal
Pengepala: Cache-Control, X-Request-Id
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Terjadi kesalahan internal yang tidak terduga
Pengepala: Cache-Control, X-Request-Id
Tanggapan 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Catatan ketergantungan atau onboarding yang diperlukan tidak tersedia sementara
Pengepala: Cache-Control, X-Request-Id
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Gambaran keseluruhan
GET/overview
BARIS Baca agregat dashboard akun
Pengesahan Autentikasi Auster: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Balasan
200 Sekilas pandang tentang akun-teropong
Pengepala: Cache-Control, X-Request-Id
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/ConsoleOverview"
}401 Pengesahan diperlukan atau tidak sah
Pengepala: Cache-Control, X-Request-Id
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Terjadi kesalahan internal yang tidak terduga
Pengepala: Cache-Control, X-Request-Id
Tanggapan 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Catatan ketergantungan atau onboarding yang diperlukan tidak tersedia sementara
Pengepala: Cache-Control, X-Request-Id
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}API Keys
GET/api-access/identity
Tidak ada verifikasi saat ini kepemilikan kunci API dan beresolusi berulang
Token API-key gratis dibaca. Kemuliaan account/key IDs dan kepemilikan berwibawa. Tidak ada tubuh permintaan. Tidak mengubah respon metadata /api-access yang ada. Kongsi batas baca akun 120/minute. Gagal tutup pada unavailability; jangan menyimpulkan kepemilikan dari awalan kunci, rencana, atau negara lokal. Tidak ada parameter pertanyaan yang diterima. Sambutan yang tidak ada toko.
Pengesahan Autentikasi Auster: dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Balasan
200 Tidak ada verifikasi saat ini kepemilikan kunci API dan beresolusi berulang
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/APIKeyIdentity"
}400 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-keys
Daftar data meta kunci API
Pengesahan Autentikasi Auster: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Balasan
200 API Keys Kerahsiaan tanpa rahasia
Tanggapan 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiKey"
}
}
}
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/api-keys
\"Kunci API\" dan mengungkapkan rahasianya sekali
Pengesahan Autentikasi Auster: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
Idempotency-Key · header · diperlukan
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Badan permintaan · diperlukan
Schema · application/json
{
"$ref": "#/components/schemas/CreateApiKeyRequest"
}Balasan
201 Diciptakan; replay idempoten yang sama dapat mengembalikan respon terenkripsi yang sama selama lima menit
Tanggapan 201 · application/json
{
"$ref": "#/components/schemas/ApiKeyCreated"
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Disahihkan tetapi tidak diizinkan, atau validasi CSRF gagal
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Keadaan Sumber Daya Sumber Daya atau konflik yang tidak menguntungkan
Tanggapan 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi quest gagal
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 TLS Sebuah dependensi atau katalog yang diperlukan tidak tersedia sementara
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/api-keys/{keyId}
Batalkan Kunci API
Pengesahan Autentikasi Auster: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
keyId · path · diperlukan
Schema
{
"type": "string",
"pattern": "^key_"
}Balasan
204 Batal
401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Disahihkan tetapi tidak diizinkan, atau validasi CSRF gagal
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon
Tanggapan 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 TLS Sebuah dependensi atau katalog yang diperlukan tidak tersedia sementara
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/api-keys/{keyId}/rotate
Wofred Membuat kunci pengganti dan jadwal pembatalan kunci lama
Aisquix membuat kunci baru dan membuat kunci lama tetap aktif sampai revokeOldAt. Secara default, tumpang tindih berlangsung 24 jam atau sampai kunci lama berakhir, yang mana sebelumnya. revokeOldAt yang biasa harus berada di masa depan, dalam waktu tujuh hari, dan tidak lebih lambat dari ekspirator kunci lama.
Pengesahan Autentikasi Auster: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
keyId · path · diperlukan
Schema
{
"type": "string",
"pattern": "^key_"
}Idempotency-Key · header · diperlukan
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Badan permintaan · ORANG pilihan
Schema · 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."
}
}
}Balasan
201 Penggantian pengganti diciptakan; rahasia kembali sekali
Tanggapan 201 · application/json
{
"$ref": "#/components/schemas/ApiKeyCreated"
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Disahihkan tetapi tidak diizinkan, atau validasi CSRF gagal
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon
Tanggapan 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Keadaan Sumber Daya Sumber Daya atau konflik yang tidak menguntungkan
Tanggapan 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi quest gagal
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 TLS Sebuah dependensi atau katalog yang diperlukan tidak tersedia sementara
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-access
Dia membaca panggilan kunci API sumber yang sah dan hasil asal
Bebas, pengesahan X-API-Key. Pengembalian hanya diberikan publik nama sumber dan konfigurasi signed-result asal penyimpanan (null jika TLS tidak Ada). Easing Tidak ada akun ID, kunci ID, rahasia atau kredensial penyimpanan dikembalikan. MCP lokal merevisi titik akhir ini sebelum setiap penemuan alat dan panggilan, Termasuk bacaan hasil cache. Tidak ada parameter pertanyaan atau badan permintaan yang diterima. Semua rute /api-access berbagi permintaan 120 per menit per klien IP dan kembali Cache-Control swasta, tidak ada-toko. Kunci normal pelacakan terakhir yang digunakan masih terjadi.
Pengesahan Autentikasi Auster: dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Balasan
200 Sumber-sumber publik yang berwenang dan hasil-hasil asal
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/ApiAccess"
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi quest gagal
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Terlalu banyak akun dibaca; coba lagi setelah jendela batas-nilai
503 TLS Sebuah dependensi atau katalog yang diperlukan tidak tersedia sementara
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Sambungan Agen Infeksi
GET/agent-connections/capabilities
Discover protokol 2 onboarding ketersediaan
Tidak ada parameter pertanyaan yang diterima. Sambutan yang tidak ada toko. Rute agensi adalah manajemen-hanya dan feature-gated; penyebaran dapat mengembalikan 404 ketika dinonaktifkan. X-API-Key dilarang pada rute agen.
Pengesahan Autentikasi Auster: Publik
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Balasan
200 Discover protokol 2 onboarding ketersediaan
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/AgentCapabilities"
}400 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/registrations
Buat atau pulihkan sambungan kunci API sementara
Wachida membela bukti pendaftaran dan masukan tepat sebelum POST. Bukti yang sama dan tubuh memulihkan persidangan yang sama; mengubah hasil masukan konflik. Uji coba sementara: 1 Credit, 72 Jam, 1 request/second, ukuran batch 1. Batas jangkauan sumber tetap berwibawa pada server. Tidak ada parameter pertanyaan yang diterima. Sambutan yang tidak ada toko. Rute agensi adalah manajemen-hanya dan feature-gated; penyebaran dapat mengembalikan 404 ketika dinonaktifkan. X-API-Key dilarang pada rute agen.
Pengesahan Autentikasi Auster: agentRegistrationProof
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Badan permintaan · diperlukan
Schema · application/json
{
"$ref": "#/components/schemas/AgentRegistrationRequest"
}Balasan
201 Buat atau pulihkan sambungan kunci API sementara
Tanggapan 201 · application/json
{
"$ref": "#/components/schemas/AgentRegistration"
}400 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/owned
Senaraikan sambungan milik-pelayar
Tidak ada parameter pertanyaan yang diterima. Sambutan yang tidak ada toko. Rute agensi adalah manajemen-hanya dan feature-gated; penyebaran dapat mengembalikan 404 ketika dinonaktifkan. X-API-Key dilarang pada rute agen. Operasi kapal penjelajah. Sesi Terverifikasi Penuh KONCOD diperlukan; penelepon tidak boleh menggantikan kunci atau bukti API.
Pengesahan Autentikasi Auster: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Balasan
200 Senaraikan sambungan milik-pelayar
Tanggapan 200 · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"connections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentConnection"
}
}
},
"required": [
"connections"
]
}400 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/{connectionId}
UVN Baca status sambungan sementara
Tidak ada parameter pertanyaan yang diterima. Sambutan yang tidak ada toko. Rute agensi adalah manajemen-hanya dan feature-gated; penyebaran dapat mengembalikan 404 ketika dinonaktifkan. X-API-Key dilarang pada rute agen.
Pengesahan Autentikasi Auster: agentSetupCredential
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
connectionId · path · diperlukan
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Balasan
200 UVN Baca status sambungan sementara
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/AgentConnectionResponse"
}400 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/agent-connections/{connectionId}
Membatalkan sambungan yang dimiliki
Tidak ada parameter pertanyaan yang diterima. Sambutan yang tidak ada toko. Rute agensi adalah manajemen-hanya dan feature-gated; penyebaran dapat mengembalikan 404 ketika dinonaktifkan. X-API-Key dilarang pada rute agen. Operasi kapal penjelajah. Sesi Terverifikasi Penuh KONCOD diperlukan; penelepon tidak boleh menggantikan kunci atau bukti API.
Pengesahan Autentikasi Auster: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
connectionId · path · diperlukan
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Origin · header · diperlukan
Schema
{
"type": "string"
}X-CSRF-Token · header · diperlukan
Schema
{
"type": "string"
}Balasan
204 Membatalkan sambungan yang dimiliki
400 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/{connectionId}/identity
Sahkan kunci API untuk sambungan
Tidak ada parameter pertanyaan yang diterima. Sambutan yang tidak ada toko. Rute agensi adalah manajemen-hanya dan feature-gated; penyebaran dapat mengembalikan 404 ketika dinonaktifkan. X-API-Key dilarang pada rute agen.
Pengesahan Autentikasi Auster: agentIdentityKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
connectionId · path · diperlukan
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Balasan
200 Sahkan kunci API untuk sambungan
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/AgentConnectionResponse"
}400 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/{connectionId}/onboarding
BAHAYA BACA dapat dibaca pada kondisi papan
Tidak ada parameter pertanyaan yang diterima. Sambutan yang tidak ada toko. Rute agensi adalah manajemen-hanya dan feature-gated; penyebaran dapat mengembalikan 404 ketika dinonaktifkan. X-API-Key dilarang pada rute agen.
Pengesahan Autentikasi Auster: agentHandoffProof
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
connectionId · path · diperlukan
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Balasan
200 BAHAYA BACA dapat dibaca pada kondisi papan
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/AgentOnboardingStatus"
}400 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/{connectionId}/claims
Mewujudkan klaim persetujuan peramban
Open claimPath pada FlashData terpercaya asal web dan menampilkan kode secara terpisah. Jangan pernah menempatkan kredensial atau kode konfirmasi dalam URL. Tidak ada parameter pertanyaan yang diterima. Sambutan yang tidak ada toko. Rute agensi adalah manajemen-hanya dan feature-gated; penyebaran dapat mengembalikan 404 ketika dinonaktifkan. X-API-Key dilarang pada rute agen.
Pengesahan Autentikasi Auster: agentSetupCredential
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
connectionId · path · diperlukan
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Badan permintaan · diperlukan
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {},
"required": []
}Balasan
201 Mewujudkan klaim persetujuan peramban
Tanggapan 201 · application/json
{
"$ref": "#/components/schemas/AgentClaim"
}400 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/claims/{claimId}/confirm
Konfirmasi kode klaim dalam sesi peramban yang diverifikasi
Tidak ada parameter pertanyaan yang diterima. Sambutan yang tidak ada toko. Rute agensi adalah manajemen-hanya dan feature-gated; penyebaran dapat mengembalikan 404 ketika dinonaktifkan. X-API-Key dilarang pada rute agen. Operasi kapal penjelajah. Sesi Terverifikasi Penuh KONCOD diperlukan; penelepon tidak boleh menggantikan kunci atau bukti API.
Pengesahan Autentikasi Auster: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
claimId · path · diperlukan
Schema
{
"type": "string",
"pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}Origin · header · diperlukan
Schema
{
"type": "string"
}X-CSRF-Token · header · diperlukan
Schema
{
"type": "string"
}Badan permintaan · diperlukan
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"pattern": "^\\d{8}$"
}
},
"required": [
"code"
]
}Balasan
200 Konfirmasi kode klaim dalam sesi peramban yang diverifikasi
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/AgentBrowserClaim"
}400 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/claims/{claimId}
Mebaca klaim yang dikonfirmasi dalam sesi perambannya
Tidak ada parameter pertanyaan yang diterima. Sambutan yang tidak ada toko. Rute agensi adalah manajemen-hanya dan feature-gated; penyebaran dapat mengembalikan 404 ketika dinonaktifkan. X-API-Key dilarang pada rute agen. Operasi kapal penjelajah. Sesi Terverifikasi Penuh KONCOD diperlukan; penelepon tidak boleh menggantikan kunci atau bukti API.
Pengesahan Autentikasi Auster: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
claimId · path · diperlukan
Schema
{
"type": "string",
"pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}Balasan
200 Mebaca klaim yang dikonfirmasi dalam sesi perambannya
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/AgentClaimView"
}400 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/claims/{claimId}/approve
Aprove rangkuman berkurang dan dana keseimbangan akun
Tidak ada parameter pertanyaan yang diterima. Sambutan yang tidak ada toko. Rute agensi adalah manajemen-hanya dan feature-gated; penyebaran dapat mengembalikan 404 ketika dinonaktifkan. X-API-Key dilarang pada rute agen. Operasi kapal penjelajah. Sesi Terverifikasi Penuh KONCOD diperlukan; penelepon tidak boleh menggantikan kunci atau bukti API.
Pengesahan Autentikasi Auster: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
claimId · path · diperlukan
Schema
{
"type": "string",
"pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}Origin · header · diperlukan
Schema
{
"type": "string"
}X-CSRF-Token · header · diperlukan
Schema
{
"type": "string"
}Badan permintaan · diperlukan
Schema · application/json
{
"$ref": "#/components/schemas/AgentApproval"
}Balasan
200 Aprove rangkuman berkurang dan dana keseimbangan akun
Tanggapan 200 · 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 yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/{connectionId}/handoff
Pulihkan kembali kunci API pemilik yang disetujui
Kunci calon wanita kadaluarsa berakhir pada jam 24 sampai pemasangan ACK. Secara atom, reload dalam proses segar dan verifikasi identitas sebelum ACK. VETAH Sebuah pengiriman berulang-ulang memulihkan calon yang sama; pengiriman dikonfirmasi mengembalikan penerimaan tanpa kelayakan. Tidak ada parameter pertanyaan yang diterima. Sambutan yang tidak ada toko. Rute agensi adalah manajemen-hanya dan feature-gated; penyebaran dapat mengembalikan 404 ketika dinonaktifkan. X-API-Key dilarang pada rute agen.
Pengesahan Autentikasi Auster: agentHandoffProof
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
connectionId · path · diperlukan
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Badan permintaan · diperlukan
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {},
"required": []
}Balasan
200 Pulihkan kembali kunci API pemilik yang disetujui
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/AgentHandoff"
}400 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/{connectionId}/handoff/ack
Mengakui pemasangan kunci-pemilik yang telah disahkan
Dia pasti sudah menyelamatkan kandidat dan memverifikasinya secara independen dalam proses baru. Bekas ACK yang sukses sukses dipasang, menghapus kunci calon yang luput dan menghapus materi kredensial yang dapat dipulihkan. ACK yang berulang-ulang adalah tak ternilai. Tidak ada parameter pertanyaan yang diterima. Sambutan yang tidak ada toko. Rute agensi adalah manajemen-hanya dan feature-gated; penyebaran dapat mengembalikan 404 ketika dinonaktifkan. X-API-Key dilarang pada rute agen.
Pengesahan Autentikasi Auster: agentHandoffProof
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
connectionId · path · diperlukan
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Badan permintaan · diperlukan
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"apiKey": {
"type": "string"
}
},
"required": [
"apiKey"
]
}Balasan
200 Mengakui pemasangan kunci-pemilik yang telah disahkan
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/AgentHandoff"
}400 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Permintaan yang ditolak; memeriksa kode Masalah. Jangan pernah mencoba lagi mutasi membabi buta.
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Katalog
GET/catalog/sources
Daftarkan kemampuan sumber publik tanpa prioritas khusus akun
Pengesahan Autentikasi Auster: Publik
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Balasan
200 Katalog sumber umum untuk katalog
Pengepala: Cache-Control
Tanggapan 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSource"
}
}
}
}GET/plans
Daftar nigois publik USD rencana dan harga
Pengesahan Autentikasi Auster: Publik
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Balasan
200 Katalog rencana publik untuk katalog
Pengepala: Cache-Control
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/PlanCatalog"
}GET/legal/current
Versi Terma dan Privasi saat ini diperlukan untuk pendaftaran
Pengesahan Autentikasi Auster: Publik
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Balasan
200 Katalog versi legal saat ini
Pengepala: Cache-Control
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/PublicLegalVersions"
}Billing
GET/billing/subscription
Langganan Stripe yang efektif
Pengesahan Autentikasi Auster: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Balasan
200 Langganan atau PAYG
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/Subscription"
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/checkout-sessions
Buat Sesi Pemeriksaan Berhost Jalur
Langganan dan kemasan kredit yang diterbitkan menggunakan priceId. Sebuah top-up suai menggunakan amountMinorQ sebagai gantinya (sen USD, $10 ke $999,999.99); server menghitung kredit pada nilai kredit tetap dan menciptakan harga Stripe satu kali swasta. Produk project, harga penyedia, mata uang, keberhasilan URL dan batal URL tidak pernah diterima dari browser. Penghargaan diberikan hanya setelah acara yang telah diverifikasi dibayar untuk jumlah yang dikutip.
Pengesahan Autentikasi Auster: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
Idempotency-Key · header · diperlukan
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Badan permintaan · diperlukan
Schema · 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"
}
}
}
]
}Balasan
201 Sesi Pemeriksaan Jalur Jalur
Tanggapan 201 · application/json
{
"$ref": "#/components/schemas/HostedSession"
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Disahihkan tetapi tidak diizinkan, atau validasi CSRF gagal
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Keadaan Sumber Daya Sumber Daya atau konflik yang tidak menguntungkan
Tanggapan 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi quest gagal
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Sebuah provider hulu gagal
Tanggapan 502 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Katalog atau penyedia billing tidak dikonfigurasi atau sementara tidak tersedia
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/subscription-changes
upgrade langgan Stripe saat ini ke harga yang lebih tinggi diterbitkan
Server tersebut memverifikasi bahwa harga FlashData aktif, tersedia dalam livemode saat ini, USD-terdenominasi, berulang, interval yang sama, dan sangat mahal daripada harga langganan saat ini. Produk product, harga penyedia, opsi mata uang dan prorasi tidak pernah diterima dari browser. Ongkos lokal dan kredit berubah hanya setelah acara provider yang diverifikasi diproyeksikan.
Pengesahan Autentikasi Auster: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
Idempotency-Key · header · diperlukan
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Badan permintaan · diperlukan
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"priceId"
],
"properties": {
"priceId": {
"type": "string",
"pattern": "^prc_"
}
}
}Balasan
201 Perubahan Langganan diserahkan ke Jalur
Tanggapan 201 · application/json
{
"$ref": "#/components/schemas/SubscriptionChange"
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Disahihkan tetapi tidak diizinkan, atau validasi CSRF gagal
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon
Tanggapan 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Keadaan Sumber Daya Sumber Daya atau konflik yang tidak menguntungkan
Tanggapan 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi quest gagal
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Sebuah provider hulu gagal
Tanggapan 502 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Katalog atau penyedia billing tidak dikonfigurasi atau sementara tidak tersedia
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/portal-sessions
Ogos Buat Sesi Pelanggan Jalur
Pengesahan Autentikasi Auster: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
Idempotency-Key · header · diperlukan
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Balasan
201 Sesi Pelanggan Jalur Jalur Jalur
Tanggapan 201 · application/json
{
"$ref": "#/components/schemas/HostedSession"
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Disahihkan tetapi tidak diizinkan, atau validasi CSRF gagal
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon
Tanggapan 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Keadaan Sumber Daya Sumber Daya atau konflik yang tidak menguntungkan
Tanggapan 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Sebuah provider hulu gagal
Tanggapan 502 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Katalog atau penyedia billing tidak dikonfigurasi atau sementara tidak tersedia
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/subscription-cancellation
Jadwal atau pembatalan pembatalan pembatalan langganan berbayar saat ini
Menetapkan cancelAtPeriodEnd ke true jadwal pembatalan pada periode penagihan saat ini berakhir; false menyimpan langganan. \"Update EN titlements\" setelah acara langganan Stripe yang disahkan. Titik akhir ini tidak pernah membatalkan segera atau isu pengembalian uang.
Pengesahan Autentikasi Auster: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
Idempotency-Key · header · diperlukan
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Badan permintaan · diperlukan
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"cancelAtPeriodEnd"
],
"properties": {
"cancelAtPeriodEnd": {
"type": "boolean"
}
}
}Balasan
202 Pemutakhiran pembatalan update update diajukan ke Jalur
Tanggapan 202 · application/json
SubscriptionCancellationChange
{
"$ref": "#/components/schemas/SubscriptionCancellationChange"
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Disahihkan tetapi tidak diizinkan, atau validasi CSRF gagal
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon
Tanggapan 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Keadaan Sumber Daya Sumber Daya atau konflik yang tidak menguntungkan
Tanggapan 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi quest gagal
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Sebuah provider hulu gagal
Tanggapan 502 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Katalog atau penyedia billing tidak dikonfigurasi atau sementara tidak tersedia
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/billing/invoices
Proyeksi faktur Daftar stripgo
Pengesahan Autentikasi Auster: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
cursor · query · ORANG pilihan
Schema
{
"type": "string",
"maxLength": 512
}limit · query · ORANG pilihan
Schema
{
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}Balasan
200 voices
401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/billing/payments
Daftar akun-terscope top-up dan pengembalian proyeksi pembayaran
Pengesahan Autentikasi Auster: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
cursor · query · ORANG pilihan
Schema
{
"type": "string",
"maxLength": 512
}limit · query · ORANG pilihan
Schema
{
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}Balasan
200 Sejarah pembayaran satu kali tanpa rahasia penyedia
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/BillingPaymentPage"
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Kredit
GET/api-access/balance
Keseimbangan baca akun langsung menggunakan kunci API
Keterjemahan kredit saat ini dibagikan oleh semua kunci API di akun Anda. Pemesananan-perlengkapan yang dilakukan dapat mengurangi keseimbangan yang tersedia. Permintaan ini tidak dikenakan biaya kredit dan tidak mengambil parameter pertanyaan atau tubuh. Sambutan bersifat pribadi dan tidak dicache; batas tingkat baca akun berlaku.
Pengesahan Autentikasi Auster: dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Balasan
200 Penghargaan yang tersedia dan tidak negatif
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/ApiAccessBalance"
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi quest gagal
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Terlalu banyak akun dibaca; coba lagi setelah jendela batas-nilai
503 TLS Sebuah dependensi atau katalog yang diperlukan tidak tersedia sementara
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-access/pricing
Baca harga rekening yang sebenarnya untuk sumber-sumber yang disahkan oleh API Kuncinya adalah
Kau harus membaca tarif rekeningmu untuk sumber yang diizinkan oleh kunci API. Sebuah harga null berarti bahwa sumber tidak tersedia. request_count menghitung kueri, tidak mengembalikan item; tarif unduh adalah per TB (10Q^12 bytes). Perkiraan tidak memberikan jaminan kredit atau kapasitas. Permintaan ini tidak membutuhkan biaya kredit. Sambutan bersifat pribadi dan tidak dicache; batas tingkat baca akun berlaku.
Pengesahan Autentikasi Auster: dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
source · query · ORANG pilihan
Sumber sumber diberikan kepada kunci ini; abaikan untuk membaca semua sumber yang diberikan.
Schema
{
"$ref": "#/components/schemas/ApiAccessSource"
}request_count · query · ORANG pilihan
Nomor bilangan bulat desimal dari panggilan; tidak memperkirakan ukuran unduh.
Schema
{
"type": "integer",
"minimum": 1,
"maximum": 100000,
"default": 1
}Balasan
200 Rencana akun dan harga khusus sumber
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/ApiAccessPricing"
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Disahihkan tetapi tidak diizinkan, atau validasi CSRF gagal
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi quest gagal
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Terlalu banyak akun dibaca; coba lagi setelah jendela batas-nilai
503 TLS Sebuah dependensi atau katalog yang diperlukan tidak tersedia sementara
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-access/limits
Keterbatasan rencana akun baca dan pekerjaan tertangguh saat ini menggunakan kunci API
Kesewaan membaca konkurensi Anda, batch-size dan batas pekerjaan tertunda, ditambah jumlah yang tertunda saat ini. Nilai-nilai ini membantu perencanaan permintaan tetapi tidak reserve kapasitas. Permintaan ini tidak dikenakan biaya kredit dan tidak mengambil parameter pertanyaan atau tubuh. Sambutan bersifat pribadi dan tidak dicache; batas tingkat baca akun berlaku.
Pengesahan Autentikasi Auster: dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Balasan
200 [ Gambar di hlm
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/ApiAccessLimits"
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi quest gagal
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Terlalu banyak akun dibaca; coba lagi setelah jendela batas-nilai
503 TLS Sebuah dependensi atau katalog yang diperlukan tidak tersedia sementara
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/usage
Penggunaan akun baca untuk sumber yang disahkan oleh kunci API
Bacaan gratis, dikonfirmasi hanya oleh X-API-Key. Termasuk semua kunci akun tetapi sumber hanya diberikan ke kunci panggilan. Jangan kembalikan teks pertanyaan, kunci, Rincian pembayaran atau rekening lain. Default ke tujuh hari; maksimum 31 hari. Tanggal harus menggunakan setem waktu UTC Z. Dari adalah inklusif dan eksklusif; Kedua-duanya dibulatkan ke bawah ke menit. Dengan dari sendiri, ke default dari + 7 hari. Dengan tidak keduanya, untuk adalah awal menit berikutnya. Akhirnya Agregat Agragat Uniform konsistensi; bahkan mengupdate=false tidak menjamin semua peristiwa baru-baru ini ditelan. Batas baca: Permintaan 60 per menit per klien IP.
Pengesahan Autentikasi Auster: dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
source · query · ORANG pilihan
Sebuah sumber katalog yang tepat diberikan kepada kunci panggilan; diabaikan berarti semua sumber diberikan.
Schema
{
"type": "string",
"enum": [
"google_search",
"google_images",
"google_news",
"google_shopping",
"google_videos",
"google_places",
"youtube_search",
"youtube_search_extended",
"youtube_metadata",
"youtube_transcript",
"youtube_captions",
"youtube_trainability",
"youtube_channel",
"youtube_suggestions",
"youtube_download"
]
}from · query · ORANG pilihan
Schema
{
"type": "string",
"format": "date-time"
}to · query · ORANG pilihan
Schema
{
"type": "string",
"format": "date-time"
}Balasan
200 Surat permintaan yang terkutip dan terutang, dengan informasi kesegaran
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/ApiKeyUsage"
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Disahihkan tetapi tidak diizinkan, atau validasi CSRF gagal
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi quest gagal
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Terlalu banyak penggunaan dibaca; coba lagi setelah jendela batas-nilai
503 TLS Sebuah dependensi atau katalog yang diperlukan tidak tersedia sementara
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/credits/balance
Kerugian yang tersedia dan disediakan saat ini
Pengesahan Autentikasi Auster: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Balasan
200 Keseimbangan kredit
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/CreditBalance"
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/credits/policy
¡Mebaca kredit rekening efektif hibah dan pengisian kebijakan
Pengesahan Autentikasi Auster: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Balasan
200 Kebijakan kredit yang efektif
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/CreditPolicy"
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/credits/transactions
Daftar entri buku besar kredit lemagon
Pengesahan Autentikasi Auster: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
cursor · query · ORANG pilihan
Schema
{
"type": "string",
"maxLength": 512
}limit · query · ORANG pilihan
Schema
{
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}type · query · ORANG pilihan
Schema
{
"$ref": "#/components/schemas/CreditEntryType"
}Balasan
200 Entri Ledger
Tanggapan 200 · application/json
{
"allOf": [
{
"$ref": "#/components/schemas/Page"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditTransaction"
}
}
}
}
]
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Kredit Cobaan
GET/trial-credit-request
Kelayakan Trial Kredit Baca Keteradilan dan permintaan seumur hidup akun
Pengesahan Autentikasi Auster: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Balasan
200 Kesetaraan, hibah dikonfigurasi, dan permintaan saat ini
Pengepala: Cache-Control
Tanggapan 200 · application/json
{
"$ref": "#/components/schemas/TrialCreditState"
}401 Pengesahan diperlukan atau tidak sah
Pengepala: Cache-Control, X-Request-Id
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Terjadi kesalahan internal yang tidak terduga
Pengepala: Cache-Control, X-Request-Id
Tanggapan 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Catatan ketergantungan atau onboarding yang diperlukan tidak tersedia sementara
Pengepala: Cache-Control, X-Request-Id
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/trial-credit-request
Serahkan satu permintaan kredit percobaan seumur hidup pada rekening itu
Jumlah percobaan dan kasus penggunaan disimpan ketika Anda mengajukan permintaan.
Pengesahan Autentikasi Auster: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
Idempotency-Key · header · diperlukan
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Badan permintaan · ORANG pilihan
Schema · application/json
{
"type": "object",
"additionalProperties": false
}Balasan
201 Permintaan Penghargaan Trialosis yang dibuat dan disetujui secara otomatis untuk akun yang dapat diverifikasi, terlepas dari penyedia email
Pengepala: Cache-Control
Tanggapan 201 · application/json
{
"$ref": "#/components/schemas/TrialCreditState"
}401 Pengesahan diperlukan atau tidak sah
Pengepala: Cache-Control, X-Request-Id
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Disahihkan tetapi tidak diizinkan, atau validasi CSRF gagal
Pengepala: Cache-Control, X-Request-Id
Tanggapan 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Keadaan Sumber Daya Sumber Daya atau konflik yang tidak menguntungkan
Pengepala: Cache-Control, X-Request-Id
Tanggapan 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi quest gagal
Pengepala: Cache-Control, X-Request-Id
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Terjadi kesalahan internal yang tidak terduga
Pengepala: Cache-Control, X-Request-Id
Tanggapan 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Catatan ketergantungan atau onboarding yang diperlukan tidak tersedia sementara
Pengepala: Cache-Control, X-Request-Id
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Pengiriman
GET/delivery/webhooks
Daftar pelengkapan selesai yang disimpan panggil balik URLs
Pengesahan Autentikasi Auster: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Balasan
200 Panggilbalik URLs
Tanggapan 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeliveryWebhook"
}
}
}
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/delivery/webhooks
Simpan komplesi callback URL
Pengesahan Autentikasi Auster: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Badan permintaan · diperlukan
Schema · application/json
{
"$ref": "#/components/schemas/CreateDeliveryWebhookRequest"
}Balasan
201 Dibuat
Tanggapan 201 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"webhook"
],
"properties": {
"webhook": {
"$ref": "#/components/schemas/DeliveryWebhook"
}
}
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi quest gagal
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/delivery/webhooks/{webhookId}
Keluarkan sebuah pelengkapan callback URL
Pengesahan Autentikasi Auster: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
webhookId · path · diperlukan
Schema
{
"type": "string",
"pattern": "^cbk_[A-Za-z0-9_-]{8,}$"
}Balasan
204 Dihapus
401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon
Tanggapan 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/delivery/webhooks/{webhookId}/test
Kirim sampel muatan lengkap muat turun
Pengesahan Autentikasi Auster: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
webhookId · path · diperlukan
Schema
{
"type": "string",
"pattern": "^cbk_[A-Za-z0-9_-]{8,}$"
}Balasan
200 Ujian dicuba
Tanggapan 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"statusCode",
"webhook"
],
"properties": {
"statusCode": {
"type": "integer",
"minimum": 0
},
"webhook": {
"$ref": "#/components/schemas/DeliveryWebhook"
}
}
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon
Tanggapan 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Tugas
Untuk penyerahan, status, dan contoh hasil, lihat Realtime dan async · Permintaan Batch.
GET/jobs
Daftar Data API pekerjaan untuk ruang kerja saat ini
\"Kerdisor-dicatin aktif dan sejarah arsip\". Lalai sampai tujuh hari terakhir; setiap rentang tanggal UTC dibatasi untuk hari 31. Dari adalah inklusif dan untuk eksklusif, pada presisi menit. Orang - orang yang disummera dipelihara secara sinkron dan mungkin tergugat.
Pengesahan Autentikasi Auster: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
cursor · query · ORANG pilihan
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 512
}limit · query · ORANG pilihan
Schema
{
"type": "integer",
"minimum": 1,
"maximum": 50
}source · query · ORANG pilihan
Schema
{
"type": "string",
"pattern": "^(google|youtube|google_[a-z]+|youtube_[a-z_]+)$"
}status · query · ORANG pilihan
Schema
{
"type": "string",
"enum": [
"completed",
"failed",
"pending",
"processing"
]
}mode · query · ORANG pilihan
Schema
{
"type": "string",
"enum": [
"async",
"batch",
"realtime"
]
}from · query · ORANG pilihan
Schema
{
"type": "string",
"format": "date-time"
}to · query · ORANG pilihan
Schema
{
"type": "string",
"format": "date-time"
}Balasan
200 Halaman Ayub
Tanggapan 200 · 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 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi quest gagal
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/jobs/{jobId}
Baca satu Data API pekerjaan
Keanekagunaan baca job.status untuk memeriksa kemajuan dan job.error jika pemrosesan gagal. JSON BAHASA default; gunakan Accept: text/plain Untuk teks yang bisa dibaca. X-Respond-With diabaikan di sini. Ikuti Retry-After ketika diberikan sebelum memeriksa lagi.
Pengesahan Autentikasi Auster: cookieSession OR atau ORANG dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
Accept · header · ORANG pilihan
application/json mengembalikan respon terstruktur asli; text/plain mengembalikan bidang yang sama seperti teks biasa yang diindentasi. Rentang media standard dan bobot q didukung; hilang Accept atau baku wildcard global ke JSON. X-Respond-With ¡ ¡diabaikan pada penyerahan dan titik akhir status pekerjaan. Galat tetap terstruktur JSON. Kedua tipe respon aksara ringan menggunakan UTF-8; sebuah parameter set karakter eksplisit=utf-8 didukung.
Schema
{
"type": "string"
}jobId · path · diperlukan
Schema
{
"type": "string",
"pattern": "^job_[A-Za-z0-9_-]+$"
}Balasan
200 Rincian pekerjaan
Tanggapan 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"job"
],
"properties": {
"job": {
"$ref": "#/components/schemas/ConsoleJob"
}
}
}Tanggapan 200 · text/plain
{
"type": "string"
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon
Tanggapan 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}406 Baik baik application/json maupun text/plain tidak dapat diterima; respon adalah JSON
Tanggapan 406 · application/json
{
"$ref": "#/components/schemas/QueryRepresentationError"
}GET/jobs/{jobId}/results
Hasil async yang selesai diunduh oleh Vood
Secara lalai, akses disahkan dan dialihkan ke URL R2 peribadi yang berjangka pendek; klien menerima JSON asal terus daripada R2. Accept: text/plain secara berasingan mengembalikan HTTP 200 dengan medan hasil asal sebagai teks biasa berinden. X-Respond-With: markdown memilih kandungan Markdown: application/json membungkusnya dalam content bersama metadata asal, menggantikan results; text/plain mengembalikan metadata diikuti Markdown. Jika Accept tiada atau menggunakan wildcard global, format lalai ialah JSON. Pemformatan tidak menghantar pertanyaan lain atau mengenakan kredit pertanyaan. Hasil tersimpan tamat tempoh 24 jam selepas selesai. Ralat kekal sebagai JSON berstruktur.
Pengesahan Autentikasi Auster: cookieSession OR atau ORANG dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
X-Respond-With · header · ORANG pilihan
Set ke markdown untuk mengembalikan konten hasil sebagai Markdown. Dia ingin mempertahankan ladang hasil aslinya. Accept Memilih secara independen JSON Atau teks biasa. Hanya pertanyaan realtime dan hasil kerja yang selesai dibaca mendukung header ini. Ia tidak mengubah penyerahan kerja, status, API akun, callback, berkas Bulk, unduhan biner, atau respon protokol MCP.
Schema
{
"type": "string",
"enum": [
"markdown"
]
}Accept · header · ORANG pilihan
Take application/json atau text/plain secara independen dari X-Respond-With. Tanpa nama X-Respond-With, text/plain XEVE mengembalikan kembali medan asli dengan indentasi; JSON OID mempertahankan medan respon asli (completed-result baca arah kembali ke penyimpanan). Dengan markdown markdown, JSON mengembalikan konten ditambah data meta dan teks polos mengembalikan data meta yang diikuti oleh Markdown. Rentang media standard dan bobot q didukung; hilang Accept atau baku wildcard global ke JSON. Kedua tipe respon aksara ringan menggunakan UTF-8; sebuah parameter set karakter eksplisit=utf-8 didukung.
Schema
{
"type": "string"
}jobId · path · diperlukan
Schema
{
"type": "string",
"pattern": "^job_[A-Za-z0-9_-]+$"
}Balasan
200 lapangan asli Plain-text atau Markdown kembali secara langsung; asli JSON dari R2 setelah mengikuti arah kembali baku
Tanggapan 200 · application/json
{
"anyOf": [
{
"$ref": "#/components/schemas/MarkdownQueryResult"
},
{
"type": "object",
"additionalProperties": true
}
]
}Tanggapan 200 · text/plain
{
"type": "string"
}302 Elibrasi ulang ke JSON asli dalam penyimpanan R2 pribadi ketika JSON dipilih tanpa X-Respond-With
Pengepala: Location
400 Nilai X-Respond-With tidak didukung; respon adalah JSON
Tanggapan 400 · application/json
{
"$ref": "#/components/schemas/QueryRepresentationError"
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon
Tanggapan 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}406 Baik baik application/json maupun text/plain tidak dapat diterima; respon adalah JSON
Tanggapan 406 · application/json
{
"$ref": "#/components/schemas/QueryRepresentationError"
}409 Keadaan Sumber Daya Sumber Daya atau konflik yang tidak menguntungkan
Tanggapan 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Hasil Hasil panen tamat tempoh
Tanggapan 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Tugas gagal. Jika sebab kegagalan telah disimpan, respons menyertakannya dalam medan detail.
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 TLS Sebuah dependensi atau katalog yang diperlukan tidak tersedia sementara
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}API pemprosesan Bulk
Titik akhir Bulk memiliki referensi berdedikasi dengan parameter, contoh permintaan dan skema respon. Open Bulk pengolahan API
GET /v2/bulk-jobs· Daftar pukal Daftar pekerjaan YouTubePOST /v2/bulk-jobs· Aisquive membuat pekerjaan Bulk dan mendapatkan file upload URLGET /v2/bulk-jobs/{bulkId}· Nucheal Read pukal pekerjaan kemajuan dan agregat jumlahPATCH /v2/bulk-jobs/{bulkId}· Ubah pengaturan ifrica untuk video yang belum dimulaiDELETE /v2/bulk-jobs/{bulkId}· Batal sebuah pekerjaan BulkPOST /v2/bulk-jobs/{bulkId}/start· Memindai sebuah berkas YouTube ID yang telah diunggahPOST /v2/bulk-jobs/{bulkId}/pause· Jeda pekerjaan BulkPOST /v2/bulk-jobs/{bulkId}/resume· Buat semula pekerjaan pukal secara manual atau diam secara otomatisGET /v2/bulk-jobs/{bulkId}/results· Muat Turun manifest pukal yang telah selesaiGET /v2/bulk-jobs/{bulkId}/results/{partNumber}· Muaturun satu NDJSON bagian hasil besar gzip
Lapangan Bermain
POST/playground/run
isklinasi pertanyaan taman bermain sebagai ruang kerja saat ini
Pengesahan Autentikasi Auster: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Badan permintaan · diperlukan
Schema · 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
}
}
}Balasan
200 Data Upstream API respon ditangkap untuk taman bermain
Tanggapan 200 · 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 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Permintaan validasi quest gagal
Tanggapan 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/playground/jobs/{jobId}/download
Muaturun sebuah artefak Playground lengkap di peramban saat ini
Pengesahan Autentikasi Auster: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameter
jobId · path · diperlukan
Schema
{
"type": "string",
"pattern": "^job_[A-Za-z0-9_-]+$"
}Balasan
200 Artefak muatan-pelayaran sementara di Meksiko
Pengepala: Content-Disposition, Content-Length
Tanggapan 200 · application/octet-stream
{
"type": "string",
"format": "binary"
}401 Pengesahan diperlukan atau tidak sah
Tanggapan 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Sumber daya tidak ditemukan atau tidak dimiliki oleh penelepon
Tanggapan 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Keadaan Sumber Daya Sumber Daya atau konflik yang tidak menguntungkan
Tanggapan 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Artefak sementara telah berakhir
Tanggapan 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 TLS Sebuah dependensi atau katalog yang diperlukan tidak tersedia sementara
Tanggapan 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Definisi Schema sontak
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."
}
}
}