Belgeleri incele
API başvurusu
Yönetim API referans
Hesaplar, anahtarlar, fatura ve işler için uç noktaları göz önünde bulundurun. Her uç nokta kendi kimlik doğrulama ve erişim gerekliliklerini listeler.
Hesabınızı bir API anahtarı ile okuyun
Yönetim API üssü URL, https://api.flashdata.dev/v2. Bu ücretsiz okuma, mevcut anahtarı döndürür ve IDs ve mülkiyeti hesaplayın. FLASHDATA_API_KEY komutunu çalıştırmadan önce ayarlayın.
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'Beklemek Bekle HTTP 200 Başarıda. Her uç noktanın Kimlik Hattını Kontrol edin: dataApiKey Kullanım kullanım kullanımı kullanır X-API-Key; cookieSession İmzalanan bir tarayıcı oturumu kullanır. Kimlik yanıt şema
Müşteri AçıkAPI spesifikasyonu indirin. Soruları, işlerini, hesaplarını, API anahtarlarını ve faturalarını kapsar.
Sorgu parametreleri ve talep kodu, Sorgu parametrelerinde belgelenmiştir. Google Ve ve YouTube API referansları.
Kimlik programları
| Scheme | Gereklilik |
|---|---|
dataApiKey |
FlashData API anahtarı. İş erişimi anahtarın kaynak kapsamı ile sınırlandırılır. |
cookieSession |
İçeriği gizli Web oturumu. Tarayıcı bu çerezi okuyamaz. |
csrfToken |
apiKey |
agentRegistrationProof | Kalıcı olarak rastgele bir 32-bay üssü64url kanıtı ve BEFORE gönderme isteği; sadece aynı kanıt ve vücut ile geri kazan. Bir OAuth token değil. |
agentSetupCredential | Geçici kurulum sadece statü için haçlı ve sadece yaratılışı iddia ediyor. Bir veri API anahtarı değil. |
agentHandoffProof | Hesap sahibi anahtarını kurtarmak ve kurulumu onaylamak için kullanılan kanıt. Veri sorgusuna asla gönderilmez. |
agentIdentityKey | Sıradan FlashData API anahtar Yazarizasyon Ayıer, sadece ajan kimliği. Veri sorguları X-API-Key'u yerine kullanır. |
Sistem Sistemi
GET/health
Sağlık hizmetleri
Kimlik: Halk Halk Halkı
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Yanıtlar
200 Sağlıklı Sağlıklı
200 yanıt · application/json
{
"$ref": "#/components/schemas/Health"
}GET/status
Halk bileşenini okuyun Özet
Kimlik: Halk Halk Halkı
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Yanıtlar
200 Kamu durumu Özet
Headers: Cache-Control
200 yanıt · application/json
{
"$ref": "#/components/schemas/PublicStatus"
}Auth
GET/oauth/requests/{requestId}
Bir uygulama izni talebi okuyun ve mevcut oturuma bağlanır
Tam seans gerekli. İstek on dakika sonra sona erer. Yanıt artık istasyon değildir.
Kimlik: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
requestId · path · gerekli
Schema
{
"type": "string",
"pattern": "^fdo_[A-Za-z0-9_-]{43}$"
}Yanıtlar
200 İstekli uygulama izni
200 yanıt · application/json
{
"$ref": "#/components/schemas/OAuthConsent"
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Gerçekleştirilmedi ama izin verilmiyor veya CSRF geçerliliği başarısız oldu
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 İstek süresiz, kullanılmış veya başka bir seansa bağlı
410 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/oauth/requests/{requestId}
Approve veya bir uygulama izni talebi inkar edin
Full session, CSRF ve gerekli Origine izin verdi. İsteki bir kez tutar. Yanıt artık istasyon değildir.
Kimlik: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
requestId · path · gerekli
Schema
{
"type": "string",
"pattern": "^fdo_[A-Za-z0-9_-]{43}$"
}İstenilen Vücut · gerekli
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"decision"
],
"properties": {
"decision": {
"type": "string",
"enum": [
"approve",
"deny"
]
}
}
}Yanıtlar
200 Kayıtlı müşteri kod veya inkar ile geri çağrı, devlet ve sorun
200 yanıt · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"redirectUrl"
],
"properties": {
"redirectUrl": {
"type": "string",
"format": "uri"
}
}
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Gerçekleştirilmedi ama izin verilmiyor veya CSRF geçerliliği başarısız oldu
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Yazarizasyon talebi kullanılamaz; yeni bir bağlantı başlat
410 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 İstek doğrulama başarısız oldu
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/register
FlashData hesabı oluşturun
Gönderilen Şartlar ve Gizlilik versiyonları, mevcut yayınlanan yasal paketlerle eşleşmelidir.
Kimlik: Halk Halk Halkı
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
İstenilen Vücut · gerekli
Schema · application/json
{
"$ref": "#/components/schemas/RegisterRequest"
}Yanıtlar
201 Hesap oluşturuldu; e-posta doğrulama gerekli
Headers: Cache-Control, X-Request-Id
201 yanıt · application/json
{
"$ref": "#/components/schemas/RegisterResponse"
}409 Kaynak durumu veya idempotency çatışma
409 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 İstek doğrulama başarısız oldu
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Puan, koncurrency, toplu veya bekleme süresi sınırı aşıldı
Headers: Retry-After
429 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Beklenmeyen bir iç hata meydana geldi
500 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Gerekli bir bağımlılık veya katalog geçici olarak kullanılamaz
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/login
Bir opaque Web seansı oluşturun
Güvenli ayarlar, HtttpOnly `__Host-fd_session` kurabiye. Pending hesapları doğrulama pano için sınırlı bir email_verification Oturumu alın. Uygunlanmış hesaplar, zaten verilmezse girişte bir kez deneme Kredilerini alır. Aktif bir hesap Gemi göç eden kimliğinin hala gerektirdiği sürece tam bir seans alın Mevcut yasal kabul, hangi durumda sınırlı bir yasal kabul alır legal_acceptance Session. Planlanan bir deletion isteği ile bir hesap Sınırlı bir deletion_recovery Oturumu alın. Hesabı kimin deletion processing/failed/completed ve askıya alınan hesaplar, 403'yu alır.
Kimlik: Halk Halk Halkı
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
İstenilen Vücut · gerekli
Schema · application/json
{
"$ref": "#/components/schemas/LoginRequest"
}Yanıtlar
200 Kimlik Doğrulama
Headers: Set-Cookie, Cache-Control, X-Request-Id
200 yanıt · application/json
{
"$ref": "#/components/schemas/LoginResponse"
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Giriş yasaklanmıştır; Problem.code Is is is is Is is Is Is is'dir. email_not_verified, account_suspended, account_deletion_processing, account_deletion_failed, veya account_deleted
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 İstek doğrulama başarısız oldu
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}423 Hesap geçici olarak kilitlendi
Headers: Retry-After
423 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Puan, koncurrency, toplu veya bekleme süresi sınırı aşıldı
Headers: Retry-After
429 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/logout
Mevcut seansı Revoke
Kimlik: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Yanıtlar
204 Oturum iptal edildi ve kurabiye temizlendi
Headers: Set-Cookie, Cache-Control, X-Request-Id
401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Gerçekleştirilmedi ama izin verilmiyor veya CSRF geçerliliği başarısız oldu
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/auth/me
Mevcut hesabı ve kullanıcıyı okuyun
Kimlik: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Yanıtlar
200 Şimdiki hesap
Headers: Cache-Control, X-Request-Id
200 yanıt · application/json
{
"$ref": "#/components/schemas/Account"
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/auth/csrf
CSRF token şu anki oturuma bağlı olarak alın
Kimlik: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Yanıtlar
200 CSRF token
Headers: Cache-Control, X-Request-Id
200 yanıt · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"csrfToken"
],
"properties": {
"csrfToken": {
"type": "string",
"minLength": 32,
"readOnly": true
}
}
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/email-verifications
İstek veya bir e-posta doğrulama mesajı gönder
Her sintactically olarak geçerli e-posta için, hesabın eksik olup olmadığı, beklenmeyen, aktif, askıya alınma veya silinmiş gibi aynı cevabı döndürür. Beklenmeyen hesaplar, geri çekilmeden sonra bir kez bağlantı alır.
Kimlik: Halk Halk Halkı
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
İstenilen Vücut · gerekli
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 320
}
}
}Yanıtlar
202 Kabul edilen istek. Yanıt, bir hesabın var olup olmadığını ortaya çıkarmaz.
Headers: Cache-Control, X-Request-Id
202 yanıt · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"accepted"
],
"properties": {
"accepted": {
"type": "boolean",
"const": true
}
}
}422 Anonim kimlik doğrulama isteği doğrulama başarısız oldu
Headers: Cache-Control, X-Request-Id
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Anonim kimlik doğrulama oranı limiti aştı
Headers: Cache-Control, Retry-After, X-Request-Id
429 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Beklenmeyen bir anonim kimlik doğrulama hatası meydana geldi
Headers: Cache-Control, X-Request-Id
500 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Anonim bir kimlik doğrulama bağımlılığı geçici olarak kullanılamaz
Headers: Cache-Control, X-Request-Id
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/email-verifications/confirm
Bir e-postayı doğrulayın ve hesabı etkinleştirin
Atomik olarak bir kez token tüketiyor ve Hesap ve Kullanıcıyı etkinleştirin. Mevcut hesap ve deneme kredi kuralları geçerlidir. Bir işaret oturumu olmadan kullanıcı açık olarak giriş yapar. Uygun oturum açma işlemini taşımak için izin verilen bir istek ve X-CSRF-Token aynı doğrulanmış hesap için bir döndürme kurabiyesi alabilir; tek başına bir doğrulama asla bir kullanıcıda işaretleyemez.
Kimlik: Halk Halk Halkı
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
İstenilen Vücut · gerekli
Schema · application/json
{
"$ref": "#/components/schemas/TokenRequest"
}Yanıtlar
200 Muhasebe aktif
Headers: Set-Cookie, Cache-Control, X-Request-Id
200 yanıt · application/json
{
"allOf": [
{
"$ref": "#/components/schemas/Account"
},
{
"type": "object",
"properties": {
"status": {
"const": "active"
},
"emailVerified": {
"const": true
}
}
}
]
}410 Bir zaman token geçersizdir, süresiz, geçersiz, zaten kullanılmış veya eş zamanlı bir onay yarışı kaybetti. Problem.code, `token_unavailable`'dur.
Headers: Cache-Control, X-Request-Id
410 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Anonim kimlik doğrulama isteği doğrulama başarısız oldu
Headers: Cache-Control, X-Request-Id
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Anonim kimlik doğrulama oranı limiti aştı
Headers: Cache-Control, Retry-After, X-Request-Id
429 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Beklenmeyen bir anonim kimlik doğrulama hatası meydana geldi
Headers: Cache-Control, X-Request-Id
500 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Anonim bir kimlik doğrulama bağımlılığı geçici olarak kullanılamaz
Headers: Cache-Control, X-Request-Id
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/email-verifications/session
E-posta doğrulama sonrası orijinal işaret oturumuna devam et
İzin verilen bir Origin ve CSRF token, canlı bir şifre-sayılı e-posta-verification oturumuna bağlı olmalıdır. Bu Sean'ın kendi hesabı doğrulanana kadar bekleyen geri dönüşler, başka bir tarayıcıda doğrulama dahil. Atomik olarak işaret oturumunu ve sorunları taze bir tam veya yasal kabul oturumunu geri döndürür. ID, e-posta, şifre veya doğrulama token, yasal kabulü veya kredi vermeyi kabul etmez.
Kimlik: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
İstenilen Vücut · gerekli
Schema · application/json
{
"type": "object",
"additionalProperties": false
}Yanıtlar
200 Signup Session döndü
Headers: Set-Cookie, Cache-Control
200 yanıt · application/json
{
"$ref": "#/components/schemas/LoginResponse"
}202 E-posta doğrulaması devam ediyor; yeni bir seans yok
Headers: Cache-Control
202 yanıt · application/json
{
"type": "object",
"required": [
"pending"
],
"additionalProperties": false,
"properties": {
"pending": {
"type": "boolean",
"const": true
}
}
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Gerçekleştirilmedi ama izin verilmiyor veya CSRF geçerliliği başarısız oldu
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 İstek doğrulama başarısız oldu
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Beklenmeyen bir iç hata meydana geldi
500 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/password-resets
Bir parola sıfırlama e-posta
Her zaman aynı 202 cevabı, hesap varlığı veya yaşam döngüsü durumu bakılmaksızın, sintactically geçerli bir e-posta için döndürür. Sadece aktif veya kilitli kimlikler posta alır.
Kimlik: Halk Halk Halkı
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
İstenilen Vücut · gerekli
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 320
}
}
}Yanıtlar
202 Kabul edilen istek. Yanıt, bir hesabın var olup olmadığını ortaya çıkarmaz.
Headers: Cache-Control, X-Request-Id
202 yanıt · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"accepted"
],
"properties": {
"accepted": {
"type": "boolean",
"const": true
}
}
}422 Anonim kimlik doğrulama isteği doğrulama başarısız oldu
Headers: Cache-Control, X-Request-Id
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Anonim kimlik doğrulama oranı limiti aştı
Headers: Cache-Control, Retry-After, X-Request-Id
429 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Beklenmeyen bir anonim kimlik doğrulama hatası meydana geldi
Headers: Cache-Control, X-Request-Id
500 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Anonim bir kimlik doğrulama bağımlılığı geçici olarak kullanılamaz
Headers: Cache-Control, X-Request-Id
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/password-resets/confirm
Yeni bir şifre ayarlayın ve mevcut seansları geri döndürür
Atomik olarak parola set token, yeni bir Argon2id credential, mevcut her oturumu geri döndürür ve diğer şifre setleri geçersiz kılar. Kullanıcıyı oturum açmaz veya bir oturum oluşturmaz.
Kimlik: Halk Halk Halkı
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
İstenilen Vücut · gerekli
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"
}
}
}Yanıtlar
204 Şifre güncellendi; mevcut seanslar iptal edildi
Headers: Cache-Control, X-Request-Id
410 Bir zaman token geçersizdir, süresiz, geçersiz, zaten kullanılmış veya eş zamanlı bir onay yarışı kaybetti. Problem.code, `token_unavailable`'dur.
Headers: Cache-Control, X-Request-Id
410 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Anonim kimlik doğrulama isteği doğrulama başarısız oldu
Headers: Cache-Control, X-Request-Id
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Anonim kimlik doğrulama oranı limiti aştı
Headers: Cache-Control, Retry-After, X-Request-Id
429 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Beklenmeyen bir anonim kimlik doğrulama hatası meydana geldi
Headers: Cache-Control, X-Request-Id
500 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Anonim bir kimlik doğrulama bağımlılığı geçici olarak kullanılamaz
Headers: Cache-Control, X-Request-Id
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/auth/sessions
Mevcut kullanıcı için aktif seanslar listesi
Kimlik: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Yanıtlar
200 Oturumlar
Headers: Cache-Control, X-Request-Id
200 yanıt · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Session"
}
}
}
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/auth/sessions
Revoke tüm seansları mevcut olandan dışında uyandırın
Kimlik: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Yanıtlar
204 Diğer seanslar iptal edildi
Headers: Cache-Control, X-Request-Id
401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Gerçekleştirilmedi ama izin verilmiyor veya CSRF geçerliliği başarısız oldu
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/auth/sessions/{sessionId}
Revoke one session
Kimlik: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
sessionId · path · gerekli
Schema
{
"type": "string",
"pattern": "^ses_"
}Yanıtlar
204 Oturum iptal edildi. Mevcut Oturum olsaydı, kurabiye temizlendi.
Headers: Set-Cookie, Cache-Control, X-Request-Id
401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Gerçekleştirilmedi ama izin verilmiyor veya CSRF geçerliliği başarısız oldu
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Kaynak bulunamadı ya da çağrıcı tarafından sahip değil
404 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Kaynak durumu veya idempotency çatışma
409 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 İstek doğrulama başarısız oldu
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Gerekli bir bağımlılık veya katalog geçici olarak kullanılamaz
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/re-authenticate
Hassas bir operasyon için mevcut şifreyi doğrulayın
Mevcut sunucunun oturumunda kısa ömürlü bir son kez kanıt izleyin.
Kimlik: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
İstenilen Vücut · gerekli
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"password"
],
"properties": {
"password": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"writeOnly": true
}
}
}Yanıtlar
200 Oturum son doğrulama var
Headers: Cache-Control, X-Request-Id
200 yanıt · application/json
{
"$ref": "#/components/schemas/Reauthentication"
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Gerçekleştirilmedi ama izin verilmiyor veya CSRF geçerliliği başarısız oldu
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Puan, koncurrency, toplu veya bekleme süresi sınırı aşıldı
Headers: Retry-After
429 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}PATCH/auth/password
Şifreyi değiştirin ve mevcut seansı döndürür
Kimlik: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
İstenilen Vücut · gerekli
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
}
}
}Yanıtlar
204 Şifre değişti; mevcut seans geri döndü ve diğer seanslar talep edildiğinde iptal edildi
Headers: Set-Cookie, Cache-Control, X-Request-Id
401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Gerçekleştirilmedi ama izin verilmiyor veya CSRF geçerliliği başarısız oldu
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 İstek doğrulama başarısız oldu
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Hesap Hesabı
GET/oauth/connections
Mevcut hesabın bağlantılı uygulamaları listeleyin
Tam seans gerekli. Hesabın bağlantılı uygulamaları olmadığı zaman boş. Yanıt artık istasyon değildir.
Kimlik: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Yanıtlar
200 Connected apps
200 yanıt · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuthConnection"
}
}
}
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Gerçekleştirilmedi ama izin verilmiyor veya CSRF geçerliliği başarısız oldu
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/oauth/connections/{grantId}
Bağlantılı bir uygulama ve onun özel API anahtarı
Full session, CSRF ve gerekli Origine izin verdi. Hesap mülkiyeti uygulanır. Yanıt artık istasyon değildir.
Kimlik: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
grantId · path · gerekli
Schema
{
"type": "string",
"pattern": "^oag_[A-Za-z0-9_-]{8,}$"
}Yanıtlar
204 Authorization revoked
401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Gerçekleştirilmedi ama izin verilmiyor veya CSRF geçerliliği başarısız oldu
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Kaynak bulunamadı ya da çağrıcı tarafından sahip değil
404 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/account
Read account settings
Kimlik: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Yanıtlar
200 Hesap Hesabı
200 yanıt · application/json
{
"$ref": "#/components/schemas/Account"
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}PATCH/account
Update profil ayarları
Kimlik: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
İstenilen Vücut · gerekli
Schema · application/json
{
"$ref": "#/components/schemas/UpdateAccountRequest"
}Yanıtlar
200 Güncelleme hesabı
200 yanıt · application/json
{
"$ref": "#/components/schemas/Account"
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Gerçekleştirilmedi ama izin verilmiyor veya CSRF geçerliliği başarısız oldu
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 İstek doğrulama başarısız oldu
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/account
Tüm mevcut seansları ve API Keys
Yöneticilerin hesaplarının, kesintiye başlamadan önce denetimli operatör iş akışları aracılığıyla revize edilen platform rolü olması gerekir. Benzersiz bir aktif kesinti isteği doğal idempotency sınırıdır. Eş zamanlı kimlikli programlar aynı isteği geri döndürür. Oturum geri çekilmesinden sonra, kayıp bir cevap deletion_recovery modunda giriş yaparak geri kazanılır ve GET /account/deletion; Revoked Sessions asla tekrar oynama kabul edilmez.
Kimlik: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
İstenilen Vücut · gerekli
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"
}
}
}Yanıtlar
202 Deletion planlandı; aktif seanslar ve anahtarlar iptal edildi
202 yanıt · application/json
{
"$ref": "#/components/schemas/AccountDeletionRequest"
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Gerçekleştirilmedi ama izin verilmiyor veya CSRF geçerliliği başarısız oldu
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Kaynak durumu veya idempotency çatışma
409 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 İstek doğrulama başarısız oldu
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/account/deletion
Mevcut hesabın silinmesi talebini okuyun
Kimlik: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Yanıtlar
200 Current deletion request
200 yanıt · application/json
{
"$ref": "#/components/schemas/AccountDeletionRequest"
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Kaynak bulunamadı ya da çağrıcı tarafından sahip değil
404 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/account/deletion
lütuf döneminde planlanan bir yıkımı iptal et
Planlanan bir karşılaştırma-ve-set kullanın. Bir işlemci yarışı 409 döndürür; kurtarma seansı tamamlandıktan sonra ve eski geçişi tekrar oynatamaz.
Kimlik: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Yanıtlar
204 Deletion iptal edildi, hesap yeniden etkinleştirildi ve kurtarma seansı yasal kabul kapısına göre döndü.
Headers: Set-Cookie, Cache-Control, X-Request-Id
401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Gerçekleştirilmedi ama izin verilmiyor veya CSRF geçerliliği başarısız oldu
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Kaynak bulunamadı ya da çağrıcı tarafından sahip değil
404 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Kaynak durumu veya idempotency çatışma
409 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/account/legal-acceptances
Accept şu anda yayınlanan Şartlar ve Gizlilik versiyonları
Başarısız bir yasal kabul, göç kapısını açıklayın ve Oturumu döndürür. Stale gönderilen versiyonları reddedilir.
Kimlik: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
İstenilen Vücut · gerekli
Schema · application/json
{
"$ref": "#/components/schemas/LegalAcceptanceRequest"
}Yanıtlar
200 Yasal kabul kaydedildi ve Oturum tam modda döndü
Headers: Set-Cookie, Cache-Control, X-Request-Id
200 yanıt · application/json
{
"$ref": "#/components/schemas/LoginResponse"
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Gerçekleştirilmedi ama izin verilmiyor veya CSRF geçerliliği başarısız oldu
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Kaynak bulunamadı ya da çağrıcı tarafından sahip değil
404 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 İstek doğrulama başarısız oldu
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Onboarding
GET/onboarding
İlerlemenin Yeniden Tanımlanabilirliği Okumayı Oku
Kimlik: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Yanıtlar
200 Şu anki devlet devleti
Headers: Cache-Control, X-Request-Id
200 yanıt · application/json
{
"$ref": "#/components/schemas/OnboardingProgress"
}401 Gerekli veya geçersiz
Headers: Cache-Control, X-Request-Id
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Beklenmeyen bir iç hata meydana geldi
Headers: Cache-Control, X-Request-Id
500 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Gerekli bir bağımlılık veya gemi kaydı geçici olarak kullanılamaz
Headers: Cache-Control, X-Request-Id
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}PATCH/onboarding
Geri hareket etmek için ilerleme sağlamadan ilerleme kaydetme
Kimlik: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
İstenilen Vücut · gerekli
Schema · application/json
{
"$ref": "#/components/schemas/UpdateOnboardingRequest"
}Yanıtlar
200 Güncelleme Tarihi
Headers: Cache-Control, X-Request-Id
200 yanıt · application/json
{
"$ref": "#/components/schemas/OnboardingProgress"
}401 Gerekli veya geçersiz
Headers: Cache-Control, X-Request-Id
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Gerçekleştirilmedi ama izin verilmiyor veya CSRF geçerliliği başarısız oldu
Headers: Cache-Control, X-Request-Id
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Kaynak durumu veya idempotency çatışma
Headers: Cache-Control, X-Request-Id
409 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 İstek doğrulama başarısız oldu
Headers: Cache-Control, X-Request-Id
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Beklenmeyen bir iç hata meydana geldi
Headers: Cache-Control, X-Request-Id
500 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Gerekli bir bağımlılık veya gemi kaydı geçici olarak kullanılamaz
Headers: Cache-Control, X-Request-Id
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Genel bakış
GET/overview
Hesap pantasını okuyun
Kimlik: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Yanıtlar
200 Hesap Tabanlı Genel Bakış
Headers: Cache-Control, X-Request-Id
200 yanıt · application/json
{
"$ref": "#/components/schemas/ConsoleOverview"
}401 Gerekli veya geçersiz
Headers: Cache-Control, X-Request-Id
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Beklenmeyen bir iç hata meydana geldi
Headers: Cache-Control, X-Request-Id
500 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Gerekli bir bağımlılık veya gemi kaydı geçici olarak kullanılamaz
Headers: Cache-Control, X-Request-Id
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}API Keys
GET/api-access/identity
Mevcut API anahtar mülkiyetini ve tekrarlanan hazırlığı doğrulayın
Free header-only API-key oku. Geri dönüşler halk account/key IDs ve yazar mülkiyet. Hiçbir istek vücut. Mevcut /api-access metadata yanıtını değiştirmez. 120/minute hesabı hazır sınırı paylaşın. Başarısızlıksızlığı kapatamaz; anahtar ek, plan veya yerel devletten mülkiyet koymayın. Hiçbir sorgu parametresi kabul edilmez. Yanıtlar hiçbir mağaza değildir.
Kimlik: dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Yanıtlar
200 Mevcut API anahtar mülkiyetini ve tekrarlanan hazırlığı doğrulayın
200 yanıt · application/json
{
"$ref": "#/components/schemas/APIKeyIdentity"
}400 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
400 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
409 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
410 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
429 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-keys
Liste API Key metadata
Kimlik: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Yanıtlar
200 API Keys sırsız
200 yanıt · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiKey"
}
}
}
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/api-keys
Bir API Key oluşturun ve sırrını bir kez ortaya çıkarın
Kimlik: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
Idempotency-Key · header · gerekli
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}İstenilen Vücut · gerekli
Schema · application/json
{
"$ref": "#/components/schemas/CreateApiKeyRequest"
}Yanıtlar
201 Oluşturun; aynı idempotent replay, beş dakika boyunca aynı şifreli cevabı geri döndürebilir
201 yanıt · application/json
{
"$ref": "#/components/schemas/ApiKeyCreated"
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Gerçekleştirilmedi ama izin verilmiyor veya CSRF geçerliliği başarısız oldu
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Kaynak durumu veya idempotency çatışma
409 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 İstek doğrulama başarısız oldu
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Gerekli bir bağımlılık veya katalog geçici olarak kullanılamaz
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/api-keys/{keyId}
Bir API Key
Kimlik: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
keyId · path · gerekli
Schema
{
"type": "string",
"pattern": "^key_"
}Yanıtlar
204 Revoked
401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Gerçekleştirilmedi ama izin verilmiyor veya CSRF geçerliliği başarısız oldu
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Kaynak bulunamadı ya da çağrıcı tarafından sahip değil
404 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Gerekli bir bağımlılık veya katalog geçici olarak kullanılamaz
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/api-keys/{keyId}/rotate
Bir yedek anahtar oluşturun ve eski anahtar geri dönüş programı oluşturun
Yeni bir anahtar oluşturun ve revokeOldAt'ye kadar eski anahtarı aktif tutar. Varsayılan olarak, çakışma 24 saatler veya eski anahtar sona erinceye kadar, ki bu daha önce. Özel bir revokeOldAt gelecekte, yedi gün içinde ve daha sonra eski anahtar expiry'den daha geç olmamalıdır.
Kimlik: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
keyId · path · gerekli
Schema
{
"type": "string",
"pattern": "^key_"
}Idempotency-Key · header · gerekli
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}İstenilen Vücut · Seçmeli opsiyonel
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."
}
}
}Yanıtlar
201 Oluşturun; sır bir kez geri döndü
201 yanıt · application/json
{
"$ref": "#/components/schemas/ApiKeyCreated"
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Gerçekleştirilmedi ama izin verilmiyor veya CSRF geçerliliği başarısız oldu
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Kaynak bulunamadı ya da çağrıcı tarafından sahip değil
404 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Kaynak durumu veya idempotency çatışma
409 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 İstek doğrulama başarısız oldu
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Gerekli bir bağımlılık veya katalog geçici olarak kullanılamaz
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-access
API anahtarın yetkili kaynaklarını okuyun ve kaynak kaynak kaynaklarını okuyun
Ücretsiz, başlıklı X-API-Key doğrulama. Geri dönüşler sadece halka açık verilir kaynak isimleri ve yapılandırılmış imzalanmış depolama kaynağı (null if Yok değildir). No account ID, anahtar ID, gizli veya depolama kimlikleri geri döndü. Yerel MCP, bu son noktayı her araç keşif ve çağrıdan önce yeniden değerlendiriyor, Önbellek sonucu da okur. Hiçbir sorgu parametresi veya istek vücut kabul edilmez. Tüm /api-access rotaları 120 isteklerini müşteri IP başına dakika başına paylaşıyor ve geri dönüyor Cache-Control private, no-store. Normal anahtar son kullanım hala oluşur.
Kimlik: dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Yanıtlar
200 Yetkili bir kamu kaynakları ve sonucu
200 yanıt · application/json
{
"$ref": "#/components/schemas/ApiAccess"
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 İstek doğrulama başarısız oldu
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Çok fazla hesap okur; oran-limit pencereden sonra yeniden deneme
503 Gerekli bir bağımlılık veya katalog geçici olarak kullanılamaz
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Agent Connections
GET/agent-connections/capabilities
2'u kullanılabilirlik için keşfedin
Hiçbir sorgu parametresi kabul edilmez. Yanıtlar hiçbir mağaza değildir. Ajan rotaları sadece yönetim ve özelliktir; dağıtımlar 404'u devre dışı bırakabiliyor. X-API-Key, ajan rotalarında yasaklanmıştır.
Kimlik: Halk Halk Halkı
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Yanıtlar
200 2'u kullanılabilirlik için keşfedin
200 yanıt · application/json
{
"$ref": "#/components/schemas/AgentCapabilities"
}400 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
400 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
409 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
410 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
429 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/registrations
Geçici bir API-key bağlantı oluşturun
Kayıt kanıtı ve POST'dan önce tam giriş. Aynı kanıt ve vücut aynı denemeyi geri döndürür; giriş verimlerini değiştirir. Geçici deneme: 1 Credit, 72 saatler, 1 request/second, seri 1. Kaynak kapsamı limitleri sunucuda yazar olarak kalır. Hiçbir sorgu parametresi kabul edilmez. Yanıtlar hiçbir mağaza değildir. Ajan rotaları sadece yönetim ve özelliktir; dağıtımlar 404'u devre dışı bırakabiliyor. X-API-Key, ajan rotalarında yasaklanmıştır.
Kimlik: agentRegistrationProof
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
İstenilen Vücut · gerekli
Schema · application/json
{
"$ref": "#/components/schemas/AgentRegistrationRequest"
}Yanıtlar
201 Geçici bir API-key bağlantı oluşturun
201 yanıt · application/json
{
"$ref": "#/components/schemas/AgentRegistration"
}400 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
400 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
409 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
410 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
429 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/owned
Liste tarayıcıya ait bağlantılar
Hiçbir sorgu parametresi kabul edilmez. Yanıtlar hiçbir mağaza değildir. Ajan rotaları sadece yönetim ve özelliktir; dağıtımlar 404'u devre dışı bırakabiliyor. X-API-Key, ajan rotalarında yasaklanmıştır. Tarayıcıya ait operasyon. Tam doğrulanmış Oturum gerekli; caller bir API anahtarı veya kanıtı yerine getirmemelidir.
Kimlik: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Yanıtlar
200 Liste tarayıcıya ait bağlantılar
200 yanıt · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"connections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentConnection"
}
}
},
"required": [
"connections"
]
}400 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
400 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
409 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
410 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
429 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/{connectionId}
Geçici bağlantı statüsü okuyun
Hiçbir sorgu parametresi kabul edilmez. Yanıtlar hiçbir mağaza değildir. Ajan rotaları sadece yönetim ve özelliktir; dağıtımlar 404'u devre dışı bırakabiliyor. X-API-Key, ajan rotalarında yasaklanmıştır.
Kimlik: agentSetupCredential
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
connectionId · path · gerekli
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Yanıtlar
200 Geçici bağlantı statüsü okuyun
200 yanıt · application/json
{
"$ref": "#/components/schemas/AgentConnectionResponse"
}400 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
400 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
409 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
410 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
429 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/agent-connections/{connectionId}
Revoke an sahip bir bağlantı
Hiçbir sorgu parametresi kabul edilmez. Yanıtlar hiçbir mağaza değildir. Ajan rotaları sadece yönetim ve özelliktir; dağıtımlar 404'u devre dışı bırakabiliyor. X-API-Key, ajan rotalarında yasaklanmıştır. Tarayıcıya ait operasyon. Tam doğrulanmış Oturum gerekli; caller bir API anahtarı veya kanıtı yerine getirmemelidir.
Kimlik: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
connectionId · path · gerekli
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Origin · header · gerekli
Schema
{
"type": "string"
}X-CSRF-Token · header · gerekli
Schema
{
"type": "string"
}Yanıtlar
204 Revoke an sahip bir bağlantı
400 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
400 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
409 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
410 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
429 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/{connectionId}/identity
Mevcut verileri API anahtarını bir bağlantı için doğrulayın
Hiçbir sorgu parametresi kabul edilmez. Yanıtlar hiçbir mağaza değildir. Ajan rotaları sadece yönetim ve özelliktir; dağıtımlar 404'u devre dışı bırakabiliyor. X-API-Key, ajan rotalarında yasaklanmıştır.
Kimlik: agentIdentityKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
connectionId · path · gerekli
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Yanıtlar
200 Mevcut verileri API anahtarını bir bağlantı için doğrulayın
200 yanıt · application/json
{
"$ref": "#/components/schemas/AgentConnectionResponse"
}400 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
400 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
409 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
410 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
429 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/{connectionId}/onboarding
Geri kazanılabilir devlet için
Hiçbir sorgu parametresi kabul edilmez. Yanıtlar hiçbir mağaza değildir. Ajan rotaları sadece yönetim ve özelliktir; dağıtımlar 404'u devre dışı bırakabiliyor. X-API-Key, ajan rotalarında yasaklanmıştır.
Kimlik: agentHandoffProof
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
connectionId · path · gerekli
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Yanıtlar
200 Geri kazanılabilir devlet için
200 yanıt · application/json
{
"$ref": "#/components/schemas/AgentOnboardingStatus"
}400 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
400 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
409 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
410 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
429 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/{connectionId}/claims
Bir tarayıcı onayı talep edin
Açık claimPath, güvenilir bir FlashData web kaynağı üzerinde ve kodu ayrı olarak gösterir. Hiçbir zaman bilgi veya URL'daki onay kodu asla yerine getirme. Hiçbir sorgu parametresi kabul edilmez. Yanıtlar hiçbir mağaza değildir. Ajan rotaları sadece yönetim ve özelliktir; dağıtımlar 404'u devre dışı bırakabiliyor. X-API-Key, ajan rotalarında yasaklanmıştır.
Kimlik: agentSetupCredential
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
connectionId · path · gerekli
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}İstenilen Vücut · gerekli
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {},
"required": []
}Yanıtlar
201 Bir tarayıcı onayı talep edin
201 yanıt · application/json
{
"$ref": "#/components/schemas/AgentClaim"
}400 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
400 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
409 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
410 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
429 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/claims/{claimId}/confirm
Doğrulanmış bir tarayıcı oturumunda iddia kodunu onaylayın
Hiçbir sorgu parametresi kabul edilmez. Yanıtlar hiçbir mağaza değildir. Ajan rotaları sadece yönetim ve özelliktir; dağıtımlar 404'u devre dışı bırakabiliyor. X-API-Key, ajan rotalarında yasaklanmıştır. Tarayıcıya ait operasyon. Tam doğrulanmış Oturum gerekli; caller bir API anahtarı veya kanıtı yerine getirmemelidir.
Kimlik: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
claimId · path · gerekli
Schema
{
"type": "string",
"pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}Origin · header · gerekli
Schema
{
"type": "string"
}X-CSRF-Token · header · gerekli
Schema
{
"type": "string"
}İstenilen Vücut · gerekli
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"pattern": "^\\d{8}$"
}
},
"required": [
"code"
]
}Yanıtlar
200 Doğrulanmış bir tarayıcı oturumunda iddia kodunu onaylayın
200 yanıt · application/json
{
"$ref": "#/components/schemas/AgentBrowserClaim"
}400 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
400 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
409 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
410 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
429 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/claims/{claimId}
Tarayıcı oturumunda onaylanmış bir iddiayı okuyun
Hiçbir sorgu parametresi kabul edilmez. Yanıtlar hiçbir mağaza değildir. Ajan rotaları sadece yönetim ve özelliktir; dağıtımlar 404'u devre dışı bırakabiliyor. X-API-Key, ajan rotalarında yasaklanmıştır. Tarayıcıya ait operasyon. Tam doğrulanmış Oturum gerekli; caller bir API anahtarı veya kanıtı yerine getirmemelidir.
Kimlik: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
claimId · path · gerekli
Schema
{
"type": "string",
"pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}Yanıtlar
200 Tarayıcı oturumunda onaylanmış bir iddiayı okuyun
200 yanıt · application/json
{
"$ref": "#/components/schemas/AgentClaimView"
}400 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
400 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
409 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
410 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
429 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/claims/{claimId}/approve
Approve kapsamı azalttı ve hesap-balance finansman fonları
Hiçbir sorgu parametresi kabul edilmez. Yanıtlar hiçbir mağaza değildir. Ajan rotaları sadece yönetim ve özelliktir; dağıtımlar 404'u devre dışı bırakabiliyor. X-API-Key, ajan rotalarında yasaklanmıştır. Tarayıcıya ait operasyon. Tam doğrulanmış Oturum gerekli; caller bir API anahtarı veya kanıtı yerine getirmemelidir.
Kimlik: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
claimId · path · gerekli
Schema
{
"type": "string",
"pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}Origin · header · gerekli
Schema
{
"type": "string"
}X-CSRF-Token · header · gerekli
Schema
{
"type": "string"
}İstenilen Vücut · gerekli
Schema · application/json
{
"$ref": "#/components/schemas/AgentApproval"
}Yanıtlar
200 Approve kapsamı azalttı ve hesap-balance finansman fonları
200 yanıt · 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 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
400 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
409 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
410 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
429 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/{connectionId}/handoff
Onaylanan sahibi API anahtarını yeniden keşfedin
Güncel anahtar 24 saatlerini ACK'yı yüklemeye kadar sona erebilir. Persist atomal olarak, ACK'dan önce taze bir süreçte yeniden yükleniyor ve kimlik doğrulaması. Tekrarlanan bir teslimat aynı adayı geri alır; teslimat bildirim olmadan bir makbul döndürür. Hiçbir sorgu parametresi kabul edilmez. Yanıtlar hiçbir mağaza değildir. Ajan rotaları sadece yönetim ve özelliktir; dağıtımlar 404'u devre dışı bırakabiliyor. X-API-Key, ajan rotalarında yasaklanmıştır.
Kimlik: agentHandoffProof
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
connectionId · path · gerekli
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}İstenilen Vücut · gerekli
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {},
"required": []
}Yanıtlar
200 Onaylanan sahibi API anahtarını yeniden keşfedin
200 yanıt · application/json
{
"$ref": "#/components/schemas/AgentHandoff"
}400 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
400 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
409 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
410 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
429 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/{connectionId}/handoff/ack
Onaylanmış sahibi anahtar yükleme
Caller zaten adayı kurtarmış ve onu taze bir süreçte bağımsız olarak doğrulamıştır. Başarılı ACK işaretleri kuruldu, adayın anahtar expiry'yi kaldırır ve kurtarılabilir devre dışı materyali silir. Tekrarlanan ACK idempotent. Hiçbir sorgu parametresi kabul edilmez. Yanıtlar hiçbir mağaza değildir. Ajan rotaları sadece yönetim ve özelliktir; dağıtımlar 404'u devre dışı bırakabiliyor. X-API-Key, ajan rotalarında yasaklanmıştır.
Kimlik: agentHandoffProof
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
connectionId · path · gerekli
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}İstenilen Vücut · gerekli
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"apiKey": {
"type": "string"
}
},
"required": [
"apiKey"
]
}Yanıtlar
200 Onaylanmış sahibi anahtar yükleme
200 yanıt · application/json
{
"$ref": "#/components/schemas/AgentHandoff"
}400 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
400 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
409 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
410 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
429 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Rejected request; Problem kodunu kontrol edin. Asla bir mutasyonu körüne yeniden denemeyin.
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Kataloğu Kataloğu
GET/catalog/sources
Muhasebeye özgü fiyatlar olmadan kamu kaynakları yetenekleri
Kimlik: Halk Halk Halkı
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Yanıtlar
200 Public source kataloğu
Headers: Cache-Control
200 yanıt · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSource"
}
}
}
}GET/plans
Genel USD planları ve fiyatlar
Kimlik: Halk Halk Halkı
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Yanıtlar
200 Public plan katalog kataloğu
Headers: Cache-Control
200 yanıt · application/json
{
"$ref": "#/components/schemas/PlanCatalog"
}GET/legal/current
Kayıt için gerekli olan mevcut Şartlar ve Gizlilik versiyonlarını okuyun
Kimlik: Halk Halk Halkı
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Yanıtlar
200 Mevcut yasal sürüm katalog kataloğu
Headers: Cache-Control
200 yanıt · application/json
{
"$ref": "#/components/schemas/PublicLegalVersions"
}Billing
GET/billing/subscription
Etkili Stripe aboneliğini okuyun
Kimlik: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Yanıtlar
200 Abone veya PAYG entitlement
200 yanıt · application/json
{
"$ref": "#/components/schemas/Subscription"
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/checkout-sessions
Bir Stripe- ev sahipliği yaptı Checkout Session
Abonelik ve yayınlanan kredi paketleri priceId'u kullanır. Özel bir üst tab amountMinor'u kullanır (USD sent, $10 to $999,999.99); sunucu sabit kredi değeriyle kredi hesaplar ve özel bir tek zamanlı Stripe fiyatı yaratır. Ürün, sağlayıcı fiyatı, para, başarı URL ve URL'u iptal etmek tarayıcıdan asla kabul edilmez. Krediler sadece alıntı miktarı için doğrulanmış bir ücretli olaydan sonra verilir.
Kimlik: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
Idempotency-Key · header · gerekli
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}İstenilen Vücut · gerekli
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"
}
}
}
]
}Yanıtlar
201 Stripe Checkout Session
201 yanıt · application/json
{
"$ref": "#/components/schemas/HostedSession"
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Gerçekleştirilmedi ama izin verilmiyor veya CSRF geçerliliği başarısız oldu
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Kaynak durumu veya idempotency çatışma
409 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 İstek doğrulama başarısız oldu
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Bir upstream sağlayıcısı başarısız oldu
502 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Fatura katalogu veya sağlayıcı yapılandırılmıyor veya geçici olarak kullanılamaz
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/subscription-changes
Mevcut Stripe aboneliğini daha yüksek bir yayınlanan fiyata yükseltin
Sunucu, FlashData fiyatının aktif olduğunu, mevcut canlı modda mevcut USD-denominated, aynı aralığı ve mevcut abonelik fiyatından kesinlikle daha pahalı olduğunu belirtiyor. Ürün, sağlayıcı fiyatı, para ve prorasyon seçenekleri tarayıcıdan asla kabul edilmez. Yerel entitlement ve krediler sadece doğrulanmış bir sağlayıcı olayın ardından değişir.
Kimlik: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
Idempotency-Key · header · gerekli
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}İstenilen Vücut · gerekli
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"priceId"
],
"properties": {
"priceId": {
"type": "string",
"pattern": "^prc_"
}
}
}Yanıtlar
201 Stripe'e gönderilen Abonelik Değişimi
201 yanıt · application/json
{
"$ref": "#/components/schemas/SubscriptionChange"
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Gerçekleştirilmedi ama izin verilmiyor veya CSRF geçerliliği başarısız oldu
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Kaynak bulunamadı ya da çağrıcı tarafından sahip değil
404 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Kaynak durumu veya idempotency çatışma
409 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 İstek doğrulama başarısız oldu
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Bir upstream sağlayıcısı başarısız oldu
502 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Fatura katalogu veya sağlayıcı yapılandırılmıyor veya geçici olarak kullanılamaz
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/portal-sessions
Bir Stripe Müşteri Portal Oturumu Oluşturun
Kimlik: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
Idempotency-Key · header · gerekli
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Yanıtlar
201 Stripe Müşteri Portalı
201 yanıt · application/json
{
"$ref": "#/components/schemas/HostedSession"
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Gerçekleştirilmedi ama izin verilmiyor veya CSRF geçerliliği başarısız oldu
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Kaynak bulunamadı ya da çağrıcı tarafından sahip değil
404 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Kaynak durumu veya idempotency çatışma
409 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Bir upstream sağlayıcısı başarısız oldu
502 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Fatura katalogu veya sağlayıcı yapılandırılmıyor veya geçici olarak kullanılamaz
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/subscription-cancellation
Mevcut ücretli abonelik veya geri iptal iptali
cancelAtPeriodEnd'u true programı mevcut fatura döneminde iptal eder; false abonelik tutar. Doğrulanmış bir Stripe abonelik etkinliğinden sonra alıntılar güncellenir. Bu uç nokta asla bir geri ödeme iptal etmez veya sorunları iptal etmez.
Kimlik: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
Idempotency-Key · header · gerekli
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}İstenilen Vücut · gerekli
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"cancelAtPeriodEnd"
],
"properties": {
"cancelAtPeriodEnd": {
"type": "boolean"
}
}
}Yanıtlar
202 Stripe'e gönderilen Cancellation update
202 yanıt · application/json
SubscriptionCancellationChange
{
"$ref": "#/components/schemas/SubscriptionCancellationChange"
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Gerçekleştirilmedi ama izin verilmiyor veya CSRF geçerliliği başarısız oldu
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Kaynak bulunamadı ya da çağrıcı tarafından sahip değil
404 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Kaynak durumu veya idempotency çatışma
409 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 İstek doğrulama başarısız oldu
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Bir upstream sağlayıcısı başarısız oldu
502 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Fatura katalogu veya sağlayıcı yapılandırılmıyor veya geçici olarak kullanılamaz
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/billing/invoices
Liste Stripe fatura projeksiyonları
Kimlik: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
cursor · query · Seçmeli opsiyonel
Schema
{
"type": "string",
"maxLength": 512
}limit · query · Seçmeli opsiyonel
Schema
{
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}Yanıtlar
200 Faturalar
401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/billing/payments
Liste hesabı-skod top-up ve geri ödeme projeksiyonları
Kimlik: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
cursor · query · Seçmeli opsiyonel
Schema
{
"type": "string",
"maxLength": 512
}limit · query · Seçmeli opsiyonel
Schema
{
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}Yanıtlar
200 Sağlayıcı sırları olmadan bir zaman ödeme tarihi
200 yanıt · application/json
{
"$ref": "#/components/schemas/BillingPaymentPage"
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Krediler
GET/api-access/balance
Bir API anahtar kullanarak canlı hesabı bakiyesini okuyun
Hesabınızdaki tüm API anahtarları tarafından paylaşılan mevcut kredi bakiyesini okuyun. Aktif rezervasyonlar mevcut dengeyi azaltabilir. Bu istek hiçbir Krediye mal değildir ve sorgu parametreleri veya vücut gerektirmez. Yanıtlar özeldir ve önbellek değildir; hesap hazır oranı limitleri uygulanır.
Kimlik: dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Yanıtlar
200 Kayıt edilen denge ve mevcut olmayan Krediler
200 yanıt · application/json
{
"$ref": "#/components/schemas/ApiAccessBalance"
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 İstek doğrulama başarısız oldu
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Çok fazla hesap okur; oran-limit pencereden sonra yeniden deneme
503 Gerekli bir bağımlılık veya katalog geçici olarak kullanılamaz
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-access/pricing
API anahtar tarafından yetkilendirilmiş kaynaklar için gerçek hesap fiyatları okuyun
API anahtarı tarafından izin verilen kaynaklar için hesap oranlarınızı okuyun. A A A a A AA A A null fiyat, kaynağın mevcut olmadığı anlamına gelir. request_count Sayılar sorguları, geri iade öğeleri değil; indirme oranları TB'ye göredir (10^12 Selam olsun! Tahminler Kredi veya kapasite rezerve etmez. Bu istek hiçbir Krediye mal değildir. Yanıtlar özeldir ve önbellek değildir; hesap hazır oranı limitleri uygulanır.
Kimlik: dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
source · query · Seçmeli opsiyonel
Bu anahtara verilen bir kaynak; tüm verilen kaynakları okumak için omit.
Schema
{
"$ref": "#/components/schemas/ApiAccessSource"
}request_count · query · Seçmeli opsiyonel
Decimal tamsa arama sayısı; indirme boyutunu tahmin etmez.
Schema
{
"type": "integer",
"minimum": 1,
"maximum": 100000,
"default": 1
}Yanıtlar
200 Muhasebe planı ve kaynak bazlı fiyatlar
200 yanıt · application/json
{
"$ref": "#/components/schemas/ApiAccessPricing"
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Gerçekleştirilmedi ama izin verilmiyor veya CSRF geçerliliği başarısız oldu
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 İstek doğrulama başarısız oldu
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Çok fazla hesap okur; oran-limit pencereden sonra yeniden deneme
503 Gerekli bir bağımlılık veya katalog geçici olarak kullanılamaz
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-access/limits
Hesap planı limitlerini ve mevcut bir API anahtar kullanarak iş bekleyen işleri okuyun
Koncurrency, toplu boyut ve bekleme-iş sınırlarınızı okuyun, artı şu anki bekleme sayını okuyun. Bu değerler plan isteklerine yardımcı olur, ancak rezerv kapasitesi yoktur. Bu istek hiçbir Krediye mal değildir ve sorgu parametreleri veya vücut gerektirmez. Yanıtlar özeldir ve önbellek değildir; hesap hazır oranı limitleri uygulanır.
Kimlik: dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Yanıtlar
200 Plan tavanları ve şu anki mevcut sayı
200 yanıt · application/json
{
"$ref": "#/components/schemas/ApiAccessLimits"
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 İstek doğrulama başarısız oldu
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Çok fazla hesap okur; oran-limit pencereden sonra yeniden deneme
503 Gerekli bir bağımlılık veya katalog geçici olarak kullanılamaz
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/usage
API anahtar tarafından yetkilendirilmiş kaynaklar için hesap kullanımı okuyun
Ücretsiz okuma, sadece X-API-Key tarafından kimliklendi. Tüm hesap anahtarlarını içerir ancak Sadece arama anahtarına verilen kaynaklar. Soru metni geri dönme, anahtarlar, Ödeme detayları veya diğer hesaplar. 7 güne kadar sıralayıcılar; maksimum 31 günler. Tarihler UTC Z zamantamps kullanmak zorundadır. kapsayıcı ve özel olmak; Her ikisi de dakikaya kadar yuvarlanır. Yalnız, + 7 günlerine varsayılan olarak. Ne ile, bir sonraki dakikadan başlamak. Aggregates sonunda tutarlı; hatta güncelleme =false, son tüm olayların yetersiz olduğunu garanti etmez. Limiti okuyun: 60 istemci IP başına dakika talep eder.
Kimlik: dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
source · query · Seçmeli opsiyonel
Arama anahtarına verilen tam bir katalog kaynağı; omized, tüm verilen kaynaklar anlamına gelir.
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 · Seçmeli opsiyonel
Schema
{
"type": "string",
"format": "date-time"
}to · query · Seçmeli opsiyonel
Schema
{
"type": "string",
"format": "date-time"
}Yanıtlar
200 Scoped istek sayar ve şarj Kredileri, tazelik bilgisi ile
200 yanıt · application/json
{
"$ref": "#/components/schemas/ApiKeyUsage"
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Gerçekleştirilmedi ama izin verilmiyor veya CSRF geçerliliği başarısız oldu
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 İstek doğrulama başarısız oldu
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Çok fazla kullanım okur; oran-limit pencereden sonra yeniden deneme
503 Gerekli bir bağımlılık veya katalog geçici olarak kullanılamaz
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/credits/balance
Mevcut mevcut mevcut ve rezerve edilen kredileri okuyun
Kimlik: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Yanıtlar
200 Kredi dengesi
200 yanıt · application/json
{
"$ref": "#/components/schemas/CreditBalance"
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/credits/policy
Etkili hesap kredi hibesini okuyun ve politikayı şarj edin
Kimlik: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Yanıtlar
200 Etkili kredi politikası
200 yanıt · application/json
{
"$ref": "#/components/schemas/CreditPolicy"
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/credits/transactions
Liste kredi fager girişleri
Kimlik: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
cursor · query · Seçmeli opsiyonel
Schema
{
"type": "string",
"maxLength": 512
}limit · query · Seçmeli opsiyonel
Schema
{
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}type · query · Seçmeli opsiyonel
Schema
{
"$ref": "#/components/schemas/CreditEntryType"
}Yanıtlar
200 Ledger girişleri
200 yanıt · application/json
{
"allOf": [
{
"$ref": "#/components/schemas/Page"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditTransaction"
}
}
}
}
]
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Deneme Kredileri
GET/trial-credit-request
Deneme Kredisi uygunluk ve hesabın ömür boyu isteği
Kimlik: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Yanıtlar
200 Mevcut uygunluk, yapılandırılmış hibe ve talep durumu
Headers: Cache-Control
200 yanıt · application/json
{
"$ref": "#/components/schemas/TrialCreditState"
}401 Gerekli veya geçersiz
Headers: Cache-Control, X-Request-Id
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Beklenmeyen bir iç hata meydana geldi
Headers: Cache-Control, X-Request-Id
500 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Gerekli bir bağımlılık veya gemi kaydı geçici olarak kullanılamaz
Headers: Cache-Control, X-Request-Id
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/trial-credit-request
Hesabın bir ömür boyu deneme Kredi isteği gönder
Deneme miktarı ve kullanım durumu, talep gönderdiğinizde kaydedilir.
Kimlik: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
Idempotency-Key · header · gerekli
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}İstenilen Vücut · Seçmeli opsiyonel
Schema · application/json
{
"type": "object",
"additionalProperties": false
}Yanıtlar
201 Deneme Kredi talebi, e-posta sağlayıcının ne olursa olsun, doğrulanmış hesaplar için otomatik olarak onaylanmış ve onaylanmış hesaplar için onaylanmış ve otomatik olarak onaylanmıştır.
Headers: Cache-Control
201 yanıt · application/json
{
"$ref": "#/components/schemas/TrialCreditState"
}401 Gerekli veya geçersiz
Headers: Cache-Control, X-Request-Id
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Gerçekleştirilmedi ama izin verilmiyor veya CSRF geçerliliği başarısız oldu
Headers: Cache-Control, X-Request-Id
403 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Kaynak durumu veya idempotency çatışma
Headers: Cache-Control, X-Request-Id
409 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 İstek doğrulama başarısız oldu
Headers: Cache-Control, X-Request-Id
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Beklenmeyen bir iç hata meydana geldi
Headers: Cache-Control, X-Request-Id
500 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Gerekli bir bağımlılık veya gemi kaydı geçici olarak kullanılamaz
Headers: Cache-Control, X-Request-Id
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Teslimat Teslimatı
GET/delivery/webhooks
Liste URLs
Kimlik: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Yanıtlar
200 Callback URLs
200 yanıt · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeliveryWebhook"
}
}
}
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/delivery/webhooks
Tamamlanan bir çağrı URL
Kimlik: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
İstenilen Vücut · gerekli
Schema · application/json
{
"$ref": "#/components/schemas/CreateDeliveryWebhookRequest"
}Yanıtlar
201 Oluşturulmuş Oluşturulmuş Yaratılmış Yaratılmış Yaratılmıştır
201 yanıt · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"webhook"
],
"properties": {
"webhook": {
"$ref": "#/components/schemas/DeliveryWebhook"
}
}
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 İstek doğrulama başarısız oldu
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/delivery/webhooks/{webhookId}
Tamamlanan bir çağrıyı URL
Kimlik: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
webhookId · path · gerekli
Schema
{
"type": "string",
"pattern": "^cbk_[A-Za-z0-9_-]{8,}$"
}Yanıtlar
204 Kaldırın
401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Kaynak bulunamadı ya da çağrıcı tarafından sahip değil
404 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/delivery/webhooks/{webhookId}/test
Bir örnek indir-tam ücretload gönderin
Kimlik: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
webhookId · path · gerekli
Schema
{
"type": "string",
"pattern": "^cbk_[A-Za-z0-9_-]{8,}$"
}Yanıtlar
200 Test denendi Test denendi
200 yanıt · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"statusCode",
"webhook"
],
"properties": {
"statusCode": {
"type": "integer",
"minimum": 0
},
"webhook": {
"$ref": "#/components/schemas/DeliveryWebhook"
}
}
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Kaynak bulunamadı ya da çağrıcı tarafından sahip değil
404 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Jobs Jobs Jobs
Teklif için, durum ve sonuç örnekleri, bakınız Realtime ve async · Batch istekleri.
GET/jobs
Liste Data API şu anki iş alanı için işler
Cursor-paginated Aktif ve arşivli tarihi. Son yedi güne kadar sıralanır; her UTC tarihi aralığı 31 günleriyle sınırlıdır. Kapital ve özeldir, dakika hassasiyet. Summaries asynchronously olarak muhafaza edilir ve enjekte olabilir.
Kimlik: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
cursor · query · Seçmeli opsiyonel
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 512
}limit · query · Seçmeli opsiyonel
Schema
{
"type": "integer",
"minimum": 1,
"maximum": 50
}source · query · Seçmeli opsiyonel
Schema
{
"type": "string",
"pattern": "^(google|youtube|google_[a-z]+|youtube_[a-z_]+)$"
}status · query · Seçmeli opsiyonel
Schema
{
"type": "string",
"enum": [
"completed",
"failed",
"pending",
"processing"
]
}mode · query · Seçmeli opsiyonel
Schema
{
"type": "string",
"enum": [
"async",
"batch",
"realtime"
]
}from · query · Seçmeli opsiyonel
Schema
{
"type": "string",
"format": "date-time"
}to · query · Seçmeli opsiyonel
Schema
{
"type": "string",
"format": "date-time"
}Yanıtlar
200 İş sayfası
200 yanıt · 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 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 İstek doğrulama başarısız oldu
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/jobs/{jobId}
Bir Data API işi okuyun
job.status'u ilerlemeyi kontrol etmek için ve job.error'u işlem başarısız olursa. JSON varsayılandır; Accept: text/plain'u okunabilir metin için kullanır. X-Respond-With burada göz ardı edilir. Retry-After'u tekrar kontrol etmeden önce takip edin.
Kimlik: cookieSession veya veya veya dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
Accept · header · Seçmeli opsiyonel
application/json orijinal yapılandırılmış cevabı döndürür; text/plain aynı alanları açık metin olarak döndürür. Standart medya aralıkları ve q ağırlıkları desteklenmekte; Accept veya JSON'ye küresel bir vahşi kart varsayılanı eksik. X-Respond-With, başvuru ve iş-status uç noktalarında göz ardı edilir. Hatalar yapılandırılmış JSON kalır. Her iki yanıt türü de UTF-8 kullanıyor; açık bir karset=utf-8 parametresi desteklenmektedir.
Schema
{
"type": "string"
}jobId · path · gerekli
Schema
{
"type": "string",
"pattern": "^job_[A-Za-z0-9_-]+$"
}Yanıtlar
200 İş detayı
200 yanıt · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"job"
],
"properties": {
"job": {
"$ref": "#/components/schemas/ConsoleJob"
}
}
}200 yanıt · text/plain
{
"type": "string"
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Kaynak bulunamadı ya da çağrıcı tarafından sahip değil
404 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}406 Ne application/json ne de text/plain kabul edilebilir; yanıt JSON
406 yanıt · application/json
{
"$ref": "#/components/schemas/QueryRepresentationError"
}GET/jobs/{jobId}/results
Tamamlanmış bir amin sonucu indirin
Varsayılan olarak, erişim ve kısa ömürlü bir özel R2 URL; müşteriler JSON'dan doğrudan R2'dan alırlar. Accept: text/plain bağımsız olarak HTTP 200'u orijinal sonuç alanları ile belirli metin olarak döndürür. X-Respond-With: markdown seçilir Markdown İçerik: application/json Orijinal metadata'nın yanında, sonuçları yerine getirir; text/plain Metadata'yı takip ederek geri döndü Markdown. Eksik Accept veya JSON'ye küresel bir vahşi kart varsayılanı. Biçimlendirme başka bir sorgu veya şarj sorgu kredilerini sunmaz. Mağazalı sonuçlar tamamlandıktan sonra 24 saatlerini sona erdirir. Hatalar yapılandırılmış JSON kalır.
Kimlik: cookieSession veya veya veya dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
X-Respond-With · header · Seçmeli opsiyonel
Markdown olarak içeriği geri çevirmek için işaret etmek için ayarlayın. Omit orijinal sonucu alanları korumak için. Accept bağımsız olarak JSON veya düz metin seçer. Sadece gerçek zamanlı sorgular ve iş sonucu bu başlığı destekliyor. İş teklifleri, durum, hesap API'leri, çağrıları, Bulk dosyaları, ikili indirmeleri veya MCP protokolü yanıtlarını değiştirmez.
Schema
{
"type": "string",
"enum": [
"markdown"
]
}Accept · header · Seçmeli opsiyonel
application/json veya text/plain'dan bağımsız olarak X-Respond-With'yu seçin. X-Respond-With olmadan, text/plain orijinal alanları indentasyonla döndürür; JSON, orijinal yanıt alanlarını korur (sonsuz okumalar depolamaya yönlendirilir). İşaretle, JSON, içerik artı metadata ve düz metin geri döndürür, Markdown. Standart medya aralıkları ve q ağırlıkları desteklenmekte; Accept veya JSON'ye küresel bir vahşi kart varsayılanı eksik. Her iki yanıt türü de UTF-8 kullanıyor; açık bir karset=utf-8 parametresi desteklenmektedir.
Schema
{
"type": "string"
}jobId · path · gerekli
Schema
{
"type": "string",
"pattern": "^job_[A-Za-z0-9_-]+$"
}Yanıtlar
200 Özgün alanlar düz metin olarak veya Markdown doğrudan döner; varsayılan yönlendirme izlenirse özgün JSON R2 üzerinden alınır
200 yanıt · application/json
{
"anyOf": [
{
"$ref": "#/components/schemas/MarkdownQueryResult"
},
{
"type": "object",
"additionalProperties": true
}
]
}200 yanıt · text/plain
{
"type": "string"
}302 Orijinal JSON'ye özel R2 depolamada JSON, X-Respond-With olmadan seçilir
Headers: Location
400 Desteksiz X-Respond-With değeri; cevap JSON
400 yanıt · application/json
{
"$ref": "#/components/schemas/QueryRepresentationError"
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Kaynak bulunamadı ya da çağrıcı tarafından sahip değil
404 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}406 Ne application/json ne de text/plain kabul edilebilir; yanıt JSON
406 yanıt · application/json
{
"$ref": "#/components/schemas/QueryRepresentationError"
}409 Kaynak durumu veya idempotency çatışma
409 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Sonuç süresi sona ermişti
410 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 İş başarısız oldu. Hata nedeni kaydedilmişse yanıtın detail alanında yer alır.
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Gerekli bir bağımlılık veya katalog geçici olarak kullanılamaz
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Bulk işleme API’si
Bulk uç noktaları parametreler, istek örnekleri ve yanıt şemaları ile özel bir referansa sahiptir. Open Bulk processing API
GET /v2/bulk-jobs· Liste listesi: YouTube işleriPOST /v2/bulk-jobs· Bulk işi oluşturun ve dosya yükleme URL adresini alınGET /v2/bulk-jobs/{bulkId}· Katı iş ilerlemesini ve toplam sayılarını okuyunPATCH /v2/bulk-jobs/{bulkId}· Başlamamış olan videolar için değişim ayarlarıDELETE /v2/bulk-jobs/{bulkId}· Bir Bulk işi iptal etPOST /v2/bulk-jobs/{bulkId}/start· Yüklemeye başlayın YouTube ID dosyasınıPOST /v2/bulk-jobs/{bulkId}/pause· Bir Bulk işiPOST /v2/bulk-jobs/{bulkId}/resume· Bir el veya otomatik olarak toplu işi durdururGET /v2/bulk-jobs/{bulkId}/results· Tamamlanan kitleyi indirinGET /v2/bulk-jobs/{bulkId}/results/{partNumber}· Bir gzip-kompresyon NDJSON toplu sonucu bölümünü indirin
Oyun alanı
POST/playground/run
Mevcut iş alanı olarak bir oyun sorguunu çalıştırın
Kimlik: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
İstenilen Vücut · gerekli
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
}
}
}Yanıtlar
200 Upstream Data API yanıtı oyun alanı için yakalanan
200 yanıt · 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 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 İstek doğrulama başarısız oldu
422 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/playground/jobs/{jobId}/download
Mevcut tarayıcıda tamamlanmış bir alan sanatı indirin
Kimlik: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parametreler
jobId · path · gerekli
Schema
{
"type": "string",
"pattern": "^job_[A-Za-z0-9_-]+$"
}Yanıtlar
200 Geçici tarayıcı-download sanatifact
Headers: Content-Disposition, Content-Length
200 yanıt · application/octet-stream
{
"type": "string",
"format": "binary"
}401 Gerekli veya geçersiz
401 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Kaynak bulunamadı ya da çağrıcı tarafından sahip değil
404 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Kaynak durumu veya idempotency çatışma
409 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Geçici sanat eseri sona erdi
410 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Gerekli bir bağımlılık veya katalog geçici olarak kullanılamaz
503 yanıt · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Schema Açıklamaları
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."
}
}
}