Przeglądaj dokumentację
Dokumentacja API
Zarządzanie API odniesienia
Przeglądaj punkty końcowe dla kont, kluczy, rozliczeń i pracy. Każdy punkt końcowy zawiera wykaz własnych wymogów w zakresie uwierzytelniania i dostępu.
Przeczytaj swoje konto za pomocą klawisza API
API podstawa URL jest https://api.flashdata.dev/v2. Ten darmowy odczyt zwraca bieżący klucz i konto IDs i własność. Ustaw FLASHDATA_API_KEY przed uruchomieniem polecenia.
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'Oczekuj na sukces HTTP 200. Sprawdź linię uwierzytelniania każdego punktu końcowego: dataApiKey używa X-API-Key; cookieSession używa signed- w sesji przeglądarki. Schemat odpowiedzi tożsamości
Pobierz specyfikację OpenAPI klienta. Obejmuje zapytania, miejsca pracy, konta, klucze API i rachunki.
Parametry zapytań i kod żądania są udokumentowane w Google oraz YouTube API referencje.
Systemy uwierzytelniania
| Program | Wymóg |
|---|---|
dataApiKey |
FlashData API klucz. Dostęp do pracy jest ograniczony do skoków źródłowych klucza. |
cookieSession |
Nieprzezroczysta sesja internetowa. Przeglądarka nie może odczytać tego pliku cookie. |
csrfToken |
apiKey |
agentRegistrationProof | Persist kryptograficznie losowe 32- bajt Base64url dowód i dokładne żądanie przed wysłaniem; odzyskać tylko z tego samego dowodu i ciała. Nie jest to symbol OAuth. |
agentSetupCredential | Tymczasowa konfiguracja tylko dla statusu i tworzenia roszczeń. Nie klucz API. |
agentHandoffProof | Dowód używany do odzyskania klucza właściciela i potwierdzenia instalacji. Nigdy nie wysłano do zapytania o dane. |
agentIdentityKey | Zwyczajny klucz FlashData API w posiadaczu autoryzacji, tylko na tożsamości agenta. Zapytania danych używają X-API-Key zamiast. |
System
GET/health
Zdrowie usług
Uwierzytelnianie: Publiczny
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Odpowiedzi
200 Zdrowe
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/Health"
}GET/status
Przeczytaj streszczenie statusu elementu publicznego
Uwierzytelnianie: Publiczny
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Odpowiedzi
200 Podsumowanie stanu publicznego
Nagłówki: Cache-Control
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/PublicStatus"
}Auth
GET/oauth/requests/{requestId}
Przeczytaj wniosek o autoryzację aplikacji i powiązaj go z bieżącą sesją
Pełna sesja wymagana. Wniosek wygasa po 10 minutach. Reakcja nie jest w magazynie.
Uwierzytelnianie: cookieSession
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
requestId · path · wymagane
Schema
{
"type": "string",
"pattern": "^fdo_[A-Za-z0-9_-]{43}$"
}Odpowiedzi
200 Wymagane uprawnienia do aplikacji
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/OAuthConsent"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Uwierzytelnione, ale niedozwolone, lub walidacja CSRF nie powiodła się
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Wniosek wygasł, został wykorzystany lub związany z inną sesją
Odpowiedź 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/oauth/requests/{requestId}
Zatwierdzenie lub odrzucenie wniosku o autoryzację aplikacji
Pełna sesja, CSRF i dozwolone Pochodzenie wymagane. Raz skonsumuje prośbę. Reakcja nie jest w magazynie.
Uwierzytelnianie: cookieSession + csrfToken
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
requestId · path · wymagane
Schema
{
"type": "string",
"pattern": "^fdo_[A-Za-z0-9_-]{43}$"
}Organ wnioskujący · wymagane
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"decision"
],
"properties": {
"decision": {
"type": "string",
"enum": [
"approve",
"deny"
]
}
}
}Odpowiedzi
200 Zarejestrowany klient oddzwania z kodem lub zaprzeczeniem, państwo i emitent
Odpowiedź 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"redirectUrl"
],
"properties": {
"redirectUrl": {
"type": "string",
"format": "uri"
}
}
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Uwierzytelnione, ale niedozwolone, lub walidacja CSRF nie powiodła się
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Żądanie autoryzacji niedostępne; uruchomienie nowego połączenia
Odpowiedź 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Wniosek o zatwierdzenie nie powiódł się
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/register
Utwórz oczekujące konto FlashData
Przedłożone Warunki i Prywatność muszą odpowiadać aktualnym publikowanym pakietom prawnym.
Uwierzytelnianie: Publiczny
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Organ wnioskujący · wymagane
Schema · application/json
{
"$ref": "#/components/schemas/RegisterRequest"
}Odpowiedzi
201 Utworzony rachunek; wymagana weryfikacja poczty elektronicznej
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 201 · application/json
{
"$ref": "#/components/schemas/RegisterResponse"
}409 Stan zasobów lub konflikt idempotencji
Odpowiedź 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Wniosek o zatwierdzenie nie powiódł się
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Przekroczenie limitu pracy, swapów, partii lub wahadła
Nagłówki: Retry-After
Odpowiedź 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Wystąpił nieoczekiwany błąd wewnętrzny
Odpowiedź 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Wymagane uzależnienie lub katalog jest tymczasowo niedostępny
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/login
Utwórz nieprzejrzystą sesję WWW
Ustawia ciasteczka Secure, HttpOnly `__Host-fd_session`. Rachunki oczekujące otrzymuje ograniczoną sesję email_verification dla tablicy rozdzielczej weryfikacji. Kwalifikujące się zweryfikowane konta otrzymują jednorazowe kredyty próbne po zalogowaniu, jeśli nie zostały jeszcze przyznane. Aktywne konto otrzymuje pełną sesję, chyba że jej tożsamość migracyjna nadal wymaga obecna akceptacja prawna, w którym to przypadku otrzymuje ograniczone Sesja legal_acceptance. Konto z planowanym żądaniem usunięcia otrzymuje ograniczoną sesję deletion_recovery. Rachunki, których usunięcie jest processing/failed/completed i konta zawieszone, należy otrzymywać 403.
Uwierzytelnianie: Publiczny
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Organ wnioskujący · wymagane
Schema · application/json
{
"$ref": "#/components/schemas/LoginRequest"
}Odpowiedzi
200 Uwierzytelnione
Nagłówki: Set-Cookie, Cache-Control, X-Request-Id
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/LoginResponse"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Login jest zabroniony; Problem.code to email_not_verified, account_suspended, account_deletion_processing, account_deletion_failed lub account_deleted
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Wniosek o zatwierdzenie nie powiódł się
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}423 Tymczasowo zablokowane konto
Nagłówki: Retry-After
Odpowiedź 423 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Przekroczenie limitu pracy, swapów, partii lub wahadła
Nagłówki: Retry-After
Odpowiedź 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/logout
Przywróć bieżącą sesję
Uwierzytelnianie: cookieSession + csrfToken
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Odpowiedzi
204 Sesja cofnięta i cookies oczyszczone
Nagłówki: Set-Cookie, Cache-Control, X-Request-Id
401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Uwierzytelnione, ale niedozwolone, lub walidacja CSRF nie powiodła się
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/auth/me
Przeczytaj konto bieżące i użytkownika
Uwierzytelnianie: cookieSession
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Odpowiedzi
200 Rachunek bieżący
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/Account"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/auth/csrf
Pobierz token CSRF związany z bieżącą sesją
Uwierzytelnianie: cookieSession
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Odpowiedzi
200 Token CSRF
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"csrfToken"
],
"properties": {
"csrfToken": {
"type": "string",
"minLength": 32,
"readOnly": true
}
}
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/email-verifications
Zapytanie lub ponowne wysłanie wiadomości e-mail weryfikacji
Dla każdego poprawnego syntaktycznie e-maila, zwraca tę samą odpowiedź niezależnie od tego, czy konto jest brakujące, oczekujące, aktywne, zawieszone lub usunięte. Kwalifikujące się rachunki w toku otrzymują rotacyjny jednokrotny link po zakończeniu procesu chłodzenia.
Uwierzytelnianie: Publiczny
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Organ wnioskujący · wymagane
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 320
}
}
}Odpowiedzi
202 Zaproszenie przyjęte. Reakcja nie ujawnia, czy konto istnieje.
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 202 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"accepted"
],
"properties": {
"accepted": {
"type": "boolean",
"const": true
}
}
}422 Anonimowy wniosek o uwierzytelnianie nie powiódł się
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Przekroczony limit anonimowego uwierzytelniania
Nagłówki: Cache-Control, Retry-After, X-Request-Id
Odpowiedź 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Wystąpił nieoczekiwany błąd uwierzytelniania anonimowego
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Anonimowa zależność uwierzytelniania jest tymczasowo niedostępna
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/email-verifications/confirm
Weryfikacja wiadomości e-mail i aktywacja konta
Atomicznie zużywa jednokrotny token i aktywuje Konto i Użytkownika. Stosuje się istniejące zasady dotyczące rachunków i kredytów procesowych. Bez rejestracji Sesja użytkownik loguje się wyraźnie. Zapytanie o przyporządkowanie pochodzenia zawierające pasującą sygnaturę sesji i jej X-CSRF-Token może otrzymać rotacyjne cookies sesji na tym samym zweryfikowanym koncie; sam symbol weryfikacji nigdy nie podpisuje się u użytkownika.
Uwierzytelnianie: Publiczny
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Organ wnioskujący · wymagane
Schema · application/json
{
"$ref": "#/components/schemas/TokenRequest"
}Odpowiedzi
200 Aktywowane konto
Nagłówki: Set-Cookie, Cache-Control, X-Request-Id
Odpowiedź 200 · application/json
{
"allOf": [
{
"$ref": "#/components/schemas/Account"
},
{
"type": "object",
"properties": {
"status": {
"const": "active"
},
"emailVerified": {
"const": true
}
}
}
]
}410 Jeden token czasu jest nieważny, wygasł, unieważniony, już używany lub stracił jednocześnie wyścig potwierdzający. Problem.code jest `token_unavailable`.
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Anonimowy wniosek o uwierzytelnianie nie powiódł się
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Przekroczony limit anonimowego uwierzytelniania
Nagłówki: Cache-Control, Retry-After, X-Request-Id
Odpowiedź 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Wystąpił nieoczekiwany błąd uwierzytelniania anonimowego
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Anonimowa zależność uwierzytelniania jest tymczasowo niedostępna
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/email-verifications/session
Kontynuuj oryginalną sesję logowania po weryfikacji poczty elektronicznej
Wymagane jest dozwolone Pochodzenie i żeton CSRF związany z live hasłem uwierzytelnionym przez email session. Zwraca oczekujące do czasu zweryfikowania konta Session, w tym weryfikacji w innej przeglądarce. Atomicznie cofa sesję sygnalizacyjną i wydaje nową sesję pełną lub legalną. Nie akceptuje konta ID, e-mail, hasło lub token weryfikacji, pomijając akceptację prawną lub przyznawać kredyty.
Uwierzytelnianie: cookieSession + csrfToken
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Organ wnioskujący · wymagane
Schema · application/json
{
"type": "object",
"additionalProperties": false
}Odpowiedzi
200 Sesja sygnalizacyjna obracana
Nagłówki: Set-Cookie, Cache-Control
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/LoginResponse"
}202 Weryfikacja poczty elektronicznej jest w toku; nie ma nowej sesji
Nagłówki: Cache-Control
Odpowiedź 202 · application/json
{
"type": "object",
"required": [
"pending"
],
"additionalProperties": false,
"properties": {
"pending": {
"type": "boolean",
"const": true
}
}
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Uwierzytelnione, ale niedozwolone, lub walidacja CSRF nie powiodła się
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Wniosek o zatwierdzenie nie powiódł się
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Wystąpił nieoczekiwany błąd wewnętrzny
Odpowiedź 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/password-resets
Poproś email o resetowanie hasła
Zawsze zwraca tę samą odpowiedź 202 dla poprawnego synchronicznie e-maila niezależnie od istnienia konta lub stanu cyklu życia. Tylko kwalifikowane tożsamości aktywne lub zablokowane otrzymują pocztę.
Uwierzytelnianie: Publiczny
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Organ wnioskujący · wymagane
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 320
}
}
}Odpowiedzi
202 Zaproszenie przyjęte. Reakcja nie ujawnia, czy konto istnieje.
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 202 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"accepted"
],
"properties": {
"accepted": {
"type": "boolean",
"const": true
}
}
}422 Anonimowy wniosek o uwierzytelnianie nie powiódł się
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Przekroczony limit anonimowego uwierzytelniania
Nagłówki: Cache-Control, Retry-After, X-Request-Id
Odpowiedź 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Wystąpił nieoczekiwany błąd uwierzytelniania anonimowego
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Anonimowa zależność uwierzytelniania jest tymczasowo niedostępna
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/password-resets/confirm
Ustaw nowe hasło i cofnij istniejące sesje
Atomicznie zużywa token haseł-reset, przechowuje nowy identyfikator Argon2id, cofa każdą istniejącą sesję i unieważnia inne znaczniki haseł-reset. Nie loguje użytkownika ani nie tworzy sesji.
Uwierzytelnianie: Publiczny
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Organ wnioskujący · wymagane
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"
}
}
}Odpowiedzi
204 Aktualizacja hasła; istniejące sesje odwołane
Nagłówki: Cache-Control, X-Request-Id
410 Jeden token czasu jest nieważny, wygasł, unieważniony, już używany lub stracił jednocześnie wyścig potwierdzający. Problem.code jest `token_unavailable`.
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Anonimowy wniosek o uwierzytelnianie nie powiódł się
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Przekroczony limit anonimowego uwierzytelniania
Nagłówki: Cache-Control, Retry-After, X-Request-Id
Odpowiedź 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Wystąpił nieoczekiwany błąd uwierzytelniania anonimowego
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Anonimowa zależność uwierzytelniania jest tymczasowo niedostępna
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/auth/sessions
Lista aktywnych sesji dla bieżącego użytkownika
Uwierzytelnianie: cookieSession
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Odpowiedzi
200 Sesje
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Session"
}
}
}
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/auth/sessions
Odśwież wszystkie sesje z wyjątkiem bieżącej
Uwierzytelnianie: cookieSession + csrfToken
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Odpowiedzi
204 Pozostałe sesje odwołane
Nagłówki: Cache-Control, X-Request-Id
401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Uwierzytelnione, ale niedozwolone, lub walidacja CSRF nie powiodła się
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/auth/sessions/{sessionId}
Odnowienie jednej sesji
Uwierzytelnianie: cookieSession + csrfToken
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
sessionId · path · wymagane
Schema
{
"type": "string",
"pattern": "^ses_"
}Odpowiedzi
204 Sesja odwołana. Jeśli to była obecna sesja, plik cookie jest czysty.
Nagłówki: Set-Cookie, Cache-Control, X-Request-Id
401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Uwierzytelnione, ale niedozwolone, lub walidacja CSRF nie powiodła się
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Zasoby nieznalezione lub niebędące własnością osoby dzwoniącej
Odpowiedź 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Stan zasobów lub konflikt idempotencji
Odpowiedź 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Wniosek o zatwierdzenie nie powiódł się
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Wymagane uzależnienie lub katalog jest tymczasowo niedostępny
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/re-authenticate
Weryfikacja aktualnego hasła dla operacji sensytywnej
Zapisuje krótkotrwały dowód regent- auth na bieżącej sesji server- side.
Uwierzytelnianie: cookieSession + csrfToken
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Organ wnioskujący · wymagane
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"password"
],
"properties": {
"password": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"writeOnly": true
}
}
}Odpowiedzi
200 Sesja ma ostatnie uwierzytelnienie
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/Reauthentication"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Uwierzytelnione, ale niedozwolone, lub walidacja CSRF nie powiodła się
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Przekroczenie limitu pracy, swapów, partii lub wahadła
Nagłówki: Retry-After
Odpowiedź 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}PATCH/auth/password
Zmień hasło i obróć bieżącą sesję
Uwierzytelnianie: cookieSession + csrfToken
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Organ wnioskujący · wymagane
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
}
}
}Odpowiedzi
204 Zmienione hasło; bieżąca sesja obracana i inne sesje cofnięte na żądanie
Nagłówki: Set-Cookie, Cache-Control, X-Request-Id
401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Uwierzytelnione, ale niedozwolone, lub walidacja CSRF nie powiodła się
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Wniosek o zatwierdzenie nie powiódł się
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Konto
GET/oauth/connections
Lista podłączonych aplikacji konta bieżącego
Pełna sesja wymagana. Opróżnij, gdy konto nie ma podłączonych aplikacji. Reakcja nie jest w magazynie.
Uwierzytelnianie: cookieSession
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Odpowiedzi
200 Connected apps
Odpowiedź 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuthConnection"
}
}
}
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Uwierzytelnione, ale niedozwolone, lub walidacja CSRF nie powiodła się
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/oauth/connections/{grantId}
Otworzyć podłączoną aplikację i jej dedykowany klucz API
Pełna sesja, CSRF i dozwolone Pochodzenie wymagane. Własność konta jest egzekwowana. Reakcja nie jest w magazynie.
Uwierzytelnianie: cookieSession + csrfToken
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
grantId · path · wymagane
Schema
{
"type": "string",
"pattern": "^oag_[A-Za-z0-9_-]{8,}$"
}Odpowiedzi
204 Upoważnienie cofnięte
401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Uwierzytelnione, ale niedozwolone, lub walidacja CSRF nie powiodła się
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Zasoby nieznalezione lub niebędące własnością osoby dzwoniącej
Odpowiedź 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/account
Czytaj ustawienia konta
Uwierzytelnianie: cookieSession
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Odpowiedzi
200 Konto
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/Account"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}PATCH/account
Aktualizuj ustawienia profilu
Uwierzytelnianie: cookieSession + csrfToken
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Organ wnioskujący · wymagane
Schema · application/json
{
"$ref": "#/components/schemas/UpdateAccountRequest"
}Odpowiedzi
200 Aktualizacja konta
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/Account"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Uwierzytelnione, ale niedozwolone, lub walidacja CSRF nie powiodła się
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Wniosek o zatwierdzenie nie powiódł się
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/account
Zaplanuj usunięcie i cofnięcie wszystkich istniejących sesji i API Keys
Przed planowanym usunięciem rozliczeń zarządcy musi zostać cofnięta rola platformy poprzez skontrolowany przepływ pracy operatora. Unikalnym, aktywnym żądaniem usunięcia jest naturalna granica idempotencji. Równocześnie uwierzytelnione harmonogramy zwracają ten sam wniosek. Po cofnięciu sesji, utracona odpowiedź jest odzyskiwana poprzez logowanie się do trybu deletion_recovery i odczytanie GET /account/deletion; cofnięte sesje nigdy nie są akceptowane do powtórki.
Uwierzytelnianie: cookieSession + csrfToken
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Organ wnioskujący · wymagane
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"
}
}
}Odpowiedzi
202 Usuwanie zaplanowanych; aktywne sesje i klucze anulowane
Odpowiedź 202 · application/json
{
"$ref": "#/components/schemas/AccountDeletionRequest"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Uwierzytelnione, ale niedozwolone, lub walidacja CSRF nie powiodła się
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Stan zasobów lub konflikt idempotencji
Odpowiedź 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Wniosek o zatwierdzenie nie powiódł się
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/account/deletion
Przeczytaj żądanie usunięcia rachunku bieżącego
Uwierzytelnianie: cookieSession
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Odpowiedzi
200 Bieżący wniosek o usunięcie
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/AccountDeletionRequest"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Zasoby nieznalezione lub niebędące własnością osoby dzwoniącej
Odpowiedź 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/account/deletion
Anuluj planowane usunięcie podczas okresu karencji
Używa zaplanowanego - do - anulowanego porównania- i - zestawu. Wyścig procesora zwraca 409; po sukcesie sesja odzyskiwania jest obracana i nie może ponownie odtworzyć starego przejścia.
Uwierzytelnianie: cookieSession + csrfToken
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Odpowiedzi
204 Usuwanie anulowane, reaktywowane konto i odzyskanie Sesja obracana zgodnie z bramą akceptacji prawnej
Nagłówki: Set-Cookie, Cache-Control, X-Request-Id
401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Uwierzytelnione, ale niedozwolone, lub walidacja CSRF nie powiodła się
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Zasoby nieznalezione lub niebędące własnością osoby dzwoniącej
Odpowiedź 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Stan zasobów lub konflikt idempotencji
Odpowiedź 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/account/legal-acceptances
Accept aktualnie publikowane Warunki i wersje prywatności
Dołącza niezmienną akceptację prawną, oczyszcza bramę migracyjną i obraca sesję. Złożone wersje są odrzucane.
Uwierzytelnianie: cookieSession + csrfToken
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Organ wnioskujący · wymagane
Schema · application/json
{
"$ref": "#/components/schemas/LegalAcceptanceRequest"
}Odpowiedzi
200 Prawne akceptacja rejestrowane i Sesja obrócona do trybu pełnego
Nagłówki: Set-Cookie, Cache-Control, X-Request-Id
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/LoginResponse"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Uwierzytelnione, ale niedozwolone, lub walidacja CSRF nie powiodła się
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Zasoby nieznalezione lub niebędące własnością osoby dzwoniącej
Odpowiedź 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Wniosek o zatwierdzenie nie powiódł się
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Wsiadanie na pokład
GET/onboarding
Odczyt wznowienia postępów na pokładzie
Uwierzytelnianie: cookieSession
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Odpowiedzi
200 Bieżący stan pokładowy
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/OnboardingProgress"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Wystąpił nieoczekiwany błąd wewnętrzny
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Wymagane uzależnienie lub zapis pokładowy jest tymczasowo niedostępny
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}PATCH/onboarding
Zaawansowane wejście na pokład bez pozwalania na postęp do tyłu
Uwierzytelnianie: cookieSession + csrfToken
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Organ wnioskujący · wymagane
Schema · application/json
{
"$ref": "#/components/schemas/UpdateOnboardingRequest"
}Odpowiedzi
200 Zaktualizowany stan pokładowy
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/OnboardingProgress"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Uwierzytelnione, ale niedozwolone, lub walidacja CSRF nie powiodła się
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Stan zasobów lub konflikt idempotencji
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Wniosek o zatwierdzenie nie powiódł się
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Wystąpił nieoczekiwany błąd wewnętrzny
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Wymagane uzależnienie lub zapis pokładowy jest tymczasowo niedostępny
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Przegląd
GET/overview
Przeczytaj zagregowaną tablicę rozdzielczą konta
Uwierzytelnianie: cookieSession
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Odpowiedzi
200 Podsumowanie
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/ConsoleOverview"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Wystąpił nieoczekiwany błąd wewnętrzny
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Wymagane uzależnienie lub zapis pokładowy jest tymczasowo niedostępny
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}API Keys
GET/api-access/identity
Weryfikacja aktualnego właściciela klucza API i powtarzającej się gotowości
Free header- only API- key read. Zwraca publiczne account/key IDs i autorytatywne prawo własności. Nie ma ciała z prośbą. Nie zmienia istniejącej odpowiedzi na metadane /api-access. Udziały w kontach 120/minute - czytaj limit. Niepowodzenie zamknięte w przypadku niedostępności; nie wyciągać wniosków o własność z kluczowych prefiksów, planów lub stanu lokalnego. Nie są akceptowane żadne parametry zapytania. Odpowiedzi nie są w sklepie.
Uwierzytelnianie: dataApiKey
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Odpowiedzi
200 Weryfikacja aktualnego właściciela klucza API i powtarzającej się gotowości
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/APIKeyIdentity"
}400 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-keys
Lista metadanych klucza API
Uwierzytelnianie: cookieSession
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Odpowiedzi
200 API Keys bez tajemnic
Odpowiedź 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiKey"
}
}
}
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/api-keys
Utwórz klucz API i ujawnij jego sekret raz
Uwierzytelnianie: cookieSession + csrfToken
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
Idempotency-Key · header · wymagane
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Organ wnioskujący · wymagane
Schema · application/json
{
"$ref": "#/components/schemas/CreateApiKeyRequest"
}Odpowiedzi
201 Utworzony; ta sama powtórka idemstrong może zwrócić tę samą zaszyfrowaną odpowiedź przez pięć minut
Odpowiedź 201 · application/json
{
"$ref": "#/components/schemas/ApiKeyCreated"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Uwierzytelnione, ale niedozwolone, lub walidacja CSRF nie powiodła się
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Stan zasobów lub konflikt idempotencji
Odpowiedź 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Wniosek o zatwierdzenie nie powiódł się
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Wymagane uzależnienie lub katalog jest tymczasowo niedostępny
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/api-keys/{keyId}
Otworzyć klucz API
Uwierzytelnianie: cookieSession + csrfToken
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
keyId · path · wymagane
Schema
{
"type": "string",
"pattern": "^key_"
}Odpowiedzi
204 Odwołany
401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Uwierzytelnione, ale niedozwolone, lub walidacja CSRF nie powiodła się
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Zasoby nieznalezione lub niebędące własnością osoby dzwoniącej
Odpowiedź 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Wymagane uzależnienie lub katalog jest tymczasowo niedostępny
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/api-keys/{keyId}/rotate
Utwórz klucz zastępczy i harmonogram old- key cofnięcia
Tworzy nowy klucz i utrzymuje stary klucz aktywny do revokeOldAt. Domyślnie, pokrywanie się trwa 24 godzin lub do czasu wygaśnięcia starego klucza, w zależności od tego, która z tych dat jest wcześniejsza. Niestandardowe revokeOldAt musi być w przyszłości, w ciągu siedmiu dni, i nie później niż stare wygaśnięcie klucza.
Uwierzytelnianie: cookieSession + csrfToken
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
keyId · path · wymagane
Schema
{
"type": "string",
"pattern": "^key_"
}Idempotency-Key · header · wymagane
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Organ wnioskujący · fakultatywne
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."
}
}
}Odpowiedzi
201 Utworzona zamiana; tajne zwrócone raz
Odpowiedź 201 · application/json
{
"$ref": "#/components/schemas/ApiKeyCreated"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Uwierzytelnione, ale niedozwolone, lub walidacja CSRF nie powiodła się
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Zasoby nieznalezione lub niebędące własnością osoby dzwoniącej
Odpowiedź 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Stan zasobów lub konflikt idempotencji
Odpowiedź 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Wniosek o zatwierdzenie nie powiódł się
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Wymagane uzależnienie lub katalog jest tymczasowo niedostępny
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-access
Przeczytaj wywołanie API klucz autoryzowane źródła i źródło wyników
Uwierzytelnianie za darmo, tylko dla nagłówków X-API-Key. Zwraca wyłącznie przyznane publicznie nazwy źródłowe i skonfigurowane źródło zapisu wyników signed (null, jeśli niedostępne). Nie zwraca się konta ID, klucza ID, tajnych lub przechowywanych danych uwierzytelniających. Lokalne MCP rewaliduje ten punkt końcowy przed każdym odkryciem i wywołaniem narzędzia, w tym odczyt wyników z pamięci podręcznej. Nie są akceptowane żadne parametry zapytania ani organ wnioskujący. Wszystkie połączenia /api-access udostępniają 120 za minutę na klienta IP i zwracają Cache- Kontrola prywatna, nie-sklep. Normalne śledzenie klucza używane ostatnio nadal występuje.
Uwierzytelnianie: dataApiKey
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Odpowiedzi
200 Upoważnione źródła publiczne i pochodzenie rezultatu
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/ApiAccess"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Wniosek o zatwierdzenie nie powiódł się
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Zbyt wiele czytanych kont; powtórka po oknie limitu rate-
503 Wymagane uzależnienie lub katalog jest tymczasowo niedostępny
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Połączenia agentów
GET/agent-connections/capabilities
Odkryj protokół 2 dostępność na pokładzie
Nie są akceptowane żadne parametry zapytania. Odpowiedzi nie są w sklepie. Trasy agentów są tylko zarządzaniei obsadzone; rozmieszczenie może zwrócić 404 po wyłączeniu. X-API-Key jest zabroniony na szlakach agentów.
Uwierzytelnianie: Publiczny
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Odpowiedzi
200 Odkryj protokół 2 dostępność na pokładzie
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/AgentCapabilities"
}400 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/registrations
Utwórz lub odzyskaj tymczasowe połączenie klawiszy API-
Podać dowód rejestracyjny i dokładne wejście przed POST. Ten sam dowód i ciało odzyskują ten sam proces; zmienianie danych wejściowych powoduje konflikt. Próba czasowa: 1 Credit, 72 hours, 1 request/second, wielkość serii 1. Limity zakresu źródłowego pozostają autorytatywne na serwerze. Nie są akceptowane żadne parametry zapytania. Odpowiedzi nie są w sklepie. Trasy agentów są tylko zarządzaniei obsadzone; rozmieszczenie może zwrócić 404 po wyłączeniu. X-API-Key jest zabroniony na szlakach agentów.
Uwierzytelnianie: agentRegistrationProof
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Organ wnioskujący · wymagane
Schema · application/json
{
"$ref": "#/components/schemas/AgentRegistrationRequest"
}Odpowiedzi
201 Utwórz lub odzyskaj tymczasowe połączenie klawiszy API-
Odpowiedź 201 · application/json
{
"$ref": "#/components/schemas/AgentRegistration"
}400 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/owned
Lista połączeń będących własnością przeglądarki
Nie są akceptowane żadne parametry zapytania. Odpowiedzi nie są w sklepie. Trasy agentów są tylko zarządzaniei obsadzone; rozmieszczenie może zwrócić 404 po wyłączeniu. X-API-Key jest zabroniony na szlakach agentów. Operacja należąca do Browserów. Wymagane jest pełne zweryfikowanie sesji; dzwoniący nie może zastępować klucza API ani dowodu.
Uwierzytelnianie: cookieSession
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Odpowiedzi
200 Lista połączeń będących własnością przeglądarki
Odpowiedź 200 · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"connections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentConnection"
}
}
},
"required": [
"connections"
]
}400 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/{connectionId}
Odczytaj status tymczasowego połączenia
Nie są akceptowane żadne parametry zapytania. Odpowiedzi nie są w sklepie. Trasy agentów są tylko zarządzaniei obsadzone; rozmieszczenie może zwrócić 404 po wyłączeniu. X-API-Key jest zabroniony na szlakach agentów.
Uwierzytelnianie: agentSetupCredential
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
connectionId · path · wymagane
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Odpowiedzi
200 Odczytaj status tymczasowego połączenia
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/AgentConnectionResponse"
}400 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/agent-connections/{connectionId}
Odrodzenie własnego połączenia
Nie są akceptowane żadne parametry zapytania. Odpowiedzi nie są w sklepie. Trasy agentów są tylko zarządzaniei obsadzone; rozmieszczenie może zwrócić 404 po wyłączeniu. X-API-Key jest zabroniony na szlakach agentów. Operacja należąca do Browserów. Wymagane jest pełne zweryfikowanie sesji; dzwoniący nie może zastępować klucza API ani dowodu.
Uwierzytelnianie: cookieSession + csrfToken
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
connectionId · path · wymagane
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Origin · header · wymagane
Schema
{
"type": "string"
}X-CSRF-Token · header · wymagane
Schema
{
"type": "string"
}Odpowiedzi
204 Odrodzenie własnego połączenia
400 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/{connectionId}/identity
Weryfikacja bieżącego klucza API dla połączenia
Nie są akceptowane żadne parametry zapytania. Odpowiedzi nie są w sklepie. Trasy agentów są tylko zarządzaniei obsadzone; rozmieszczenie może zwrócić 404 po wyłączeniu. X-API-Key jest zabroniony na szlakach agentów.
Uwierzytelnianie: agentIdentityKey
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
connectionId · path · wymagane
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Odpowiedzi
200 Weryfikacja bieżącego klucza API dla połączenia
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/AgentConnectionResponse"
}400 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/{connectionId}/onboarding
Odczyt stanu pokładowego do odzyskania
Nie są akceptowane żadne parametry zapytania. Odpowiedzi nie są w sklepie. Trasy agentów są tylko zarządzaniei obsadzone; rozmieszczenie może zwrócić 404 po wyłączeniu. X-API-Key jest zabroniony na szlakach agentów.
Uwierzytelnianie: agentHandoffProof
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
connectionId · path · wymagane
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Odpowiedzi
200 Odczyt stanu pokładowego do odzyskania
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/AgentOnboardingStatus"
}400 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/{connectionId}/claims
Utwórz oświadczenie o zatwierdzeniu przeglądarki
Otwórz claimPath na zaufanym pochodzeniu WWW FlashData i wyświetl kod oddzielnie. Nigdy nie umieszczaj uwierzytelniania lub kodu potwierdzającego w URL. Nie są akceptowane żadne parametry zapytania. Odpowiedzi nie są w sklepie. Trasy agentów są tylko zarządzaniei obsadzone; rozmieszczenie może zwrócić 404 po wyłączeniu. X-API-Key jest zabroniony na szlakach agentów.
Uwierzytelnianie: agentSetupCredential
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
connectionId · path · wymagane
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Organ wnioskujący · wymagane
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {},
"required": []
}Odpowiedzi
201 Utwórz oświadczenie o zatwierdzeniu przeglądarki
Odpowiedź 201 · application/json
{
"$ref": "#/components/schemas/AgentClaim"
}400 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/claims/{claimId}/confirm
Potwierdzenie kodu roszczenia w zweryfikowanej sesji przeglądarki
Nie są akceptowane żadne parametry zapytania. Odpowiedzi nie są w sklepie. Trasy agentów są tylko zarządzaniei obsadzone; rozmieszczenie może zwrócić 404 po wyłączeniu. X-API-Key jest zabroniony na szlakach agentów. Operacja należąca do Browserów. Wymagane jest pełne zweryfikowanie sesji; dzwoniący nie może zastępować klucza API ani dowodu.
Uwierzytelnianie: cookieSession + csrfToken
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
claimId · path · wymagane
Schema
{
"type": "string",
"pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}Origin · header · wymagane
Schema
{
"type": "string"
}X-CSRF-Token · header · wymagane
Schema
{
"type": "string"
}Organ wnioskujący · wymagane
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"pattern": "^\\d{8}$"
}
},
"required": [
"code"
]
}Odpowiedzi
200 Potwierdzenie kodu roszczenia w zweryfikowanej sesji przeglądarki
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/AgentBrowserClaim"
}400 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/claims/{claimId}
Przeczytaj potwierdzoną reklamację w jej sesji przeglądarki
Nie są akceptowane żadne parametry zapytania. Odpowiedzi nie są w sklepie. Trasy agentów są tylko zarządzaniei obsadzone; rozmieszczenie może zwrócić 404 po wyłączeniu. X-API-Key jest zabroniony na szlakach agentów. Operacja należąca do Browserów. Wymagane jest pełne zweryfikowanie sesji; dzwoniący nie może zastępować klucza API ani dowodu.
Uwierzytelnianie: cookieSession
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
claimId · path · wymagane
Schema
{
"type": "string",
"pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}Odpowiedzi
200 Przeczytaj potwierdzoną reklamację w jej sesji przeglądarki
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/AgentClaimView"
}400 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/claims/{claimId}/approve
Zatwierdzenie zmniejszonych zakresów i finansowania bilansu
Nie są akceptowane żadne parametry zapytania. Odpowiedzi nie są w sklepie. Trasy agentów są tylko zarządzaniei obsadzone; rozmieszczenie może zwrócić 404 po wyłączeniu. X-API-Key jest zabroniony na szlakach agentów. Operacja należąca do Browserów. Wymagane jest pełne zweryfikowanie sesji; dzwoniący nie może zastępować klucza API ani dowodu.
Uwierzytelnianie: cookieSession + csrfToken
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
claimId · path · wymagane
Schema
{
"type": "string",
"pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}Origin · header · wymagane
Schema
{
"type": "string"
}X-CSRF-Token · header · wymagane
Schema
{
"type": "string"
}Organ wnioskujący · wymagane
Schema · application/json
{
"$ref": "#/components/schemas/AgentApproval"
}Odpowiedzi
200 Zatwierdzenie zmniejszonych zakresów i finansowania bilansu
Odpowiedź 200 · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"connection": {
"$ref": "#/components/schemas/AgentConnection"
},
"handoff": {
"type": "object",
"additionalProperties": false,
"properties": {
"status": {
"type": "string"
},
"expiresAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"status",
"expiresAt"
]
}
},
"required": [
"connection",
"handoff"
]
}400 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/{connectionId}/handoff
Odzyskiwanie zatwierdzonego właściciela API klucz
Klucz kandydacki wygasa w 24 godzin do instalacji ACK. Persystka atomicznie, przeładować w nowym procesie i zweryfikować tożsamość przed ACK. Powtórzona dostawa odzyskuje tego samego kandydata; potwierdzona dostawa zwraca pokwitowanie bez poświadczeń. Nie są akceptowane żadne parametry zapytania. Odpowiedzi nie są w sklepie. Trasy agentów są tylko zarządzaniei obsadzone; rozmieszczenie może zwrócić 404 po wyłączeniu. X-API-Key jest zabroniony na szlakach agentów.
Uwierzytelnianie: agentHandoffProof
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
connectionId · path · wymagane
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Organ wnioskujący · wymagane
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {},
"required": []
}Odpowiedzi
200 Odzyskiwanie zatwierdzonego właściciela API klucz
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/AgentHandoff"
}400 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/{connectionId}/handoff/ack
Potwierdzenie zweryfikowanej instalacji klucza własnego
Dzwoniący musiał już uratować kandydata i niezależnie zweryfikować go w nowym procesie. Udane znaki ACK zainstalowane, usuwa klucz kandydacki wygaśnięcia i usuwa odzyskiwalny materiał kredytowy. Powtórzony ACK jest idemistą. Nie są akceptowane żadne parametry zapytania. Odpowiedzi nie są w sklepie. Trasy agentów są tylko zarządzaniei obsadzone; rozmieszczenie może zwrócić 404 po wyłączeniu. X-API-Key jest zabroniony na szlakach agentów.
Uwierzytelnianie: agentHandoffProof
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
connectionId · path · wymagane
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Organ wnioskujący · wymagane
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"apiKey": {
"type": "string"
}
},
"required": [
"apiKey"
]
}Odpowiedzi
200 Potwierdzenie zweryfikowanej instalacji klucza własnego
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/AgentHandoff"
}400 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Odrzucony wniosek; sprawdź kod problemu. Nigdy nie próbuj ponownie na ślepo mutacji.
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Katalog
GET/catalog/sources
Wykaz publicznych źródeł informacji bez ustalania cen specyficznych dla danego rachunku
Uwierzytelnianie: Publiczny
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Odpowiedzi
200 Katalog źródeł publicznych
Nagłówki: Cache-Control
Odpowiedź 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSource"
}
}
}
}GET/plans
Lista planów i cen publicznych USD
Uwierzytelnianie: Publiczny
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Odpowiedzi
200 Katalog planu publicznego
Nagłówki: Cache-Control
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/PlanCatalog"
}GET/legal/current
Przeczytaj aktualne wersje Warunków i Prywatności wymagane do rejestracji
Uwierzytelnianie: Publiczny
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Odpowiedzi
200 Katalog aktualnej wersji prawnej
Nagłówki: Cache-Control
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/PublicLegalVersions"
}Billing
GET/billing/subscription
Przeczytaj efektywną subskrypcję Stripe
Uwierzytelnianie: cookieSession
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Odpowiedzi
200 Uprawnienia do subskrypcji lub PAYG
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/Subscription"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/checkout-sessions
Utwórz sesję checkout w trybie Stripe- host
Abonamenty i opublikowane pakiety kredytowe korzystają z priceId. Niestandardowe top-up wykorzystuje amountMinor zamiast (USD cents, $10 do $999,999.99); serwer oblicza kredyty na stałej wartości kredytowej i tworzy prywatną jednokrotną cenę Stripe. Produkt, cena dostawcy, waluta, sukces URL i anulować URL nigdy nie są akceptowane z przeglądarki. Kredyty przyznawane są wyłącznie po zweryfikowaniu wypłaconego zdarzenia w odniesieniu do kwotowanej kwoty.
Uwierzytelnianie: cookieSession + csrfToken
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
Idempotency-Key · header · wymagane
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Organ wnioskujący · wymagane
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"
}
}
}
]
}Odpowiedzi
201 Sesja wymeldowania pasków
Odpowiedź 201 · application/json
{
"$ref": "#/components/schemas/HostedSession"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Uwierzytelnione, ale niedozwolone, lub walidacja CSRF nie powiodła się
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Stan zasobów lub konflikt idempotencji
Odpowiedź 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Wniosek o zatwierdzenie nie powiódł się
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Nie udało się dostawcy wyższego szczebla
Odpowiedź 502 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Katalog rozliczeń lub dostawca nie jest skonfigurowany lub jest tymczasowo niedostępny
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/subscription-changes
Uaktualnienie obecnej subskrypcji Stripe do wyższej opublikowanej ceny
Serwer weryfikuje, czy cena FlashData jest aktywna, dostępna w bieżącej livemode, USD- denominowane, powtarzające się, ten sam interwał i ściśle droższe niż obecna cena subskrypcji. Produkt, cena dostawcy, waluta i opcje koloryzacji nigdy nie są akceptowane z przeglądarki. Lokalne uprawnienia i kredyty zmieniają się dopiero po planowanym zweryfikowanym zdarzeniu dostawcy.
Uwierzytelnianie: cookieSession + csrfToken
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
Idempotency-Key · header · wymagane
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Organ wnioskujący · wymagane
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"priceId"
],
"properties": {
"priceId": {
"type": "string",
"pattern": "^prc_"
}
}
}Odpowiedzi
201 Zmiana subskrypcji zgłoszona do Stripe
Odpowiedź 201 · application/json
{
"$ref": "#/components/schemas/SubscriptionChange"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Uwierzytelnione, ale niedozwolone, lub walidacja CSRF nie powiodła się
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Zasoby nieznalezione lub niebędące własnością osoby dzwoniącej
Odpowiedź 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Stan zasobów lub konflikt idempotencji
Odpowiedź 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Wniosek o zatwierdzenie nie powiódł się
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Nie udało się dostawcy wyższego szczebla
Odpowiedź 502 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Katalog rozliczeń lub dostawca nie jest skonfigurowany lub jest tymczasowo niedostępny
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/portal-sessions
Utwórz sesję portalu klienta pasków
Uwierzytelnianie: cookieSession + csrfToken
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
Idempotency-Key · header · wymagane
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Odpowiedzi
201 Sesja portalu klienta paska
Odpowiedź 201 · application/json
{
"$ref": "#/components/schemas/HostedSession"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Uwierzytelnione, ale niedozwolone, lub walidacja CSRF nie powiodła się
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Zasoby nieznalezione lub niebędące własnością osoby dzwoniącej
Odpowiedź 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Stan zasobów lub konflikt idempotencji
Odpowiedź 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Nie udało się dostawcy wyższego szczebla
Odpowiedź 502 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Katalog rozliczeń lub dostawca nie jest skonfigurowany lub jest tymczasowo niedostępny
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/subscription-cancellation
Harmonogram lub cofnięcie anulowania aktualnej opłaconej subskrypcji
Ustawienie cancelAtPeriodEnd na true anulowanie harmonogramów na bieżącym okresie rozliczeniowym; false zachowuje subskrypcję. Uaktualnienie uprawnień po zweryfikowanym zdarzeniu subskrypcji Stripe. Ten punkt końcowy nigdy nie odwołuje się natychmiast ani nie wydaje refundacji.
Uwierzytelnianie: cookieSession + csrfToken
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
Idempotency-Key · header · wymagane
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Organ wnioskujący · wymagane
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"cancelAtPeriodEnd"
],
"properties": {
"cancelAtPeriodEnd": {
"type": "boolean"
}
}
}Odpowiedzi
202 Aktualizacja anulowania przekazana do Stripe
Odpowiedź 202 · application/json
SubscriptionCancellationChange
{
"$ref": "#/components/schemas/SubscriptionCancellationChange"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Uwierzytelnione, ale niedozwolone, lub walidacja CSRF nie powiodła się
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Zasoby nieznalezione lub niebędące własnością osoby dzwoniącej
Odpowiedź 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Stan zasobów lub konflikt idempotencji
Odpowiedź 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Wniosek o zatwierdzenie nie powiódł się
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Nie udało się dostawcy wyższego szczebla
Odpowiedź 502 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Katalog rozliczeń lub dostawca nie jest skonfigurowany lub jest tymczasowo niedostępny
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/billing/invoices
Lista Projekcje faktury Stripe
Uwierzytelnianie: cookieSession
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
cursor · query · fakultatywne
Schema
{
"type": "string",
"maxLength": 512
}limit · query · fakultatywne
Schema
{
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}Odpowiedzi
200 Faktury
401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/billing/payments
Lista prognozowanych płatności z tytułu rozliczeń i płatności zwrotnych
Uwierzytelnianie: cookieSession
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
cursor · query · fakultatywne
Schema
{
"type": "string",
"maxLength": 512
}limit · query · fakultatywne
Schema
{
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}Odpowiedzi
200 Historia płatności za jeden czas bez tajemnic dostawcy
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/BillingPaymentPage"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Kredyty
GET/api-access/balance
Przeczytaj saldo konta na żywo za pomocą klawisza API
Przeczytaj bieżące saldo kredytowe udostępniane przez wszystkie klucze API na koncie. Aktywne rezerwacje mogą zmniejszyć dostępną równowagę. Żądanie to nie kosztuje żadnych Kredytów i nie wymaga żadnych parametrów zapytania lub organu. Odpowiedzi są prywatne i nie są buforowane; stosuje się limity stawek za odczyt rachunków.
Uwierzytelnianie: dataApiKey
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Odpowiedzi
200 Kredyty i pożyczki, które nie są dostępne
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/ApiAccessBalance"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Wniosek o zatwierdzenie nie powiódł się
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Zbyt wiele czytanych kont; powtórka po oknie limitu rate-
503 Wymagane uzależnienie lub katalog jest tymczasowo niedostępny
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-access/pricing
Przeczytaj rzeczywiste ceny kont dla źródeł autoryzowanych przez klucz API
Odczytaj stawki konta dla źródeł dozwolonych przez klucz API. Cena null oznacza, że źródło jest niedostępne. request_count liczy zapytania, nie zwracane przedmioty; stawki pobierania są na TB (10 ^ 12 bajtów). Szacunki nie rezerwują kredytów ani zdolności produkcyjnych. Wniosek ten nie kosztuje żadnych kredytów. Odpowiedzi są prywatne i nie są buforowane; stosuje się limity stawek za odczyt rachunków.
Uwierzytelnianie: dataApiKey
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
source · query · fakultatywne
Źródło przyznane temu kluczykowi; pominięcie odczytywania wszystkich przyznanych źródeł.
Schema
{
"$ref": "#/components/schemas/ApiAccessSource"
}request_count · query · fakultatywne
Określona liczba połączeń całkowitych; nie szacuje wielkości pobierania.
Schema
{
"type": "integer",
"minimum": 1,
"maximum": 100000,
"default": 1
}Odpowiedzi
200 Plan rachunkowy i ceny specyficzne dla danego źródła
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/ApiAccessPricing"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Uwierzytelnione, ale niedozwolone, lub walidacja CSRF nie powiodła się
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Wniosek o zatwierdzenie nie powiódł się
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Zbyt wiele czytanych kont; powtórka po oknie limitu rate-
503 Wymagane uzależnienie lub katalog jest tymczasowo niedostępny
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-access/limits
Czytaj limity planu konta i bieżące zadania oczekujące za pomocą klawisza API
Czytaj swoje limity współzależności, rozmiar batch- i wahadług-zadania, plus aktualny licznik oczekujących. Wartości te pomagają planować wnioski, ale nie rezerwują zdolności przewozowej. Żądanie to nie kosztuje żadnych Kredytów i nie wymaga żadnych parametrów zapytania lub organu. Odpowiedzi są prywatne i nie są buforowane; stosuje się limity stawek za odczyt rachunków.
Uwierzytelnianie: dataApiKey
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Odpowiedzi
200 Pułapy planu i bieżąca liczba oczekujących
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/ApiAccessLimits"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Wniosek o zatwierdzenie nie powiódł się
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Zbyt wiele czytanych kont; powtórka po oknie limitu rate-
503 Wymagane uzależnienie lub katalog jest tymczasowo niedostępny
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/usage
Odczytaj korzystanie z konta dla źródeł autoryzowanych przez klawisz API
Bezpłatny odczyt, uwierzytelniony tylko przez X-API-Key. Zawiera wszystkie klucze konta, ale tylko źródła przyznane kluczykowi. Nie zwraca tekstu zapytania, kluczy, szczegóły dotyczące płatności lub inne rachunki. Domyślnie do siedmiu dni; maksymalnie 31 dni. Daty muszą używać znaczników czasu UTC Z. Od inclusive do exclusive; oba są zaokrąglone w dół do minut. Z samego, do domyślnych z + 7 dni. Z żadnym, to jest początek następnej minuty. Agregaty są w końcu konsekwentny; nawet aktualizacja = false nie gwarantuje, że wszystkie ostatnie wydarzenia są spożywane. Limit odczytu: 60 żądań za minutę na klienta IP.
Uwierzytelnianie: dataApiKey
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
source · query · fakultatywne
Dokładne źródło katalogu przyznane kluczykowi wywoławczemu; pominięte oznacza wszystkie przyznane źródła.
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 · fakultatywne
Schema
{
"type": "string",
"format": "date-time"
}to · query · fakultatywne
Schema
{
"type": "string",
"format": "date-time"
}Odpowiedzi
200 Zbadany wniosek liczy się i ładowane Kredyty, z informacji świeżości
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/ApiKeyUsage"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Uwierzytelnione, ale niedozwolone, lub walidacja CSRF nie powiodła się
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Wniosek o zatwierdzenie nie powiódł się
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Zbyt wiele odczytów; powtórka po oknie limitu rate-
503 Wymagane uzależnienie lub katalog jest tymczasowo niedostępny
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/credits/balance
Czytaj aktualne dostępne i zastrzeżone kredyty
Uwierzytelnianie: cookieSession
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Odpowiedzi
200 Saldo kredytowe
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/CreditBalance"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/credits/policy
Przeczytaj efektywną politykę przyznawania kredytów na rachunku bankowym i pobierania opłat
Uwierzytelnianie: cookieSession
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Odpowiedzi
200 Skuteczna polityka kredytowa
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/CreditPolicy"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/credits/transactions
Lista wpisów w rejestrze kredytowym
Uwierzytelnianie: cookieSession
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
cursor · query · fakultatywne
Schema
{
"type": "string",
"maxLength": 512
}limit · query · fakultatywne
Schema
{
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}type · query · fakultatywne
Schema
{
"$ref": "#/components/schemas/CreditEntryType"
}Odpowiedzi
200 Wpisy w liście
Odpowiedź 200 · application/json
{
"allOf": [
{
"$ref": "#/components/schemas/Page"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditTransaction"
}
}
}
}
]
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Kredyty próbne
GET/trial-credit-request
Odczyt Kwalifikowalność do kredytu próbnego i wniosek konta na całe życie
Uwierzytelnianie: cookieSession
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Odpowiedzi
200 Bieżąca kwalifikowalność, skonfigurowana dotacja i stan żądania
Nagłówki: Cache-Control
Odpowiedź 200 · application/json
{
"$ref": "#/components/schemas/TrialCreditState"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Wystąpił nieoczekiwany błąd wewnętrzny
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Wymagane uzależnienie lub zapis pokładowy jest tymczasowo niedostępny
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/trial-credit-request
Prześlij jeden życiowy wniosek o przyznanie kredytu
Kwota próbna i przypadek użycia są zapisywane podczas składania wniosku.
Uwierzytelnianie: cookieSession + csrfToken
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
Idempotency-Key · header · wymagane
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Organ wnioskujący · fakultatywne
Schema · application/json
{
"type": "object",
"additionalProperties": false
}Odpowiedzi
201 Prośba o kredyt próbny utworzona i automatycznie zatwierdzona dla kwalifikowanych rachunków zweryfikowanych, niezależnie od dostawcy poczty elektronicznej
Nagłówki: Cache-Control
Odpowiedź 201 · application/json
{
"$ref": "#/components/schemas/TrialCreditState"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Uwierzytelnione, ale niedozwolone, lub walidacja CSRF nie powiodła się
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Stan zasobów lub konflikt idempotencji
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Wniosek o zatwierdzenie nie powiódł się
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Wystąpił nieoczekiwany błąd wewnętrzny
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Wymagane uzależnienie lub zapis pokładowy jest tymczasowo niedostępny
Nagłówki: Cache-Control, X-Request-Id
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Dostawa
GET/delivery/webhooks
Lista zapisanych połączeń zakończeniowych URLs
Uwierzytelnianie: cookieSession
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Odpowiedzi
200 Callback URLs
Odpowiedź 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeliveryWebhook"
}
}
}
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/delivery/webhooks
Zapisz zakończenie wywołania URL
Uwierzytelnianie: cookieSession + csrfToken
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Organ wnioskujący · wymagane
Schema · application/json
{
"$ref": "#/components/schemas/CreateDeliveryWebhookRequest"
}Odpowiedzi
201 Stworzony
Odpowiedź 201 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"webhook"
],
"properties": {
"webhook": {
"$ref": "#/components/schemas/DeliveryWebhook"
}
}
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Wniosek o zatwierdzenie nie powiódł się
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/delivery/webhooks/{webhookId}
Usuń zakończenie wywołania URL
Uwierzytelnianie: cookieSession + csrfToken
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
webhookId · path · wymagane
Schema
{
"type": "string",
"pattern": "^cbk_[A-Za-z0-9_-]{8,}$"
}Odpowiedzi
204 Usunięty
401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Zasoby nieznalezione lub niebędące własnością osoby dzwoniącej
Odpowiedź 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/delivery/webhooks/{webhookId}/test
Wyślij próbkę do pobrania - pełne obciążenie
Uwierzytelnianie: cookieSession + csrfToken
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
webhookId · path · wymagane
Schema
{
"type": "string",
"pattern": "^cbk_[A-Za-z0-9_-]{8,}$"
}Odpowiedzi
200 Próba badania
Odpowiedź 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"statusCode",
"webhook"
],
"properties": {
"statusCode": {
"type": "integer",
"minimum": 0
},
"webhook": {
"$ref": "#/components/schemas/DeliveryWebhook"
}
}
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Zasoby nieznalezione lub niebędące własnością osoby dzwoniącej
Odpowiedź 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Miejsca pracy
Przykłady składania, statusu i wyników, patrz Realtime i async · Wnioski Batch.
GET/jobs
Lista zadań API dla bieżącej przestrzeni roboczej
Kursoryczna historia aktywna i archiwizowana. Domyślnie w ciągu ostatnich siedmiu dni; każdy zakres daty UTC jest ograniczony do dni 31. Od jest inclusive i do jest ekskluzywny, w minucie precyzji. Podsumowania są utrzymywane asynchronicznie i mogą opóźniać spożycie.
Uwierzytelnianie: cookieSession
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
cursor · query · fakultatywne
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 512
}limit · query · fakultatywne
Schema
{
"type": "integer",
"minimum": 1,
"maximum": 50
}source · query · fakultatywne
Schema
{
"type": "string",
"pattern": "^(google|youtube|google_[a-z]+|youtube_[a-z_]+)$"
}status · query · fakultatywne
Schema
{
"type": "string",
"enum": [
"completed",
"failed",
"pending",
"processing"
]
}mode · query · fakultatywne
Schema
{
"type": "string",
"enum": [
"async",
"batch",
"realtime"
]
}from · query · fakultatywne
Schema
{
"type": "string",
"format": "date-time"
}to · query · fakultatywne
Schema
{
"type": "string",
"format": "date-time"
}Odpowiedzi
200 Strona zadań
Odpowiedź 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"pagination",
"summary"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleJob"
}
},
"pagination": {
"$ref": "#/components/schemas/Pagination"
},
"summary": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"required": [
"completed",
"credits",
"failed",
"total"
],
"properties": {
"completed": {
"type": "integer",
"minimum": 0
},
"credits": {
"type": "number",
"minimum": 0
},
"failed": {
"type": "integer",
"minimum": 0
},
"total": {
"type": "integer",
"minimum": 0
},
"updating": {
"type": "boolean"
}
}
}
}
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Wniosek o zatwierdzenie nie powiódł się
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/jobs/{jobId}
Przeczytaj jedno zadanie API
Przeczytaj job.status, aby sprawdzić postęp i job.error, jeśli przetwarzanie nie powiodło się. JSON jest domyślnym; użyj Accept: text/plain do odczytu tekstu. X-Respond-With jest tutaj ignorowane. Należy postępować zgodnie z Retry-After, jeśli jest dostarczony przed ponownym sprawdzeniem.
Uwierzytelnianie: cookieSession lub dataApiKey
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
Accept · header · fakultatywne
application/json zwraca pierwotną ustrukturyzowaną odpowiedź; text/plain zwraca te same pola co zaznaczony zwykły tekst. Obsługiwane są standardowe zakresy nośników i wagi q; brak wartości Accept lub domyślne wartości globalnej karty dzikiej dla JSON. X-Respond-With jest ignorowany w punktach końcowych składania wniosków i statusu pracy. Błędy pozostają ustrukturyzowane JSON. Oba typy odpowiedzi używają UTF-8; wspierany jest wyraźny zestaw znaków = utf- 8.
Schema
{
"type": "string"
}jobId · path · wymagane
Schema
{
"type": "string",
"pattern": "^job_[A-Za-z0-9_-]+$"
}Odpowiedzi
200 Szczegóły dotyczące pracy
Odpowiedź 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"job"
],
"properties": {
"job": {
"$ref": "#/components/schemas/ConsoleJob"
}
}
}Odpowiedź 200 · text/plain
{
"type": "string"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Zasoby nieznalezione lub niebędące własnością osoby dzwoniącej
Odpowiedź 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}406 Ani application/json ani text/plain jest do przyjęcia; odpowiedź jest JSON
Odpowiedź 406 · application/json
{
"$ref": "#/components/schemas/QueryRepresentationError"
}GET/jobs/{jobId}/results
Pobierz zakończony wynik async
Domyślnie uwierzytelnia dostęp i przekierowuje do krótkiego życia prywatnego R2 URL; klienci otrzymują oryginał JSON bezpośrednio od R2. Accept: text/plain niezależnie zwraca HTTP 200 z oryginalnymi polami wyników jako zaznaczony zwykły tekst. X-Respond-With: wybór znaczników Markdown: application/json zawija go w zawartość obok oryginalnych metadanych, zastępując wyniki; text/plain zwraca metadane, a następnie Markdown. Brak wartości Accept lub domyślne wartości globalnej karty dzikiej dla JSON. Formatowanie nie powoduje przesłania kolejnego zapytania lub ładowania kredytów zapytania. Wyniki przechowywania wygasają 24 godziny po zakończeniu leczenia. Błędy pozostają ustrukturyzowane JSON.
Uwierzytelnianie: cookieSession lub dataApiKey
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
X-Respond-With · header · fakultatywne
Ustaw na markdown, aby zwrócić zawartość wyniku jako Markdown. Należy pozostawić pola wyjściowe. Accept niezależnie wybiera JSON lub zwykły tekst. Tylko zapytania w czasie rzeczywistym i zakończony wynik zadania odczytuje wsparcie dla tego nagłówka. Nie zmienia on zgłoszeń o pracę, statusu, API konta, połączeń zwrotnych, plików Bulk, plików binarnych do pobrania lub odpowiedzi protokołu MCP.
Schema
{
"type": "string",
"enum": [
"markdown"
]
}Accept · header · fakultatywne
Wybierz application/json lub text/plain niezależnie od X-Respond-With. Bez X-Respond-With, text/plain zwraca oryginalne pola z wcięciem; JSON zachowuje oryginalne pola odpowiedzi (zakończony wynik odczytuje redirect do przechowywania). Z markdown, JSON zwraca zawartość plus metadane i zwykły tekst zwraca metadane, a następnie Markdown. Obsługiwane są standardowe zakresy nośników i wagi q; brak wartości Accept lub domyślne wartości globalnej karty dzikiej dla JSON. Oba typy odpowiedzi używają UTF-8; wspierany jest wyraźny zestaw znaków = utf- 8.
Schema
{
"type": "string"
}jobId · path · wymagane
Schema
{
"type": "string",
"pattern": "^job_[A-Za-z0-9_-]+$"
}Odpowiedzi
200 Pola oryginalne w formacie plain- text lub Markdown zwrócone bezpośrednio; oryginał JSON z R2 po zakończeniu domyślnej redirect
Odpowiedź 200 · application/json
{
"anyOf": [
{
"$ref": "#/components/schemas/MarkdownQueryResult"
},
{
"type": "object",
"additionalProperties": true
}
]
}Odpowiedź 200 · text/plain
{
"type": "string"
}302 Przekieruj do oryginału JSON w prywatnej pamięci R2, gdy JSON zostanie wybrany bez X-Respond-With
Nagłówki: Location
400 Nieobsługiwana wartość X-Respond-With; odpowiedź to JSON
Odpowiedź 400 · application/json
{
"$ref": "#/components/schemas/QueryRepresentationError"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Zasoby nieznalezione lub niebędące własnością osoby dzwoniącej
Odpowiedź 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}406 Ani application/json ani text/plain jest do przyjęcia; odpowiedź jest JSON
Odpowiedź 406 · application/json
{
"$ref": "#/components/schemas/QueryRepresentationError"
}409 Stan zasobów lub konflikt idempotencji
Odpowiedź 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Wynik wygasł
Odpowiedź 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Zadanie nie powiodło się. Zapisana przyczyna niepowodzenia pojawia się w polu detail odpowiedzi, jeśli jest dostępna.
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Wymagane uzależnienie lub katalog jest tymczasowo niedostępny
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}API przetwarzania Bulk
Punkty końcowe Bulk posiadają specjalne odniesienie z parametrami, przykładami żądań i schematami odpowiedzi. Otwarte przetwarzanie Bulk API
GET /v2/bulk-jobs· Lista miejsc pracy YouTubePOST /v2/bulk-jobs· Utwórz zadanie Bulk i uzyskaj plik do wysłania URLGET /v2/bulk-jobs/{bulkId}· Odczyt masowych prac i agregatów liczbowychPATCH /v2/bulk-jobs/{bulkId}· Zmień ustawienia dla filmów, które nie zostały uruchomioneDELETE /v2/bulk-jobs/{bulkId}· Anuluj zadanie BulkPOST /v2/bulk-jobs/{bulkId}/start· Zacznij skanowanie wysłanego pliku YouTube IDPOST /v2/bulk-jobs/{bulkId}/pause· Wstrzymaj pracę BulkPOST /v2/bulk-jobs/{bulkId}/resume· Wznawianie ręcznego lub automatycznego wstrzymania pracy masowejGET /v2/bulk-jobs/{bulkId}/results· Pobierz wypełniony manifest masowyGET /v2/bulk-jobs/{bulkId}/results/{partNumber}· Pobierz jeden Gzip- skompresowane NDJSON luzem część
Plac zabaw
POST/playground/run
Uruchom zapytanie o plac zabaw jako aktualne miejsce pracy
Uwierzytelnianie: cookieSession + csrfToken
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Organ wnioskujący · wymagane
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
}
}
}Odpowiedzi
200 Upstream Data API odpowiedź przechwycona na placu zabaw
Odpowiedź 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"body",
"endpoint",
"mode",
"status"
],
"properties": {
"body": {},
"endpoint": {
"type": "string",
"enum": [
"/v1/queries",
"/v1/queries/batch",
"/v1/queries/realtime"
]
},
"mode": {
"type": "string",
"enum": [
"realtime",
"async",
"batch"
]
},
"status": {
"type": "integer",
"minimum": 100,
"maximum": 599
}
}
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Wniosek o zatwierdzenie nie powiódł się
Odpowiedź 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/playground/jobs/{jobId}/download
Pobierz ukończony artefakt Placu zabaw w aktualnej przeglądarce
Uwierzytelnianie: cookieSession
Serwer: https://api.flashdata.dev/v2
Serwer: http://localhost:5000/v2
Parametry
jobId · path · wymagane
Schema
{
"type": "string",
"pattern": "^job_[A-Za-z0-9_-]+$"
}Odpowiedzi
200 Tymczasowy artefakt do pobrania z przeglądarki
Nagłówki: Content-Disposition, Content-Length
Odpowiedź 200 · application/octet-stream
{
"type": "string",
"format": "binary"
}401 Wymagane uwierzytelnienie lub nieprawidłowe
Odpowiedź 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Zasoby nieznalezione lub niebędące własnością osoby dzwoniącej
Odpowiedź 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Stan zasobów lub konflikt idempotencji
Odpowiedź 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Tymczasowy artefakt wygasł
Odpowiedź 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Wymagane uzależnienie lub katalog jest tymczasowo niedostępny
Odpowiedź 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Definicje schematów
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."
}
}
}