Documentatie bekijken
API-referentie
Beheer API-referentie
Blader door eindpunten voor accounts, sleutels, facturering en banen. Elk eindpunt bevat zijn eigen authenticatie- en toegangseisen.
Lees uw account met een API sleutel
De Management API basis URL is https://api.flashdata.dev/v2. Deze gratis lees geeft de huidige sleutel en account IDs en eigendom. Stel FLASHDATA_API_KEY in voordat u het commando uitvoert.
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'Verwacht HTTP 200 op succes. Controleer de Authenticatieregel van elk eindpunt: dataApiKey gebruikt X-API-Key; cookieSession gebruikt een ingelogde browsersessie. Schema voor identiteitsrespons
Download de klant OpenAPI specificatie. Het omvat vragen, taken, accounts, API sleutels en facturering.
Zoekparameters en verzoekcode worden gedocumenteerd in de Google en YouTube API referenties.
Authenticatieregelingen
| Regeling | Vereist |
|---|---|
dataApiKey |
FlashData API sleutel. De toegang tot werk is beperkt tot de brongebieden van de sleutel. |
cookieSession |
Ondoorzichtige websessie. De browser kan dit cookie niet lezen. |
csrfToken |
apiKey |
agentRegistrationProof | Perst een cryptografische willekeurige 32-byte base64url proof en exacte aanvraag VOOR het verzenden; herstel alleen met hetzelfde bewijs en lichaam. Geen OAuth token. |
agentSetupCredential | Tijdelijke setup credential voor status en claim creatie alleen. Geen data API sleutel. |
agentHandoffProof | Bewijs gebruikt om de eigenaar sleutel te herstellen en de installatie te erkennen. Nooit naar een data query gestuurd. |
agentIdentityKey | Gewone FlashData API sleutel in Authorization Bearer, alleen op agent identiteit. Dataqueries gebruiken X-API-Key in plaats daarvan. |
Systeem
GET/health
Gezondheid van diensten
Aanmeldingscontrole: Openbaar
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Antwoorden
200 Gezond
200-respons · application/json
{
"$ref": "#/components/schemas/Health"
}GET/status
Lees de samenvatting van de publieke componentstatus
Aanmeldingscontrole: Openbaar
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Antwoorden
200 Overzicht van de openbare stand
Berichtkoppen: Cache-Control
200-respons · application/json
{
"$ref": "#/components/schemas/PublicStatus"
}Auth
GET/oauth/requests/{requestId}
Lees een verzoek om app-machtiging en bind het aan de huidige sessie
Volledige sessie vereist. Het verzoek vervalt na tien minuten. Antwoord is geen winkel.
Aanmeldingscontrole: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
requestId · path · vereist
Schema
{
"type": "string",
"pattern": "^fdo_[A-Za-z0-9_-]{43}$"
}Antwoorden
200 Aangevraagde app-machtigingen
200-respons · application/json
{
"$ref": "#/components/schemas/OAuthConsent"
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Aangemeld maar niet toegestaan, of CSRF-validatie mislukt
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Verzoek verlopen, gebruikt of gebonden aan een andere sessie
410-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/oauth/requests/{requestId}
Een verzoek om toelating van een app goedkeuren of weigeren
Volledige sessie, CSRF en toegestaan Origin vereist. Vertraagt het verzoek eenmaal. Antwoord is geen winkel.
Aanmeldingscontrole: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
requestId · path · vereist
Schema
{
"type": "string",
"pattern": "^fdo_[A-Za-z0-9_-]{43}$"
}Verzoek om inlichtingen · vereist
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"decision"
],
"properties": {
"decision": {
"type": "string",
"enum": [
"approve",
"deny"
]
}
}
}Antwoorden
200 Geregistreerde cliënt callback met code of ontkenning, staat en emittent
200-respons · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"redirectUrl"
],
"properties": {
"redirectUrl": {
"type": "string",
"format": "uri"
}
}
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Aangemeld maar niet toegestaan, of CSRF-validatie mislukt
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Autorisatieverzoek niet beschikbaar; start een nieuwe verbinding
410-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Verzoekvalidering mislukt
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/register
Een FlashData-account aanmaken
De ingediende Algemene Voorwaarden en Privacy versies moeten overeenkomen met de huidige gepubliceerde juridische bundel.
Aanmeldingscontrole: Openbaar
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Verzoek om inlichtingen · vereist
Schema · application/json
{
"$ref": "#/components/schemas/RegisterRequest"
}Antwoorden
201 Account aangemaakt; e-mailverificatie vereist
Berichtkoppen: Cache-Control, X-Request-Id
201-respons · application/json
{
"$ref": "#/components/schemas/RegisterResponse"
}409 Een conflict tussen hulpbronnenstaat of idempotentie
409-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Verzoekvalidering mislukt
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Percentage, concurrency, batch, of in afwachting van werk limiet overschreden
Berichtkoppen: Retry-After
429-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Er is een onverwachte interne fout opgetreden
500-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Een vereiste afhankelijkheid of catalogus is tijdelijk niet beschikbaar
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/login
Een ondoorzichtige websessie aanmaken
Stelt de beveiligde, HttpOnly `__Host-fd_session` cookie in. In afwachting van de rekeningen ontvangt een beperkte email_verification Session voor het verificatie dashboard. In aanmerking komende geverifieerde rekeningen ontvangen hun eenmalige Trial Credits in login indien niet reeds toegekend. Een actief account ontvangt een volledige sessie tenzij de gemigreerde identiteit nog steeds een de huidige wettelijke aanvaarding, in welk geval zij een beperkte toelating ontvangt legal_acceptance-sessie. Een account met een geplande verwijderingsverzoek ontvangt een beperkte deletion_recovery Session. Rekeningen waarvan de schrapping is processing/failed/completed, en geschorste rekeningen, ontvangen 403.
Aanmeldingscontrole: Openbaar
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Verzoek om inlichtingen · vereist
Schema · application/json
{
"$ref": "#/components/schemas/LoginRequest"
}Antwoorden
200 Aangemeld
Berichtkoppen: Set-Cookie, Cache-Control, X-Request-Id
200-respons · application/json
{
"$ref": "#/components/schemas/LoginResponse"
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Login is verboden; Problem.code is email_not_verified, account_suspended, account_deletion_processing, account_deletion_failed, of account_deleted
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Verzoekvalidering mislukt
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}423 Account tijdelijk vergrendeld
Berichtkoppen: Retry-After
423-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Percentage, concurrency, batch, of in afwachting van werk limiet overschreden
Berichtkoppen: Retry-After
429-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/logout
De huidige sessie herroepen
Aanmeldingscontrole: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Antwoorden
204 Sessie ingetrokken en cookie gewist
Berichtkoppen: Set-Cookie, Cache-Control, X-Request-Id
401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Aangemeld maar niet toegestaan, of CSRF-validatie mislukt
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/auth/me
Lees de huidige account en gebruiker
Aanmeldingscontrole: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Antwoorden
200 Lopende rekening
Berichtkoppen: Cache-Control, X-Request-Id
200-respons · application/json
{
"$ref": "#/components/schemas/Account"
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/auth/csrf
De CSRF token ophalen die aan de huidige sessie is gebonden
Aanmeldingscontrole: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Antwoorden
200 CSRF token
Berichtkoppen: Cache-Control, X-Request-Id
200-respons · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"csrfToken"
],
"properties": {
"csrfToken": {
"type": "string",
"minLength": 32,
"readOnly": true
}
}
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/email-verifications
Een e-mailverificatiebericht aanvragen of opnieuw versturen
Voor elke syntactisch geldige e-mail, geeft hetzelfde antwoord, ongeacht of het account ontbreekt, in afwachting, actief, opgeschort of verwijderd. In aanmerking komende rekeningen ontvangen een eenmalige link na het herversturen van de cooldown.
Aanmeldingscontrole: Openbaar
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Verzoek om inlichtingen · vereist
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 320
}
}
}Antwoorden
202 Verzoek aanvaard. Het antwoord laat niet zien of er een account bestaat.
Berichtkoppen: Cache-Control, X-Request-Id
202-respons · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"accepted"
],
"properties": {
"accepted": {
"type": "boolean",
"const": true
}
}
}422 Anonieme aanmeldingsverzoekvalidatie mislukt
Berichtkoppen: Cache-Control, X-Request-Id
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Anonieme authenticatiesnelheidlimiet overschreden
Berichtkoppen: Cache-Control, Retry-After, X-Request-Id
429-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Er is een onverwachte anonieme aanmeldingsfout opgetreden
Berichtkoppen: Cache-Control, X-Request-Id
500-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Een anonieme aanmeldingsafhankelijkheid is tijdelijk niet beschikbaar
Berichtkoppen: Cache-Control, X-Request-Id
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/email-verifications/confirm
Controleer een e-mail en activeer het account
Atomair verbruikt de eenmalige token en activeert de Account en Gebruiker. De bestaande regels inzake rekening- en studiepunten zijn van toepassing. Zonder aanmeldsessie logt de gebruiker expliciet in. Een verzoek van toegestane oorsprong dat de bijpassende signup Session bevat en de X-CSRF-Token kan een gedraaide Session cookie ontvangen voor hetzelfde geverifieerde account; een verificatie token alleen tekent nooit in een gebruiker.
Aanmeldingscontrole: Openbaar
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Verzoek om inlichtingen · vereist
Schema · application/json
{
"$ref": "#/components/schemas/TokenRequest"
}Antwoorden
200 Account geactiveerd
Berichtkoppen: Set-Cookie, Cache-Control, X-Request-Id
200-respons · application/json
{
"allOf": [
{
"$ref": "#/components/schemas/Account"
},
{
"type": "object",
"properties": {
"status": {
"const": "active"
},
"emailVerified": {
"const": true
}
}
}
]
}410 Eenvoudig token is ongeldig, verlopen, ongeldig gemaakt, al gebruikt, of verloren een gelijktijdige bevestiging race. Problem.code is `token_unavailable`.
Berichtkoppen: Cache-Control, X-Request-Id
410-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Anonieme aanmeldingsverzoekvalidatie mislukt
Berichtkoppen: Cache-Control, X-Request-Id
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Anonieme authenticatiesnelheidlimiet overschreden
Berichtkoppen: Cache-Control, Retry-After, X-Request-Id
429-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Er is een onverwachte anonieme aanmeldingsfout opgetreden
Berichtkoppen: Cache-Control, X-Request-Id
500-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Een anonieme aanmeldingsafhankelijkheid is tijdelijk niet beschikbaar
Berichtkoppen: Cache-Control, X-Request-Id
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/email-verifications/session
Ga verder met de oorspronkelijke aanmeldingssessie na e-mailverificatie
Vereist een toegestane Origin en de CSRF token gebonden aan een live wachtwoord-geauthenticeerde e-mailverificatie Session. Retourneert in afwachting totdat het eigen account van die Sessie is geverifieerd, inclusief verificatie in een andere browser. Atomair herroept de signup Session en geeft een nieuwe volledige of juridische acceptatie Session. Accepteert geen rekening ID, e-mail, wachtwoord of verificatie token, omzeilen juridische acceptatie, of subsidie credits.
Aanmeldingscontrole: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Verzoek om inlichtingen · vereist
Schema · application/json
{
"type": "object",
"additionalProperties": false
}Antwoorden
200 Aanmeldsessie geroteerd
Berichtkoppen: Set-Cookie, Cache-Control
200-respons · application/json
{
"$ref": "#/components/schemas/LoginResponse"
}202 E-mailverificatie is in behandeling; geen nieuwe sessie
Berichtkoppen: Cache-Control
202-respons · application/json
{
"type": "object",
"required": [
"pending"
],
"additionalProperties": false,
"properties": {
"pending": {
"type": "boolean",
"const": true
}
}
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Aangemeld maar niet toegestaan, of CSRF-validatie mislukt
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Verzoekvalidering mislukt
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Er is een onverwachte interne fout opgetreden
500-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/password-resets
Een wachtwoord reset e-mail aanvragen
Geeft altijd dezelfde 202-respons terug voor een syntactisch geldige e-mail, ongeacht het bestaan van een account of de status van de levenscyclus. Alleen in aanmerking komende actieve of vergrendelde identiteiten ontvangen e-mail.
Aanmeldingscontrole: Openbaar
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Verzoek om inlichtingen · vereist
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 320
}
}
}Antwoorden
202 Verzoek aanvaard. Het antwoord laat niet zien of er een account bestaat.
Berichtkoppen: Cache-Control, X-Request-Id
202-respons · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"accepted"
],
"properties": {
"accepted": {
"type": "boolean",
"const": true
}
}
}422 Anonieme aanmeldingsverzoekvalidatie mislukt
Berichtkoppen: Cache-Control, X-Request-Id
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Anonieme authenticatiesnelheidlimiet overschreden
Berichtkoppen: Cache-Control, Retry-After, X-Request-Id
429-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Er is een onverwachte anonieme aanmeldingsfout opgetreden
Berichtkoppen: Cache-Control, X-Request-Id
500-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Een anonieme aanmeldingsafhankelijkheid is tijdelijk niet beschikbaar
Berichtkoppen: Cache-Control, X-Request-Id
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/password-resets/confirm
Een nieuw wachtwoord instellen en bestaande sessies intrekken
Atomair verbruikt de password-reset token, slaat een nieuwe Argon2id credential op, trekt elke bestaande Sessie in en ongeldig maakt andere wachtwoord-reset tokens. Het logt de gebruiker niet in of maakt geen Sessie aan.
Aanmeldingscontrole: Openbaar
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Verzoek om inlichtingen · vereist
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"
}
}
}Antwoorden
204 Wachtwoord bijgewerkt; bestaande sessies ingetrokken
Berichtkoppen: Cache-Control, X-Request-Id
410 Eenvoudig token is ongeldig, verlopen, ongeldig gemaakt, al gebruikt, of verloren een gelijktijdige bevestiging race. Problem.code is `token_unavailable`.
Berichtkoppen: Cache-Control, X-Request-Id
410-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Anonieme aanmeldingsverzoekvalidatie mislukt
Berichtkoppen: Cache-Control, X-Request-Id
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Anonieme authenticatiesnelheidlimiet overschreden
Berichtkoppen: Cache-Control, Retry-After, X-Request-Id
429-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Er is een onverwachte anonieme aanmeldingsfout opgetreden
Berichtkoppen: Cache-Control, X-Request-Id
500-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Een anonieme aanmeldingsafhankelijkheid is tijdelijk niet beschikbaar
Berichtkoppen: Cache-Control, X-Request-Id
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/auth/sessions
Lijst van actieve sessies voor de huidige gebruiker
Aanmeldingscontrole: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Antwoorden
200 Sessies
Berichtkoppen: Cache-Control, X-Request-Id
200-respons · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Session"
}
}
}
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/auth/sessions
Alle sessies herroepen behalve de huidige
Aanmeldingscontrole: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Antwoorden
204 Andere sessies ingetrokken
Berichtkoppen: Cache-Control, X-Request-Id
401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Aangemeld maar niet toegestaan, of CSRF-validatie mislukt
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/auth/sessions/{sessionId}
Eén sessie herroepen
Aanmeldingscontrole: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
sessionId · path · vereist
Schema
{
"type": "string",
"pattern": "^ses_"
}Antwoorden
204 Sessie ingetrokken. Als het de huidige sessie was, wordt het cookie gewist.
Berichtkoppen: Set-Cookie, Cache-Control, X-Request-Id
401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Aangemeld maar niet toegestaan, of CSRF-validatie mislukt
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Hulpbron niet gevonden of niet eigendom van de beller
404-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Een conflict tussen hulpbronnenstaat of idempotentie
409-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Verzoekvalidering mislukt
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Een vereiste afhankelijkheid of catalogus is tijdelijk niet beschikbaar
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/re-authenticate
Verifiëren van het huidige wachtwoord voor een gevoelige bewerking
Records een kortstondige recent-auth bewijs op de huidige server-side sessie.
Aanmeldingscontrole: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Verzoek om inlichtingen · vereist
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"password"
],
"properties": {
"password": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"writeOnly": true
}
}
}Antwoorden
200 Sessie heeft recente authenticatie
Berichtkoppen: Cache-Control, X-Request-Id
200-respons · application/json
{
"$ref": "#/components/schemas/Reauthentication"
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Aangemeld maar niet toegestaan, of CSRF-validatie mislukt
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Percentage, concurrency, batch, of in afwachting van werk limiet overschreden
Berichtkoppen: Retry-After
429-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}PATCH/auth/password
Wachtwoord wijzigen en de huidige sessie draaien
Aanmeldingscontrole: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Verzoek om inlichtingen · vereist
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
}
}
}Antwoorden
204 Wachtwoord gewijzigd; huidige sessie geroteerd en andere sessies ingetrokken op verzoek
Berichtkoppen: Set-Cookie, Cache-Control, X-Request-Id
401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Aangemeld maar niet toegestaan, of CSRF-validatie mislukt
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Verzoekvalidering mislukt
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Account
GET/oauth/connections
Lijst van de aangesloten apps van de huidige account
Volledige sessie vereist. Leeg wanneer het account geen verbonden apps heeft. Antwoord is geen winkel.
Aanmeldingscontrole: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Antwoorden
200 Connected apps
200-respons · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuthConnection"
}
}
}
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Aangemeld maar niet toegestaan, of CSRF-validatie mislukt
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/oauth/connections/{grantId}
Een verbonden app en de speciale API-sleutel herroepen
Volledige sessie, CSRF en toegestaan Origin vereist. De eigendom van de rekening wordt afgedwongen. Antwoord is geen winkel.
Aanmeldingscontrole: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
grantId · path · vereist
Schema
{
"type": "string",
"pattern": "^oag_[A-Za-z0-9_-]{8,}$"
}Antwoorden
204 Intrekking van de vergunning
401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Aangemeld maar niet toegestaan, of CSRF-validatie mislukt
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Hulpbron niet gevonden of niet eigendom van de beller
404-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/account
Instellingen voor account lezen
Aanmeldingscontrole: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Antwoorden
200 Account
200-respons · application/json
{
"$ref": "#/components/schemas/Account"
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}PATCH/account
Profielinstellingen bijwerken
Aanmeldingscontrole: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Verzoek om inlichtingen · vereist
Schema · application/json
{
"$ref": "#/components/schemas/UpdateAccountRequest"
}Antwoorden
200 Bijgewerkt account
200-respons · application/json
{
"$ref": "#/components/schemas/Account"
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Aangemeld maar niet toegestaan, of CSRF-validatie mislukt
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Verzoekvalidering mislukt
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/account
Plan account verwijdering en herroep alle bestaande sessies en API Keys
Beheerdersrekeningen moeten hun platformrol via de gecontroleerde exploitant-workflow worden ingetrokken voordat verwijdering kan worden gepland. Een uniek actief verwijderingsverzoek is de natuurlijke idempotentiegrens. Gelijktijdige geauthentiseerde schema's geven hetzelfde verzoek terug. Na intrekking van de sessie, wordt een verloren reactie hersteld door in te loggen in deletion_recovery modus en lezen GET /account/deletion; ingetrokken Sessions worden nooit geaccepteerd voor replay.
Aanmeldingscontrole: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Verzoek om inlichtingen · vereist
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"
}
}
}Antwoorden
202 Verwijdering gepland; actieve sessies en sleutels ingetrokken
202-respons · application/json
{
"$ref": "#/components/schemas/AccountDeletionRequest"
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Aangemeld maar niet toegestaan, of CSRF-validatie mislukt
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Een conflict tussen hulpbronnenstaat of idempotentie
409-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Verzoekvalidering mislukt
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/account/deletion
Lees het verzoek tot verwijdering van de huidige rekening
Aanmeldingscontrole: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Antwoorden
200 Huidig verzoek om verwijdering
200-respons · application/json
{
"$ref": "#/components/schemas/AccountDeletionRequest"
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Hulpbron niet gevonden of niet eigendom van de beller
404-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/account/deletion
Annuleer een geplande verwijdering tijdens de aflossingsperiode
Gebruikt een geplande-tot-geannuleerde vergelijking-en-set. Een processorrace geeft 409 terug; na succes wordt de recovery Session gedraaid en kan de oude overgang niet opnieuw afspelen.
Aanmeldingscontrole: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Antwoorden
204 Verwijdering geannuleerd, account opnieuw geactiveerd, en recovery Session gedraaid volgens de wettelijke aanvaarding poort
Berichtkoppen: Set-Cookie, Cache-Control, X-Request-Id
401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Aangemeld maar niet toegestaan, of CSRF-validatie mislukt
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Hulpbron niet gevonden of niet eigendom van de beller
404-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Een conflict tussen hulpbronnenstaat of idempotentie
409-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/account/legal-acceptances
Accept de momenteel gepubliceerde Algemene Voorwaarden en Privacyversies
Voegt een onveranderlijke juridische acceptatie, ontruimt de migratie poort, en draait de sessie. Ingediende versies worden verworpen.
Aanmeldingscontrole: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Verzoek om inlichtingen · vereist
Schema · application/json
{
"$ref": "#/components/schemas/LegalAcceptanceRequest"
}Antwoorden
200 Juridische acceptatie geregistreerd en Sessie gedraaid naar volledige modus
Berichtkoppen: Set-Cookie, Cache-Control, X-Request-Id
200-respons · application/json
{
"$ref": "#/components/schemas/LoginResponse"
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Aangemeld maar niet toegestaan, of CSRF-validatie mislukt
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Hulpbron niet gevonden of niet eigendom van de beller
404-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Verzoekvalidering mislukt
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Aan boord
GET/onboarding
Lees herbruikbare onboarding vooruitgang
Aanmeldingscontrole: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Antwoorden
200 Huidige onboard status
Berichtkoppen: Cache-Control, X-Request-Id
200-respons · application/json
{
"$ref": "#/components/schemas/OnboardingProgress"
}401 Authenticatie vereist of ongeldig
Berichtkoppen: Cache-Control, X-Request-Id
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Er is een onverwachte interne fout opgetreden
Berichtkoppen: Cache-Control, X-Request-Id
500-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Een vereiste afhankelijkheid of onboarding record is tijdelijk niet beschikbaar
Berichtkoppen: Cache-Control, X-Request-Id
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}PATCH/onboarding
Aan boord gaan zonder dat vooruitgang achteruit kan gaan
Aanmeldingscontrole: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Verzoek om inlichtingen · vereist
Schema · application/json
{
"$ref": "#/components/schemas/UpdateOnboardingRequest"
}Antwoorden
200 Bijgewerkte onboard status
Berichtkoppen: Cache-Control, X-Request-Id
200-respons · application/json
{
"$ref": "#/components/schemas/OnboardingProgress"
}401 Authenticatie vereist of ongeldig
Berichtkoppen: Cache-Control, X-Request-Id
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Aangemeld maar niet toegestaan, of CSRF-validatie mislukt
Berichtkoppen: Cache-Control, X-Request-Id
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Een conflict tussen hulpbronnenstaat of idempotentie
Berichtkoppen: Cache-Control, X-Request-Id
409-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Verzoekvalidering mislukt
Berichtkoppen: Cache-Control, X-Request-Id
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Er is een onverwachte interne fout opgetreden
Berichtkoppen: Cache-Control, X-Request-Id
500-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Een vereiste afhankelijkheid of onboarding record is tijdelijk niet beschikbaar
Berichtkoppen: Cache-Control, X-Request-Id
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Overzicht
GET/overview
Lees het account dashboard aggregatie
Aanmeldingscontrole: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Antwoorden
200 Overzicht met accounts
Berichtkoppen: Cache-Control, X-Request-Id
200-respons · application/json
{
"$ref": "#/components/schemas/ConsoleOverview"
}401 Authenticatie vereist of ongeldig
Berichtkoppen: Cache-Control, X-Request-Id
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Er is een onverwachte interne fout opgetreden
Berichtkoppen: Cache-Control, X-Request-Id
500-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Een vereiste afhankelijkheid of onboarding record is tijdelijk niet beschikbaar
Berichtkoppen: Cache-Control, X-Request-Id
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}API Keys
GET/api-access/identity
Controleer de huidige API sleutel eigendom en terugkerende gereedheid
Gratis header-only API-toets gelezen. Geeft publieke account/key IDs en gezaghebbende eigendom terug. Geen verzoek om hulp. Verandert de bestaande /api-access metadatarespons niet. Deelt de 120/minute account-lezen limiet. Fout bij niet-beschikbaarheid; leidt eigendom niet af van sleutelprefix, plan of lokale staat. Er worden geen zoekparameters geaccepteerd. Antwoorden zijn geen winkel.
Aanmeldingscontrole: dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Antwoorden
200 Controleer de huidige API sleutel eigendom en terugkerende gereedheid
200-respons · application/json
{
"$ref": "#/components/schemas/APIKeyIdentity"
}400 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
400-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
409-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
410-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
429-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-keys
Lijst API Sleutelmetadata
Aanmeldingscontrole: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Antwoorden
200 API Keys zonder geheimen
200-respons · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiKey"
}
}
}
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/api-keys
Maak een API Key en onthul eens zijn geheim
Aanmeldingscontrole: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
Idempotency-Key · header · vereist
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Verzoek om inlichtingen · vereist
Schema · application/json
{
"$ref": "#/components/schemas/CreateApiKeyRequest"
}Antwoorden
201 Aangemaakt; dezelfde idempotent replay kan dezelfde versleutelde respons gedurende vijf minuten teruggeven
201-respons · application/json
{
"$ref": "#/components/schemas/ApiKeyCreated"
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Aangemeld maar niet toegestaan, of CSRF-validatie mislukt
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Een conflict tussen hulpbronnenstaat of idempotentie
409-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Verzoekvalidering mislukt
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Een vereiste afhankelijkheid of catalogus is tijdelijk niet beschikbaar
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/api-keys/{keyId}
Een API-sleutel herroepen
Aanmeldingscontrole: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
keyId · path · vereist
Schema
{
"type": "string",
"pattern": "^key_"
}Antwoorden
204 Ingetrokken
401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Aangemeld maar niet toegestaan, of CSRF-validatie mislukt
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Hulpbron niet gevonden of niet eigendom van de beller
404-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Een vereiste afhankelijkheid of catalogus is tijdelijk niet beschikbaar
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/api-keys/{keyId}/rotate
Maak een vervangende sleutel en schema voor intrekking van oude sleutels
Maakt een nieuwe sleutel aan en houdt de oude sleutel actief tot revokeOldAt. Standaard duurt de overlapping 24 uren of totdat de oude sleutel verloopt, als dat eerder is. Een aangepaste revokeOldAt moet in de toekomst, binnen zeven dagen, en niet later dan de oude sleutel verlopen.
Aanmeldingscontrole: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
keyId · path · vereist
Schema
{
"type": "string",
"pattern": "^key_"
}Idempotency-Key · header · vereist
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Verzoek om inlichtingen · facultatief
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."
}
}
}Antwoorden
201 Vervanging gecreëerd; geheim eenmaal teruggegeven
201-respons · application/json
{
"$ref": "#/components/schemas/ApiKeyCreated"
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Aangemeld maar niet toegestaan, of CSRF-validatie mislukt
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Hulpbron niet gevonden of niet eigendom van de beller
404-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Een conflict tussen hulpbronnenstaat of idempotentie
409-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Verzoekvalidering mislukt
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Een vereiste afhankelijkheid of catalogus is tijdelijk niet beschikbaar
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-access
Lees de aanroep API-sleutel's geautoriseerde bronnen en resultaat oorsprong
Vrije, alleen-header X-API-Key-authenticatie. Returns only government public bronnamen en de geconfigureerde ondertekende-resultaat opslag oorsprong (null als niet beschikbaar). Geen account ID, sleutel ID, geheim of opslaggegevens worden teruggegeven. Lokale MCP hervalideert dit eindpunt voor elke tool ontdekking en oproep, inclusief gecached resultaat leest. Er worden geen zoekparameters of verzoekinstantie geaccepteerd. Alle /api-access routes delen 120 verzoeken per minuut per client IP en retourneren Cache-Control privé, geen winkel. Normale sleutel laatst gebruikte tracking gebeurt nog steeds.
Aanmeldingscontrole: dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Antwoorden
200 Toegestaan publieke bronnen en oorsprong van het resultaat
200-respons · application/json
{
"$ref": "#/components/schemas/ApiAccess"
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Verzoekvalidering mislukt
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Te veel account leest; opnieuw proberen na het rate-limit venster
503 Een vereiste afhankelijkheid of catalogus is tijdelijk niet beschikbaar
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Agent Verbindingen
GET/agent-connections/capabilities
Ontdek protocol 2 onboarding beschikbaarheid
Er worden geen zoekparameters geaccepteerd. Antwoorden zijn geen winkel. Agent routes zijn beheer-only en feature-gaged; implementaties kunnen 404 teruggeven wanneer uitgeschakeld. X-API-Key is verboden op agent routes.
Aanmeldingscontrole: Openbaar
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Antwoorden
200 Ontdek protocol 2 onboarding beschikbaarheid
200-respons · application/json
{
"$ref": "#/components/schemas/AgentCapabilities"
}400 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
400-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
409-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
410-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
429-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/registrations
Maak of herstel een tijdelijke API-sleutelverbinding
Pers het registratiebewijs en de exacte invoer vóór POST. Hetzelfde bewijs en lichaam herstellen dezelfde proef; het veranderen van input levert conflicten op. Tijdelijke proef: 1 Credit, 72 uren, 1 request/second, batch size 1. De grenzen van de source scope blijven gezaghebbend op de server. Er worden geen zoekparameters geaccepteerd. Antwoorden zijn geen winkel. Agent routes zijn beheer-only en feature-gaged; implementaties kunnen 404 teruggeven wanneer uitgeschakeld. X-API-Key is verboden op agent routes.
Aanmeldingscontrole: agentRegistrationProof
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Verzoek om inlichtingen · vereist
Schema · application/json
{
"$ref": "#/components/schemas/AgentRegistrationRequest"
}Antwoorden
201 Maak of herstel een tijdelijke API-sleutelverbinding
201-respons · application/json
{
"$ref": "#/components/schemas/AgentRegistration"
}400 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
400-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
409-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
410-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
429-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/owned
Verbindingen met browser tonen
Er worden geen zoekparameters geaccepteerd. Antwoorden zijn geen winkel. Agent routes zijn beheer-only en feature-gaged; implementaties kunnen 404 teruggeven wanneer uitgeschakeld. X-API-Key is verboden op agent routes. Browser-eigendom operatie. Volledige geverifieerde Sessie vereist; beller mag geen API sleutel of bewijs vervangen.
Aanmeldingscontrole: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Antwoorden
200 Verbindingen met browser tonen
200-respons · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"connections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentConnection"
}
}
},
"required": [
"connections"
]
}400 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
400-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
409-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
410-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
429-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/{connectionId}
Status van tijdelijke verbinding lezen
Er worden geen zoekparameters geaccepteerd. Antwoorden zijn geen winkel. Agent routes zijn beheer-only en feature-gaged; implementaties kunnen 404 teruggeven wanneer uitgeschakeld. X-API-Key is verboden op agent routes.
Aanmeldingscontrole: agentSetupCredential
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
connectionId · path · vereist
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Antwoorden
200 Status van tijdelijke verbinding lezen
200-respons · application/json
{
"$ref": "#/components/schemas/AgentConnectionResponse"
}400 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
400-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
409-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
410-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
429-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/agent-connections/{connectionId}
Een eigendomsverbinding ongedaan maken
Er worden geen zoekparameters geaccepteerd. Antwoorden zijn geen winkel. Agent routes zijn beheer-only en feature-gaged; implementaties kunnen 404 teruggeven wanneer uitgeschakeld. X-API-Key is verboden op agent routes. Browser-eigendom operatie. Volledige geverifieerde Sessie vereist; beller mag geen API sleutel of bewijs vervangen.
Aanmeldingscontrole: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
connectionId · path · vereist
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Origin · header · vereist
Schema
{
"type": "string"
}X-CSRF-Token · header · vereist
Schema
{
"type": "string"
}Antwoorden
204 Een eigendomsverbinding ongedaan maken
400 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
400-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
409-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
410-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
429-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/{connectionId}/identity
Controleer de huidige API-toets voor een verbinding
Er worden geen zoekparameters geaccepteerd. Antwoorden zijn geen winkel. Agent routes zijn beheer-only en feature-gaged; implementaties kunnen 404 teruggeven wanneer uitgeschakeld. X-API-Key is verboden op agent routes.
Aanmeldingscontrole: agentIdentityKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
connectionId · path · vereist
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Antwoorden
200 Controleer de huidige API-toets voor een verbinding
200-respons · application/json
{
"$ref": "#/components/schemas/AgentConnectionResponse"
}400 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
400-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
409-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
410-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
429-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/{connectionId}/onboarding
Lees herstelbare onboarding toestand
Er worden geen zoekparameters geaccepteerd. Antwoorden zijn geen winkel. Agent routes zijn beheer-only en feature-gaged; implementaties kunnen 404 teruggeven wanneer uitgeschakeld. X-API-Key is verboden op agent routes.
Aanmeldingscontrole: agentHandoffProof
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
connectionId · path · vereist
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Antwoorden
200 Lees herstelbare onboarding toestand
200-respons · application/json
{
"$ref": "#/components/schemas/AgentOnboardingStatus"
}400 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
400-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
409-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
410-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
429-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/{connectionId}/claims
Een browsergoedkeuring claim maken
Open claimPath op een vertrouwde FlashData web origin en geef de code apart weer. Plaats nooit de referenties of de bevestigingscode in de URL. Er worden geen zoekparameters geaccepteerd. Antwoorden zijn geen winkel. Agent routes zijn beheer-only en feature-gaged; implementaties kunnen 404 teruggeven wanneer uitgeschakeld. X-API-Key is verboden op agent routes.
Aanmeldingscontrole: agentSetupCredential
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
connectionId · path · vereist
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Verzoek om inlichtingen · vereist
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {},
"required": []
}Antwoorden
201 Een browsergoedkeuring claim maken
201-respons · application/json
{
"$ref": "#/components/schemas/AgentClaim"
}400 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
400-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
409-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
410-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
429-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/claims/{claimId}/confirm
Bevestig de claimcode in een geverifieerde browsersessie
Er worden geen zoekparameters geaccepteerd. Antwoorden zijn geen winkel. Agent routes zijn beheer-only en feature-gaged; implementaties kunnen 404 teruggeven wanneer uitgeschakeld. X-API-Key is verboden op agent routes. Browser-eigendom operatie. Volledige geverifieerde Sessie vereist; beller mag geen API sleutel of bewijs vervangen.
Aanmeldingscontrole: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
claimId · path · vereist
Schema
{
"type": "string",
"pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}Origin · header · vereist
Schema
{
"type": "string"
}X-CSRF-Token · header · vereist
Schema
{
"type": "string"
}Verzoek om inlichtingen · vereist
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"pattern": "^\\d{8}$"
}
},
"required": [
"code"
]
}Antwoorden
200 Bevestig de claimcode in een geverifieerde browsersessie
200-respons · application/json
{
"$ref": "#/components/schemas/AgentBrowserClaim"
}400 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
400-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
409-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
410-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
429-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/claims/{claimId}
Lees een bevestigde claim in de browsersessie
Er worden geen zoekparameters geaccepteerd. Antwoorden zijn geen winkel. Agent routes zijn beheer-only en feature-gaged; implementaties kunnen 404 teruggeven wanneer uitgeschakeld. X-API-Key is verboden op agent routes. Browser-eigendom operatie. Volledige geverifieerde Sessie vereist; beller mag geen API sleutel of bewijs vervangen.
Aanmeldingscontrole: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
claimId · path · vereist
Schema
{
"type": "string",
"pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}Antwoorden
200 Lees een bevestigde claim in de browsersessie
200-respons · application/json
{
"$ref": "#/components/schemas/AgentClaimView"
}400 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
400-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
409-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
410-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
429-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/claims/{claimId}/approve
Goedkeuring van beperkte reikwijdte en financiering van de rekeningbalans
Er worden geen zoekparameters geaccepteerd. Antwoorden zijn geen winkel. Agent routes zijn beheer-only en feature-gaged; implementaties kunnen 404 teruggeven wanneer uitgeschakeld. X-API-Key is verboden op agent routes. Browser-eigendom operatie. Volledige geverifieerde Sessie vereist; beller mag geen API sleutel of bewijs vervangen.
Aanmeldingscontrole: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
claimId · path · vereist
Schema
{
"type": "string",
"pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}Origin · header · vereist
Schema
{
"type": "string"
}X-CSRF-Token · header · vereist
Schema
{
"type": "string"
}Verzoek om inlichtingen · vereist
Schema · application/json
{
"$ref": "#/components/schemas/AgentApproval"
}Antwoorden
200 Goedkeuring van beperkte reikwijdte en financiering van de rekeningbalans
200-respons · 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 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
400-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
409-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
410-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
429-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/{connectionId}/handoff
Herstellen van de goedgekeurde eigenaar API sleutel
Kandidaatsleutel verloopt in 24 uren tot installatie ACK. Persist atomair, herlaad in een nieuw proces en verifieer identiteit voor ACK. Een herhaalde levering herstelt dezelfde kandidaat; bevestigde levering geeft een ontvangstbewijs zonder referenties. Er worden geen zoekparameters geaccepteerd. Antwoorden zijn geen winkel. Agent routes zijn beheer-only en feature-gaged; implementaties kunnen 404 teruggeven wanneer uitgeschakeld. X-API-Key is verboden op agent routes.
Aanmeldingscontrole: agentHandoffProof
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
connectionId · path · vereist
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Verzoek om inlichtingen · vereist
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {},
"required": []
}Antwoorden
200 Herstellen van de goedgekeurde eigenaar API sleutel
200-respons · application/json
{
"$ref": "#/components/schemas/AgentHandoff"
}400 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
400-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
409-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
410-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
429-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/{connectionId}/handoff/ack
Bevestig geverifieerde eigenaar-sleutel installatie
De beller moet de kandidaat al hebben gered en onafhankelijk geverifieerd in een nieuw proces. Succesvolle ACK-merken geïnstalleerd, verwijdert de kandidaat sleutel verlopen en verwijdert herstelbare geloofwaardigheid materiaal. Herhaalde ACK is idempotent. Er worden geen zoekparameters geaccepteerd. Antwoorden zijn geen winkel. Agent routes zijn beheer-only en feature-gaged; implementaties kunnen 404 teruggeven wanneer uitgeschakeld. X-API-Key is verboden op agent routes.
Aanmeldingscontrole: agentHandoffProof
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
connectionId · path · vereist
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Verzoek om inlichtingen · vereist
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"apiKey": {
"type": "string"
}
},
"required": [
"apiKey"
]
}Antwoorden
200 Bevestig geverifieerde eigenaar-sleutel installatie
200-respons · application/json
{
"$ref": "#/components/schemas/AgentHandoff"
}400 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
400-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
409-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
410-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
429-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Afgewezen verzoek; controleer de Probleemcode. Probeer nooit een mutatie blindelings opnieuw.
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Cataloog
GET/catalog/sources
Lijst van publieke broncapaciteiten zonder rekeningspecifieke prijsstelling
Aanmeldingscontrole: Openbaar
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Antwoorden
200 Publieke broncatalogus
Berichtkoppen: Cache-Control
200-respons · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSource"
}
}
}
}GET/plans
Lijst openbare USD plannen en prijzen
Aanmeldingscontrole: Openbaar
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Antwoorden
200 Publiek plan catalogus
Berichtkoppen: Cache-Control
200-respons · application/json
{
"$ref": "#/components/schemas/PlanCatalog"
}GET/legal/current
Lees de huidige Voorwaarden en Privacy versies die nodig zijn voor het aanmelden
Aanmeldingscontrole: Openbaar
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Antwoorden
200 Huidige juridische versiecatalogus
Berichtkoppen: Cache-Control
200-respons · application/json
{
"$ref": "#/components/schemas/PublicLegalVersions"
}Billing
GET/billing/subscription
Lees het effectieve Stripe-abonnement
Aanmeldingscontrole: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Antwoorden
200 Abonnements- of PAYG-rechten
200-respons · application/json
{
"$ref": "#/components/schemas/Subscription"
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/checkout-sessions
Een Stripe-hosted Checkout-sessie aanmaken
Abonnementen en gepubliceerde credit packs gebruiken priceId. Een aangepaste top-up maakt gebruik van amountMinor in plaats daarvan (USD cents, $10 tot $999,999.99); de server berekent credits tegen de vaste credit waarde en creëert een prive eenmalige Stripe prijs. Product, provider prijs, valuta, succes URL en annuleren URL worden nooit geaccepteerd vanuit de browser. Credits worden pas toegekend na een geverifieerde betaalde gebeurtenis voor het vermelde bedrag.
Aanmeldingscontrole: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
Idempotency-Key · header · vereist
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Verzoek om inlichtingen · vereist
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"
}
}
}
]
}Antwoorden
201 Sessie checkout stripten
201-respons · application/json
{
"$ref": "#/components/schemas/HostedSession"
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Aangemeld maar niet toegestaan, of CSRF-validatie mislukt
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Een conflict tussen hulpbronnenstaat of idempotentie
409-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Verzoekvalidering mislukt
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Een upstreamprovider is mislukt
502-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 De facturatiecatalogus of provider is niet geconfigureerd of tijdelijk niet beschikbaar
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/subscription-changes
Upgrade van het huidige Stripe abonnement naar een hogere gepubliceerde prijs
De server controleert of de FlashData-prijs actief is, beschikbaar in de huidige livemode, USD-ingegeven, terugkerende, hetzelfde interval, en strikt duurder dan de huidige abonnementsprijs. Product, provider prijs, valuta en protatie opties worden nooit geaccepteerd vanuit de browser. Lokale rechten en kredieten veranderen pas nadat een geverifieerde provider-evenement is voorzien.
Aanmeldingscontrole: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
Idempotency-Key · header · vereist
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Verzoek om inlichtingen · vereist
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"priceId"
],
"properties": {
"priceId": {
"type": "string",
"pattern": "^prc_"
}
}
}Antwoorden
201 Abonnementswijziging ingediend op Stripe
201-respons · application/json
{
"$ref": "#/components/schemas/SubscriptionChange"
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Aangemeld maar niet toegestaan, of CSRF-validatie mislukt
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Hulpbron niet gevonden of niet eigendom van de beller
404-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Een conflict tussen hulpbronnenstaat of idempotentie
409-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Verzoekvalidering mislukt
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Een upstreamprovider is mislukt
502-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 De facturatiecatalogus of provider is niet geconfigureerd of tijdelijk niet beschikbaar
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/portal-sessions
Een sessie voor het strippen van klantenportal maken
Aanmeldingscontrole: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
Idempotency-Key · header · vereist
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Antwoorden
201 Klantenportaal Sessie strippen
201-respons · application/json
{
"$ref": "#/components/schemas/HostedSession"
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Aangemeld maar niet toegestaan, of CSRF-validatie mislukt
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Hulpbron niet gevonden of niet eigendom van de beller
404-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Een conflict tussen hulpbronnenstaat of idempotentie
409-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Een upstreamprovider is mislukt
502-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 De facturatiecatalogus of provider is niet geconfigureerd of tijdelijk niet beschikbaar
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/subscription-cancellation
Schema of ongedaan maken annulering van het huidige betaalde abonnement
Het instellen van cancelAtPeriodEnd op true schema's annulering aan het einde van de huidige factureringsperiode; false houdt het abonnement. Rechten update na een geverifieerde Stripe abonnement evenement. Dit eindpunt annuleert nooit onmiddellijk of geeft een terugbetaling.
Aanmeldingscontrole: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
Idempotency-Key · header · vereist
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Verzoek om inlichtingen · vereist
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"cancelAtPeriodEnd"
],
"properties": {
"cancelAtPeriodEnd": {
"type": "boolean"
}
}
}Antwoorden
202 Annuleringsupdate ingediend bij Stripe
202-respons · application/json
SubscriptionCancellationChange
{
"$ref": "#/components/schemas/SubscriptionCancellationChange"
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Aangemeld maar niet toegestaan, of CSRF-validatie mislukt
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Hulpbron niet gevonden of niet eigendom van de beller
404-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Een conflict tussen hulpbronnenstaat of idempotentie
409-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Verzoekvalidering mislukt
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Een upstreamprovider is mislukt
502-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 De facturatiecatalogus of provider is niet geconfigureerd of tijdelijk niet beschikbaar
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/billing/invoices
Lijst van stripfactureringsprognoses
Aanmeldingscontrole: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
cursor · query · facultatief
Schema
{
"type": "string",
"maxLength": 512
}limit · query · facultatief
Schema
{
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}Antwoorden
200 Facturen
401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/billing/payments
Lijst met account-geocopeerde up-up en terugbetaling van betaling projecties
Aanmeldingscontrole: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
cursor · query · facultatief
Schema
{
"type": "string",
"maxLength": 512
}limit · query · facultatief
Schema
{
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}Antwoorden
200 Eenmalige betaling geschiedenis zonder provider geheimen
200-respons · application/json
{
"$ref": "#/components/schemas/BillingPaymentPage"
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Credits
GET/api-access/balance
Lees de balans van de live-account met behulp van een API sleutel
Lees het huidige kredietsaldo dat door alle API sleutels in uw account wordt gedeeld. Actieve reserveringen kunnen het beschikbare saldo verminderen. Dit verzoek kost geen credits en neemt geen query parameters of instantie. Reacties zijn privé en worden niet gecached; rekening-lezen tarieflimieten zijn van toepassing.
Aanmeldingscontrole: dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Antwoorden
200 Getekend saldo en niet-negatief beschikbare kredieten
200-respons · application/json
{
"$ref": "#/components/schemas/ApiAccessBalance"
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Verzoekvalidering mislukt
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Te veel account leest; opnieuw proberen na het rate-limit venster
503 Een vereiste afhankelijkheid of catalogus is tijdelijk niet beschikbaar
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-access/pricing
Lees de werkelijke rekeningprijzen voor bronnen die zijn toegestaan door de API-sleutel
Lees uw account tarieven voor bronnen toegestaan door de API sleutel. Een null-prijs betekent dat de bron niet beschikbaar is. request_count telt vragen, niet geretourneerde items; downloadtarieven zijn per TB (10^12 bytes). Schattingen reserveren geen kredieten of capaciteit. Dit verzoek kost geen credits. Reacties zijn privé en worden niet gecached; rekening-lezen tarieflimieten zijn van toepassing.
Aanmeldingscontrole: dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
source · query · facultatief
Een bron die aan deze sleutel wordt toegekend; weglaten om alle toegekende bronnen te lezen.
Schema
{
"$ref": "#/components/schemas/ApiAccessSource"
}request_count · query · facultatief
Decimaal integer aantal oproepen; schat de downloadgrootte niet.
Schema
{
"type": "integer",
"minimum": 1,
"maximum": 100000,
"default": 1
}Antwoorden
200 Rekeningplan en bronspecifieke prijzen
200-respons · application/json
{
"$ref": "#/components/schemas/ApiAccessPricing"
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Aangemeld maar niet toegestaan, of CSRF-validatie mislukt
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Verzoekvalidering mislukt
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Te veel account leest; opnieuw proberen na het rate-limit venster
503 Een vereiste afhankelijkheid of catalogus is tijdelijk niet beschikbaar
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-access/limits
Lees accountplanlimieten en lopende taken met een API-sleutel
Lees uw concurrency, batch-size en hangende-job limieten, plus de huidige lopende telling. Deze waarden helpen bij het plannen van verzoeken, maar reserveren geen capaciteit. Dit verzoek kost geen credits en neemt geen query parameters of instantie. Reacties zijn privé en worden niet gecached; rekening-lezen tarieflimieten zijn van toepassing.
Aanmeldingscontrole: dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Antwoorden
200 Planplafonds en lopende telling
200-respons · application/json
{
"$ref": "#/components/schemas/ApiAccessLimits"
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Verzoekvalidering mislukt
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Te veel account leest; opnieuw proberen na het rate-limit venster
503 Een vereiste afhankelijkheid of catalogus is tijdelijk niet beschikbaar
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/usage
Gebruik van accounts voor bronnen die zijn toegestaan door de API-sleutel lezen
Gratis gelezen, alleen geauthentiseerd door X-API-Key. Bevat alle rekeningsleutels, maar alleen bronnen die aan de belsleutel zijn toegekend. Geeft geen zoektekst, sleutels, betalingsgegevens of andere rekeningen. Standaardwaarden tot zeven dagen; maximaal 31 dagen. Data moeten UTC Z-tijdstempels gebruiken. Van is inclusief en tot exclusief; Beide zijn afgerond naar beneden tot minuten. Met van alleen, naar standaard naar + 7 dagen. Met geen van beide, is het begin van de volgende minuut. De totalen zijn uiteindelijk consistent; zelfs bijwerken=false garandeert niet dat alle recente gebeurtenissen worden ingenomen. Leeslimiet: 60-verzoeken per minuut per client IP.
Aanmeldingscontrole: dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
source · query · facultatief
Een exacte catalogusbron toegekend aan de aanroepsleutel; weggelaten betekent alle toegekende bronnen.
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 · facultatief
Schema
{
"type": "string",
"format": "date-time"
}to · query · facultatief
Schema
{
"type": "string",
"format": "date-time"
}Antwoorden
200 Omvang van de aanvragen en in rekening gebracht Credits, met versheid informatie
200-respons · application/json
{
"$ref": "#/components/schemas/ApiKeyUsage"
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Aangemeld maar niet toegestaan, of CSRF-validatie mislukt
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Verzoekvalidering mislukt
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Te veel gebruik leest; opnieuw proberen na het rate-limit venster
503 Een vereiste afhankelijkheid of catalogus is tijdelijk niet beschikbaar
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/credits/balance
Lees huidige beschikbare en gereserveerde kredieten
Aanmeldingscontrole: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Antwoorden
200 Kredietsaldo
200-respons · application/json
{
"$ref": "#/components/schemas/CreditBalance"
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/credits/policy
Lees het effectieve kredietsubsidie- en tariferingsbeleid van de rekening
Aanmeldingscontrole: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Antwoorden
200 Effectief kredietbeleid
200-respons · application/json
{
"$ref": "#/components/schemas/CreditPolicy"
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/credits/transactions
Lijst van kredietboekvermeldingen
Aanmeldingscontrole: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
cursor · query · facultatief
Schema
{
"type": "string",
"maxLength": 512
}limit · query · facultatief
Schema
{
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}type · query · facultatief
Schema
{
"$ref": "#/components/schemas/CreditEntryType"
}Antwoorden
200 Ledger-items
200-respons · application/json
{
"allOf": [
{
"$ref": "#/components/schemas/Page"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditTransaction"
}
}
}
}
]
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Proefkrediet
GET/trial-credit-request
Lees het in aanmerking komen voor studiepunten en het levenslange verzoek van de rekening
Aanmeldingscontrole: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Antwoorden
200 Huidige subsidiabiliteit, geconfigureerde subsidie en aanvraagstatus
Berichtkoppen: Cache-Control
200-respons · application/json
{
"$ref": "#/components/schemas/TrialCreditState"
}401 Authenticatie vereist of ongeldig
Berichtkoppen: Cache-Control, X-Request-Id
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Er is een onverwachte interne fout opgetreden
Berichtkoppen: Cache-Control, X-Request-Id
500-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Een vereiste afhankelijkheid of onboarding record is tijdelijk niet beschikbaar
Berichtkoppen: Cache-Control, X-Request-Id
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/trial-credit-request
Stuur de account's een levenslange Trial Credit verzoek
De proefhoeveelheid en de use case worden opgeslagen wanneer u het verzoek indient.
Aanmeldingscontrole: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
Idempotency-Key · header · vereist
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Verzoek om inlichtingen · facultatief
Schema · application/json
{
"type": "object",
"additionalProperties": false
}Antwoorden
201 Trial Credit verzoek gemaakt en automatisch goedgekeurd voor in aanmerking komende geverifieerde accounts, ongeacht e-mail provider
Berichtkoppen: Cache-Control
201-respons · application/json
{
"$ref": "#/components/schemas/TrialCreditState"
}401 Authenticatie vereist of ongeldig
Berichtkoppen: Cache-Control, X-Request-Id
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Aangemeld maar niet toegestaan, of CSRF-validatie mislukt
Berichtkoppen: Cache-Control, X-Request-Id
403-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Een conflict tussen hulpbronnenstaat of idempotentie
Berichtkoppen: Cache-Control, X-Request-Id
409-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Verzoekvalidering mislukt
Berichtkoppen: Cache-Control, X-Request-Id
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Er is een onverwachte interne fout opgetreden
Berichtkoppen: Cache-Control, X-Request-Id
500-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Een vereiste afhankelijkheid of onboarding record is tijdelijk niet beschikbaar
Berichtkoppen: Cache-Control, X-Request-Id
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Levering
GET/delivery/webhooks
Lijst opgeslagen aanroep terugroep URLs
Aanmeldingscontrole: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Antwoorden
200 URLs terugbellen
200-respons · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeliveryWebhook"
}
}
}
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/delivery/webhooks
Een aanroep naar URL opslaan
Aanmeldingscontrole: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Verzoek om inlichtingen · vereist
Schema · application/json
{
"$ref": "#/components/schemas/CreateDeliveryWebhookRequest"
}Antwoorden
201 Aangemaakt
201-respons · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"webhook"
],
"properties": {
"webhook": {
"$ref": "#/components/schemas/DeliveryWebhook"
}
}
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Verzoekvalidering mislukt
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/delivery/webhooks/{webhookId}
Een aanroep naar URL verwijderen
Aanmeldingscontrole: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
webhookId · path · vereist
Schema
{
"type": "string",
"pattern": "^cbk_[A-Za-z0-9_-]{8,}$"
}Antwoorden
204 Verwijderd
401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Hulpbron niet gevonden of niet eigendom van de beller
404-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/delivery/webhooks/{webhookId}/test
Stuur een monster download-complete lading
Aanmeldingscontrole: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
webhookId · path · vereist
Schema
{
"type": "string",
"pattern": "^cbk_[A-Za-z0-9_-]{8,}$"
}Antwoorden
200 Testpoging
200-respons · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"statusCode",
"webhook"
],
"properties": {
"statusCode": {
"type": "integer",
"minimum": 0
},
"webhook": {
"$ref": "#/components/schemas/DeliveryWebhook"
}
}
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Hulpbron niet gevonden of niet eigendom van de beller
404-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Taken
Zie voor voorbeelden van indiening, status en resultaat Realtime en async · Batch verzoeken.
GET/jobs
Lijst met data-API-taken voor de huidige werkruimte
Cursor-pagina actieve en gearchiveerde geschiedenis. Standaardwaarden voor de laatste zeven dagen; elk UTC-datumbereik is beperkt tot 31 dagen. Van is inclusief en tot exclusief, op minuut precisie. Samenvattingen worden asynchroon onderhouden en kunnen de inname vertragen.
Aanmeldingscontrole: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
cursor · query · facultatief
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 512
}limit · query · facultatief
Schema
{
"type": "integer",
"minimum": 1,
"maximum": 50
}source · query · facultatief
Schema
{
"type": "string",
"pattern": "^(google|youtube|google_[a-z]+|youtube_[a-z_]+)$"
}status · query · facultatief
Schema
{
"type": "string",
"enum": [
"completed",
"failed",
"pending",
"processing"
]
}mode · query · facultatief
Schema
{
"type": "string",
"enum": [
"async",
"batch",
"realtime"
]
}from · query · facultatief
Schema
{
"type": "string",
"format": "date-time"
}to · query · facultatief
Schema
{
"type": "string",
"format": "date-time"
}Antwoorden
200 Jobpagina
200-respons · 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 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Verzoekvalidering mislukt
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/jobs/{jobId}
Lees één Data API-taak
Lees job.status om voortgang te controleren en job.error als verwerking mislukt is. JSON is de standaard; gebruik Accept: text/plain voor leesbare tekst. X-Respond-With wordt hier genegeerd. Volg Retry-After als deze wordt geleverd voordat u opnieuw controleert.
Aanmeldingscontrole: cookieSession of dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
Accept · header · facultatief
application/json geeft de oorspronkelijke gestructureerde respons terug; text/plain geeft dezelfde velden terug als inspringde platte tekst. Standaard mediabereiken en q-gewichten worden ondersteund; ontbrekende Accept of een wereldwijde wildcard standaard voor JSON. X-Respond-With wordt genegeerd bij indiening en functiestatus eindpunten. Fouten blijven gestructureerd JSON. Beide responstypes gebruiken UTF-8; een expliciete tekenset=utf-8 parameter wordt ondersteund.
Schema
{
"type": "string"
}jobId · path · vereist
Schema
{
"type": "string",
"pattern": "^job_[A-Za-z0-9_-]+$"
}Antwoorden
200 Werkwijze
200-respons · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"job"
],
"properties": {
"job": {
"$ref": "#/components/schemas/ConsoleJob"
}
}
}200-respons · text/plain
{
"type": "string"
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Hulpbron niet gevonden of niet eigendom van de beller
404-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}406 application/json noch text/plain is aanvaardbaar; respons is JSON
406-respons · application/json
{
"$ref": "#/components/schemas/QueryRepresentationError"
}GET/jobs/{jobId}/results
Download een voltooid async resultaat
Authenticeert standaard toegang en omleidingen naar een kortlevende privé R2 URL; clients ontvangen de originele JSON rechtstreeks van R2. Accept: text/plain geeft zelfstandig HTTP 200 terug met de originele resultaatvelden als inspringde platte tekst. X-Respond-With: markdown selecteert Markdown inhoud: application/json wikkelt het in inhoud naast de oorspronkelijke metadata, ter vervanging van resultaten; text/plain geeft metadata terug gevolgd door Markdown. Ontbrekende Accept of een globale wildcard standaard JSON. Formatteren dient geen andere query of kosten query credits in. Opgeslagen resultaten verlopen 24 uren na voltooiing. Fouten blijven gestructureerd JSON.
Aanmeldingscontrole: cookieSession of dataApiKey
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
X-Respond-With · header · facultatief
Zet op markdown om resultaatinhoud terug te geven als Markdown. Bevrijd de originele resultaatvelden. Accept kiest zelfstandig JSON of platte tekst. Alleen real-time queries en afgeronde taak resultaat leest deze header ondersteunen. Het verandert geen vacature-inzendingen, status, account API's, callbacks, Bulk-bestanden, binaire downloads, of MCP protocol antwoorden.
Schema
{
"type": "string",
"enum": [
"markdown"
]
}Accept · header · facultatief
Selecteer application/json of text/plain onafhankelijk van X-Respond-With. Zonder X-Respond-With geeft text/plain de originele velden terug met inspringing; JSON behoudt de oorspronkelijke responsvelden (voltooid resultaat leest redirect naar opslag). Met markdown, JSON geeft inhoud plus metadata terug en platte tekst geeft metadata terug gevolgd door Markdown. Standaard mediabereiken en q-gewichten worden ondersteund; ontbrekende Accept of een wereldwijde wildcard standaard voor JSON. Beide responstypes gebruiken UTF-8; een expliciete tekenset=utf-8 parameter wordt ondersteund.
Schema
{
"type": "string"
}jobId · path · vereist
Schema
{
"type": "string",
"pattern": "^job_[A-Za-z0-9_-]+$"
}Antwoorden
200 Originele velden in platte tekst of Markdown zijn direct teruggestuurd; originele JSON van R2 na het volgen van de standaardredirect
200-respons · application/json
{
"anyOf": [
{
"$ref": "#/components/schemas/MarkdownQueryResult"
},
{
"type": "object",
"additionalProperties": true
}
]
}200-respons · text/plain
{
"type": "string"
}302 Redirect naar originele JSON in privé R2-opslag wanneer JSON is geselecteerd zonder X-Respond-With
Berichtkoppen: Location
400 Niet-ondersteunde X-Respond-With-waarde; antwoord is JSON
400-respons · application/json
{
"$ref": "#/components/schemas/QueryRepresentationError"
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Hulpbron niet gevonden of niet eigendom van de beller
404-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}406 application/json noch text/plain is aanvaardbaar; respons is JSON
406-respons · application/json
{
"$ref": "#/components/schemas/QueryRepresentationError"
}409 Een conflict tussen hulpbronnenstaat of idempotentie
409-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Resultaat verlopen
410-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 De taak is mislukt. Als de reden is opgeslagen, staat die in het veld detail van de respons.
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Een vereiste afhankelijkheid of catalogus is tijdelijk niet beschikbaar
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}API voor Bulk-verwerking
Bulk eindpunten hebben een specifieke referentie met parameters, verzoek voorbeelden en responsschema's. Open Bulk verwerking API
GET /v2/bulk-jobs· Lijst bulk YouTube jobsPOST /v2/bulk-jobs· Maak een Bulk-taak aan en ontvang een bestand upload URLGET /v2/bulk-jobs/{bulkId}· Lees bulk baan vooruitgang en geaggregeerde tellingenPATCH /v2/bulk-jobs/{bulkId}· Instellingen voor niet gestarte video's wijzigenDELETE /v2/bulk-jobs/{bulkId}· Een Bulk-taak annulerenPOST /v2/bulk-jobs/{bulkId}/start· Start het scannen van een geüpload YouTube ID-bestandPOST /v2/bulk-jobs/{bulkId}/pause· Een Bulk-taak pauzerenPOST /v2/bulk-jobs/{bulkId}/resume· Een handmatige of automatisch gepauzeerde bulktaak hervattenGET /v2/bulk-jobs/{bulkId}/results· Download het voltooide bulk manifestGET /v2/bulk-jobs/{bulkId}/results/{partNumber}· Download een gzip-gecomprimeerde NDJSON bulk resultaat deel
Playground
POST/playground/run
Een speeltuinopdracht uitvoeren als de huidige werkruimte
Aanmeldingscontrole: cookieSession + csrfToken
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Verzoek om inlichtingen · vereist
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
}
}
}Antwoorden
200 Upstream Data API response gevangen voor de speeltuin
200-respons · 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 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Verzoekvalidering mislukt
422-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/playground/jobs/{jobId}/download
Een voltooid speelobject downloaden in de huidige browser
Aanmeldingscontrole: cookieSession
Server: https://api.flashdata.dev/v2
Server: http://localhost:5000/v2
Parameters
jobId · path · vereist
Schema
{
"type": "string",
"pattern": "^job_[A-Za-z0-9_-]+$"
}Antwoorden
200 Tijdelijke browser-download artefact
Berichtkoppen: Content-Disposition, Content-Length
200-respons · application/octet-stream
{
"type": "string",
"format": "binary"
}401 Authenticatie vereist of ongeldig
401-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Hulpbron niet gevonden of niet eigendom van de beller
404-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Een conflict tussen hulpbronnenstaat of idempotentie
409-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Het tijdelijke artefact is verlopen
410-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Een vereiste afhankelijkheid of catalogus is tijdelijk niet beschikbaar
503-respons · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Schemadefinities
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."
}
}
}