Salta al contenuto
IT
Ottieni la chiave API
Sfoglia la documentazione

Riferimento API

Gestione di riferimento API

Sfoglia gli endpoint per account, chiavi, fatturazione e lavori. Ogni endpoint elenca i propri requisiti di autenticazione e accesso.

Leggi il tuo account con una chiave API

La base di gestione API URL è https://api.flashdata.dev/v2. Questa lettura gratuita restituisce la chiave corrente e l'account IDs e la proprietà. Impostare FLASHDATA_API_KEY prima di eseguire il comando.

Controllare la chiave corrente · Bash
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'

Aspettatevi HTTP 200 sul successo. Controllare la linea di autenticazione di ciascun punto finale: dataApiKey utilizza X-API-Key; cookieSession utilizza una sessione di browser firmata. Schema di risposta dell'identità

Scarica la specifica del cliente OpenAPI. Esso copre query, lavori, conti, chiavi API e fatturazione.

I parametri di query e il codice di richiesta sono documentati nel Google e YouTube Riferimenti API.

Programmi di autenticazione

SchemeRequisito
dataApiKey

X-API-Key · header

FlashData API chiave. L'accesso al lavoro è limitato agli ambiti di origine della chiave.

cookieSession

__Host-fd_session · cookie

Opaque Web session. Il browser non può leggere questo cookie.

csrfToken

X-CSRF-Token · header

apiKey

agentRegistrationProof

Persistere una prova crittograficamente casuale 32-byte 64url e la richiesta esatta BEFORE invio; recuperare solo con la stessa prova e corpo. Non un token OAuth.

agentSetupCredential

Le credenziali di configurazione temporanea per lo stato e la creazione di rivendicazione solo. Non una chiave di dati API.

agentHandoffProof

Prova utilizzata per recuperare la chiave del proprietario e riconoscere l'installazione. Mai inviato a una richiesta di dati.

agentIdentityKey

Ordinario FlashData API chiave nel cuscinetto di autorizzazione, solo sull'identità dell'agente. Le query dei dati usano X-API-Key invece.

Sistema

GET/health

Salute del servizio

Autenticazione: Pubblico

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Risposte

200 Salute

Risposta 200 · application/json

Health

Risposta 200
{
  "$ref": "#/components/schemas/Health"
}
GET/status

Leggi il riepilogo dello stato dei componenti pubblici

Autenticazione: Pubblico

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Risposte

200 Sintesi dello stato pubblico

Intestazioni: Cache-Control

Risposta 200 · application/json

PublicStatus

Risposta 200
{
  "$ref": "#/components/schemas/PublicStatus"
}

Auth

GET/oauth/requests/{requestId}

Leggere una richiesta di autorizzazione dell'app e legarlo alla sessione corrente

Sessione completa richiesta. La richiesta scade dopo dieci minuti. La risposta non è un negozio.

Autenticazione: cookieSession

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

requestId · path · richiesto

Schema
Schema
{
  "type": "string",
  "pattern": "^fdo_[A-Za-z0-9_-]{43}$"
}

Risposte

200 Autorizzazioni richieste dell'app

Risposta 200 · application/json

OAuthConsent

Risposta 200
{
  "$ref": "#/components/schemas/OAuthConsent"
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Autentico ma non consentito, o la convalida CSRF non è riuscita

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

410 Richiesta scaduta, utilizzata o legata ad un'altra sessione

Risposta 410 · application/problem+json

Problem

Risposta 410
{
  "$ref": "#/components/schemas/Problem"
}
POST/oauth/requests/{requestId}

Approva o nega una richiesta di autorizzazione dell'app

Sessione completa, CSRF e permesso Origine richiesta. Consuma la richiesta una volta. La risposta non è un negozio.

Autenticazione: cookieSession + csrfToken

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

requestId · path · richiesto

Schema
Schema
{
  "type": "string",
  "pattern": "^fdo_[A-Za-z0-9_-]{43}$"
}

Richiesta corpo · richiesto

Schema · application/json
Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "decision"
  ],
  "properties": {
    "decision": {
      "type": "string",
      "enum": [
        "approve",
        "deny"
      ]
    }
  }
}

Risposte

200 Callback client registrato con codice o negazione, stato ed emittente

Risposta 200 · application/json
Risposta 200
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "redirectUrl"
  ],
  "properties": {
    "redirectUrl": {
      "type": "string",
      "format": "uri"
    }
  }
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Autentico ma non consentito, o la convalida CSRF non è riuscita

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

410 Richiesta di autorizzazione non disponibile; avviare una nuova connessione

Risposta 410 · application/problem+json

Problem

Risposta 410
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta di validazione non riuscita

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}
POST/auth/register

Creare un account FlashData in attesa

Le versioni dei Termini e della Privacy devono corrispondere al pacchetto legale pubblicato in corso.

Autenticazione: Pubblico

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Richiesta corpo · richiesto

Schema · application/json

RegisterRequest

Schema
{
  "$ref": "#/components/schemas/RegisterRequest"
}

Risposte

201 Account creato; richiesta di verifica e-mail

Intestazioni: Cache-Control, X-Request-Id

Risposta 201 · application/json

RegisterResponse

Risposta 201
{
  "$ref": "#/components/schemas/RegisterResponse"
}

409 Stato di risorse o conflitto di idempotency

Risposta 409 · application/problem+json

Problem

Risposta 409
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta di validazione non riuscita

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

429 Tasso, convalutazione, lotto, o limite di lavoro in sospeso superato

Intestazioni: Retry-After

Risposta 429 · application/problem+json

Problem

Risposta 429
{
  "$ref": "#/components/schemas/Problem"
}

500 Si è verificato un errore interno inaspettato

Risposta 500 · application/problem+json

Problem

Risposta 500
{
  "$ref": "#/components/schemas/Problem"
}

503 Una dipendenza o un catalogo richiesti è temporaneamente non disponibile

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/auth/login

Creare una sessione Web opaca

Imposta il cookie Secure, HttpOnly `__Host-fd_session`. Conti di pagamento ricevere una sessione email_verification limitata per il cruscotto di verifica. I conti verificati ammissibili ricevono i loro crediti di prova una volta al login se non già concessi. Un account attivo riceve una sessione completa a meno che la sua identità migrata non richieda ancora una accettazione legale corrente, in tal caso riceve una limitazione Sessione legal_acceptance. Un account con una richiesta di cancellazione programmata riceve una sessione deletion_recovery limitata. Conti la cui cancellazione è processing/failed/completed, e conti sospesi, ricevere 403.

Autenticazione: Pubblico

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Richiesta corpo · richiesto

Schema · application/json

LoginRequest

Schema
{
  "$ref": "#/components/schemas/LoginRequest"
}

Risposte

200 Autentico

Intestazioni: Set-Cookie, Cache-Control, X-Request-Id

Risposta 200 · application/json

LoginResponse

Risposta 200
{
  "$ref": "#/components/schemas/LoginResponse"
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Il login è vietato; Problem.code è email_not_verified, account_suspended, account_deletion_processing, account_deletion_failed, o account_deleted

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta di validazione non riuscita

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

423 Conto temporaneamente chiuso

Intestazioni: Retry-After

Risposta 423 · application/problem+json

Problem

Risposta 423
{
  "$ref": "#/components/schemas/Problem"
}

429 Tasso, convalutazione, lotto, o limite di lavoro in sospeso superato

Intestazioni: Retry-After

Risposta 429 · application/problem+json

Problem

Risposta 429
{
  "$ref": "#/components/schemas/Problem"
}
POST/auth/logout

Rivolgi la sessione corrente

Autenticazione: cookieSession + csrfToken

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Risposte

204 Sessione revocata e cancellata dai cookie

Intestazioni: Set-Cookie, Cache-Control, X-Request-Id

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Autentico ma non consentito, o la convalida CSRF non è riuscita

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}
GET/auth/me

Leggi l'account corrente e l'utente

Autenticazione: cookieSession

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Risposte

200 Conto corrente

Intestazioni: Cache-Control, X-Request-Id

Risposta 200 · application/json

Account

Risposta 200
{
  "$ref": "#/components/schemas/Account"
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}
GET/auth/csrf

Ottieni il token CSRF legato alla sessione corrente

Autenticazione: cookieSession

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Risposte

200 Token CSRF

Intestazioni: Cache-Control, X-Request-Id

Risposta 200 · application/json
Risposta 200
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "csrfToken"
  ],
  "properties": {
    "csrfToken": {
      "type": "string",
      "minLength": 32,
      "readOnly": true
    }
  }
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}
POST/auth/email-verifications

Richiedi o rivendi un messaggio di verifica e-mail

Per ogni e-mail sintatticamente valida, restituisce la stessa risposta indipendentemente dal fatto che l'account manca, in attesa, attivo, sospeso o cancellato. I conti in sospeso ammissibili ricevono un link di una volta ruotato dopo il raffreddore di rinvenimento.

Autenticazione: Pubblico

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Richiesta corpo · richiesto

Schema · application/json
Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "email"
  ],
  "properties": {
    "email": {
      "type": "string",
      "format": "email",
      "maxLength": 320
    }
  }
}

Risposte

202 Richiesta accettata. La risposta non rivela se esiste un account.

Intestazioni: Cache-Control, X-Request-Id

Risposta 202 · application/json
Risposta 202
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "accepted"
  ],
  "properties": {
    "accepted": {
      "type": "boolean",
      "const": true
    }
  }
}

422 Richiesta di autenticazione anonima non riuscita

Intestazioni: Cache-Control, X-Request-Id

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

429 Limite di autenticazione anonimo superato

Intestazioni: Cache-Control, Retry-After, X-Request-Id

Risposta 429 · application/problem+json

Problem

Risposta 429
{
  "$ref": "#/components/schemas/Problem"
}

500 Si è verificato un errore di autenticazione anonimo inaspettato

Intestazioni: Cache-Control, X-Request-Id

Risposta 500 · application/problem+json

Problem

Risposta 500
{
  "$ref": "#/components/schemas/Problem"
}

503 Una dipendenza da autenticazione anonima è temporaneamente non disponibile

Intestazioni: Cache-Control, X-Request-Id

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/auth/email-verifications/confirm

Verificare un'email e attivare l'account

Atomicamente consuma il token una volta e attiva il Account e l'Utente. Si applicano le attuali regole di conto e di credito di prova. Senza registrazione Sessione l'utente accede esplicitamente. Una richiesta di accesso consentita che trasporta la sessione di registrazione corrispondente e la sua X-CSRF-Token possono ricevere un cookie di sessione ruotato per lo stesso account verificato; un token di verifica da solo non firma mai in un utente.

Autenticazione: Pubblico

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Richiesta corpo · richiesto

Schema · application/json

TokenRequest

Schema
{
  "$ref": "#/components/schemas/TokenRequest"
}

Risposte

200 Account attivato

Intestazioni: Set-Cookie, Cache-Control, X-Request-Id

Risposta 200 · application/json

Account

Risposta 200
{
  "allOf": [
    {
      "$ref": "#/components/schemas/Account"
    },
    {
      "type": "object",
      "properties": {
        "status": {
          "const": "active"
        },
        "emailVerified": {
          "const": true
        }
      }
    }
  ]
}

410 Il gettone di una volta è invalido, scaduto, invalidato, già usato, o perso una gara di conferma concomitante. Problem.code è `token_unavailable`.

Intestazioni: Cache-Control, X-Request-Id

Risposta 410 · application/problem+json

Problem

Risposta 410
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta di autenticazione anonima non riuscita

Intestazioni: Cache-Control, X-Request-Id

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

429 Limite di autenticazione anonimo superato

Intestazioni: Cache-Control, Retry-After, X-Request-Id

Risposta 429 · application/problem+json

Problem

Risposta 429
{
  "$ref": "#/components/schemas/Problem"
}

500 Si è verificato un errore di autenticazione anonimo inaspettato

Intestazioni: Cache-Control, X-Request-Id

Risposta 500 · application/problem+json

Problem

Risposta 500
{
  "$ref": "#/components/schemas/Problem"
}

503 Una dipendenza da autenticazione anonima è temporaneamente non disponibile

Intestazioni: Cache-Control, X-Request-Id

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/auth/email-verifications/session

Continuare la sessione di registrazione originale dopo la verifica e-mail

Richiede un permesso di origine e il token CSRF legato ad una sessione di email-verificazione autenticata con password dal vivo. I ritorni in sospeso fino a quando il proprio account di tale sessione è verificato, inclusa la verifica in un altro browser. Atomicamente revoca la sessione di registrazione e rilascia una sessione di accettazione completa o legale. Non accetta un account ID, e-mail, password o token di verifica, bypassare l'accettazione legale, o concedere crediti.

Autenticazione: cookieSession + csrfToken

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Richiesta corpo · richiesto

Schema · application/json
Schema
{
  "type": "object",
  "additionalProperties": false
}

Risposte

200 Sessione di registrazione ruotata

Intestazioni: Set-Cookie, Cache-Control

Risposta 200 · application/json

LoginResponse

Risposta 200
{
  "$ref": "#/components/schemas/LoginResponse"
}

202 La verifica e-mail è in attesa; nessuna nuova sessione

Intestazioni: Cache-Control

Risposta 202 · application/json
Risposta 202
{
  "type": "object",
  "required": [
    "pending"
  ],
  "additionalProperties": false,
  "properties": {
    "pending": {
      "type": "boolean",
      "const": true
    }
  }
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Autentico ma non consentito, o la convalida CSRF non è riuscita

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta di validazione non riuscita

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

500 Si è verificato un errore interno inaspettato

Risposta 500 · application/problem+json

Problem

Risposta 500
{
  "$ref": "#/components/schemas/Problem"
}
POST/auth/password-resets

Richiedi un'email di reset password

restituisce sempre la stessa risposta 202 per una e-mail sintatticamente valida indipendentemente dall'esistenza dell'account o dallo stato del ciclo di vita. Solo le identità attive o bloccate ammissibili ricevono la posta.

Autenticazione: Pubblico

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Richiesta corpo · richiesto

Schema · application/json
Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "email"
  ],
  "properties": {
    "email": {
      "type": "string",
      "format": "email",
      "maxLength": 320
    }
  }
}

Risposte

202 Richiesta accettata. La risposta non rivela se esiste un account.

Intestazioni: Cache-Control, X-Request-Id

Risposta 202 · application/json
Risposta 202
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "accepted"
  ],
  "properties": {
    "accepted": {
      "type": "boolean",
      "const": true
    }
  }
}

422 Richiesta di autenticazione anonima non riuscita

Intestazioni: Cache-Control, X-Request-Id

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

429 Limite di autenticazione anonimo superato

Intestazioni: Cache-Control, Retry-After, X-Request-Id

Risposta 429 · application/problem+json

Problem

Risposta 429
{
  "$ref": "#/components/schemas/Problem"
}

500 Si è verificato un errore di autenticazione anonimo inaspettato

Intestazioni: Cache-Control, X-Request-Id

Risposta 500 · application/problem+json

Problem

Risposta 500
{
  "$ref": "#/components/schemas/Problem"
}

503 Una dipendenza da autenticazione anonima è temporaneamente non disponibile

Intestazioni: Cache-Control, X-Request-Id

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/auth/password-resets/confirm

Impostare una nuova password e revocare le sessioni esistenti

Atomicamente consuma il token di risistemazione password, memorizza una nuova credenziali Argon2id, revoca ogni sessione esistente e invalida altri token di risistemazione password. Non registra l'utente o crea una sessione.

Autenticazione: Pubblico

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Richiesta corpo · richiesto

Schema · application/json

Password

Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "token",
    "password"
  ],
  "properties": {
    "token": {
      "type": "string",
      "minLength": 32,
      "maxLength": 256,
      "writeOnly": true
    },
    "password": {
      "$ref": "#/components/schemas/Password"
    }
  }
}

Risposte

204 Aggiornata la password; le sessioni esistenti revocate

Intestazioni: Cache-Control, X-Request-Id

410 Il gettone di una volta è invalido, scaduto, invalidato, già usato, o perso una gara di conferma concomitante. Problem.code è `token_unavailable`.

Intestazioni: Cache-Control, X-Request-Id

Risposta 410 · application/problem+json

Problem

Risposta 410
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta di autenticazione anonima non riuscita

Intestazioni: Cache-Control, X-Request-Id

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

429 Limite di autenticazione anonimo superato

Intestazioni: Cache-Control, Retry-After, X-Request-Id

Risposta 429 · application/problem+json

Problem

Risposta 429
{
  "$ref": "#/components/schemas/Problem"
}

500 Si è verificato un errore di autenticazione anonimo inaspettato

Intestazioni: Cache-Control, X-Request-Id

Risposta 500 · application/problem+json

Problem

Risposta 500
{
  "$ref": "#/components/schemas/Problem"
}

503 Una dipendenza da autenticazione anonima è temporaneamente non disponibile

Intestazioni: Cache-Control, X-Request-Id

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
GET/auth/sessions

Elenca le sessioni attive per l'utente corrente

Autenticazione: cookieSession

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Risposte

200 Sessioni

Intestazioni: Cache-Control, X-Request-Id

Risposta 200 · application/json

Session

Risposta 200
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Session"
      }
    }
  }
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}
DELETE/auth/sessions

Rivolgere tutte le sessioni tranne quella attuale

Autenticazione: cookieSession + csrfToken

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Risposte

204 Altre sessioni revocate

Intestazioni: Cache-Control, X-Request-Id

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Autentico ma non consentito, o la convalida CSRF non è riuscita

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}
DELETE/auth/sessions/{sessionId}

Rivolgere una sessione

Autenticazione: cookieSession + csrfToken

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

sessionId · path · richiesto

Schema
Schema
{
  "type": "string",
  "pattern": "^ses_"
}

Risposte

204 Sessione revocata. Se è stata la Sessione corrente, il cookie è stato cancellato.

Intestazioni: Set-Cookie, Cache-Control, X-Request-Id

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Autentico ma non consentito, o la convalida CSRF non è riuscita

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

404 Risorse non trovate o non possedute dal chiamante

Risposta 404 · application/problem+json

Problem

Risposta 404
{
  "$ref": "#/components/schemas/Problem"
}

409 Stato di risorse o conflitto di idempotency

Risposta 409 · application/problem+json

Problem

Risposta 409
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta di validazione non riuscita

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

503 Una dipendenza o un catalogo richiesti è temporaneamente non disponibile

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/auth/re-authenticate

Verificare la password corrente per un'operazione sensibile

Registra una prova di breve durata sul lato server attuale.

Autenticazione: cookieSession + csrfToken

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Richiesta corpo · richiesto

Schema · application/json
Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "password"
  ],
  "properties": {
    "password": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "writeOnly": true
    }
  }
}

Risposte

200 Sessione ha una recente autenticazione

Intestazioni: Cache-Control, X-Request-Id

Risposta 200 · application/json

Reauthentication

Risposta 200
{
  "$ref": "#/components/schemas/Reauthentication"
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Autentico ma non consentito, o la convalida CSRF non è riuscita

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

429 Tasso, convalutazione, lotto, o limite di lavoro in sospeso superato

Intestazioni: Retry-After

Risposta 429 · application/problem+json

Problem

Risposta 429
{
  "$ref": "#/components/schemas/Problem"
}
PATCH/auth/password

Modificare la password e ruotare la sessione corrente

Autenticazione: cookieSession + csrfToken

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Richiesta corpo · richiesto

Schema · application/json

Password

Schema
{
  "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
    }
  }
}

Risposte

204 Modificata la password; la sessione corrente ruotata e altre sessioni revocate quando richiesto

Intestazioni: Set-Cookie, Cache-Control, X-Request-Id

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Autentico ma non consentito, o la convalida CSRF non è riuscita

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta di validazione non riuscita

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

Conto

GET/oauth/connections

Elenca le app connesse dell'account corrente

Sessione completa richiesta. Vuoto quando l'account non ha app collegate. La risposta non è un negozio.

Autenticazione: cookieSession

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Risposte

200 Connected apps

Risposta 200 · application/json

OAuthConnection

Risposta 200
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/OAuthConnection"
      }
    }
  }
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Autentico ma non consentito, o la convalida CSRF non è riuscita

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}
DELETE/oauth/connections/{grantId}

Rivolgere un'app collegata e la sua chiave API dedicata

Sessione completa, CSRF e permesso Origine richiesta. La proprietà dell'account è applicata. La risposta non è un negozio.

Autenticazione: cookieSession + csrfToken

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

grantId · path · richiesto

Schema
Schema
{
  "type": "string",
  "pattern": "^oag_[A-Za-z0-9_-]{8,}$"
}

Risposte

204 Autorizzazione revocata

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Autentico ma non consentito, o la convalida CSRF non è riuscita

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

404 Risorse non trovate o non possedute dal chiamante

Risposta 404 · application/problem+json

Problem

Risposta 404
{
  "$ref": "#/components/schemas/Problem"
}
GET/account

Leggi le impostazioni dell'account

Autenticazione: cookieSession

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Risposte

200 Conto

Risposta 200 · application/json

Account

Risposta 200
{
  "$ref": "#/components/schemas/Account"
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}
PATCH/account

Impostazioni del profilo di aggiornamento

Autenticazione: cookieSession + csrfToken

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Richiesta corpo · richiesto

Schema · application/json

UpdateAccountRequest

Schema
{
  "$ref": "#/components/schemas/UpdateAccountRequest"
}

Risposte

200 Account aggiornato

Risposta 200 · application/json

Account

Risposta 200
{
  "$ref": "#/components/schemas/Account"
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Autentico ma non consentito, o la convalida CSRF non è riuscita

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta di validazione non riuscita

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}
DELETE/account

Pianificare la cancellazione del conto e revocare tutte le sessioni esistenti e API Keys

Gli account amministratore devono avere il ruolo della piattaforma revocato attraverso il flusso di lavoro dell'operatore verificato prima che la cancellazione possa essere programmata. Una richiesta di cancellazione attiva unica è il confine naturale di idempotency. Gli orari autenticati concorrenti restituiscono la stessa richiesta. Dopo la revoca di Sessione, viene recuperata una risposta perduta accedendo alla modalità deletion_recovery e leggendo GET /account/deletion; le sessioni revocate non sono mai accettate per la riproduzione.

Autenticazione: cookieSession + csrfToken

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Richiesta corpo · richiesto

Schema · application/json
Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "password",
    "confirmation"
  ],
  "properties": {
    "password": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "writeOnly": true
    },
    "confirmation": {
      "type": "string",
      "const": "DELETE"
    }
  }
}

Risposte

202 Cancellazione programmata; sessioni attive e chiavi revocate

Risposta 202 · application/json

AccountDeletionRequest

Risposta 202
{
  "$ref": "#/components/schemas/AccountDeletionRequest"
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Autentico ma non consentito, o la convalida CSRF non è riuscita

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

409 Stato di risorse o conflitto di idempotency

Risposta 409 · application/problem+json

Problem

Risposta 409
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta di validazione non riuscita

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}
GET/account/deletion

Leggi la richiesta di cancellazione dell'account corrente

Autenticazione: cookieSession

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Risposte

200 Richiesta di cancellazione attuale

Risposta 200 · application/json

AccountDeletionRequest

Risposta 200
{
  "$ref": "#/components/schemas/AccountDeletionRequest"
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

404 Risorse non trovate o non possedute dal chiamante

Risposta 404 · application/problem+json

Problem

Risposta 404
{
  "$ref": "#/components/schemas/Problem"
}
DELETE/account/deletion

Cancellare una cancellazione programmata durante il periodo di grazia

Utilizza un comparatore e un set programmato-cancelled. Una gara di processore restituisce 409; dopo il successo la sessione di recupero viene ruotata e non può rifare la vecchia transizione.

Autenticazione: cookieSession + csrfToken

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Risposte

204 Cancellazione, riattivazione del conto e recupero Sessione ruotata secondo il cancello di accettazione legale

Intestazioni: Set-Cookie, Cache-Control, X-Request-Id

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Autentico ma non consentito, o la convalida CSRF non è riuscita

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

404 Risorse non trovate o non possedute dal chiamante

Risposta 404 · application/problem+json

Problem

Risposta 404
{
  "$ref": "#/components/schemas/Problem"
}

409 Stato di risorse o conflitto di idempotency

Risposta 409 · application/problem+json

Problem

Risposta 409
{
  "$ref": "#/components/schemas/Problem"
}
POST/account/legal-acceptances

Accept le versioni attualmente pubblicate di Termini e Privacy

Appende un'immutabile accettazione legale, sgombera il cancello di migrazione e ruota la sessione. Le versioni presentate da Stale sono respinte.

Autenticazione: cookieSession + csrfToken

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Richiesta corpo · richiesto

Schema · application/json

LegalAcceptanceRequest

Schema
{
  "$ref": "#/components/schemas/LegalAcceptanceRequest"
}

Risposte

200 Accensione legale registrata e Sessione ruotata in modalità completa

Intestazioni: Set-Cookie, Cache-Control, X-Request-Id

Risposta 200 · application/json

LoginResponse

Risposta 200
{
  "$ref": "#/components/schemas/LoginResponse"
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Autentico ma non consentito, o la convalida CSRF non è riuscita

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

404 Risorse non trovate o non possedute dal chiamante

Risposta 404 · application/problem+json

Problem

Risposta 404
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta di validazione non riuscita

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

A bordo

GET/onboarding

Leggere i progressi di imbarco

Autenticazione: cookieSession

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Risposte

200 Stato di bordo corrente

Intestazioni: Cache-Control, X-Request-Id

Risposta 200 · application/json

OnboardingProgress

Risposta 200
{
  "$ref": "#/components/schemas/OnboardingProgress"
}

401 Autenticazione richiesta o invalida

Intestazioni: Cache-Control, X-Request-Id

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

500 Si è verificato un errore interno inaspettato

Intestazioni: Cache-Control, X-Request-Id

Risposta 500 · application/problem+json

Problem

Risposta 500
{
  "$ref": "#/components/schemas/Problem"
}

503 Una dipendenza richiesta o un record di bordo è temporaneamente non disponibile

Intestazioni: Cache-Control, X-Request-Id

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
PATCH/onboarding

Avanzare a bordo senza permettere il progresso di muoversi all'indietro

Autenticazione: cookieSession + csrfToken

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Richiesta corpo · richiesto

Schema · application/json

UpdateOnboardingRequest

Schema
{
  "$ref": "#/components/schemas/UpdateOnboardingRequest"
}

Risposte

200 Aggiornato stato di bordo

Intestazioni: Cache-Control, X-Request-Id

Risposta 200 · application/json

OnboardingProgress

Risposta 200
{
  "$ref": "#/components/schemas/OnboardingProgress"
}

401 Autenticazione richiesta o invalida

Intestazioni: Cache-Control, X-Request-Id

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Autentico ma non consentito, o la convalida CSRF non è riuscita

Intestazioni: Cache-Control, X-Request-Id

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

409 Stato di risorse o conflitto di idempotency

Intestazioni: Cache-Control, X-Request-Id

Risposta 409 · application/problem+json

Problem

Risposta 409
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta di validazione non riuscita

Intestazioni: Cache-Control, X-Request-Id

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

500 Si è verificato un errore interno inaspettato

Intestazioni: Cache-Control, X-Request-Id

Risposta 500 · application/problem+json

Problem

Risposta 500
{
  "$ref": "#/components/schemas/Problem"
}

503 Una dipendenza richiesta o un record di bordo è temporaneamente non disponibile

Intestazioni: Cache-Control, X-Request-Id

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}

Panoramica

GET/overview

Leggi l'aggregato della dashboard dell'account

Autenticazione: cookieSession

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Risposte

200 Panoramica del conto

Intestazioni: Cache-Control, X-Request-Id

Risposta 200 · application/json

ConsoleOverview

Risposta 200
{
  "$ref": "#/components/schemas/ConsoleOverview"
}

401 Autenticazione richiesta o invalida

Intestazioni: Cache-Control, X-Request-Id

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

500 Si è verificato un errore interno inaspettato

Intestazioni: Cache-Control, X-Request-Id

Risposta 500 · application/problem+json

Problem

Risposta 500
{
  "$ref": "#/components/schemas/Problem"
}

503 Una dipendenza richiesta o un record di bordo è temporaneamente non disponibile

Intestazioni: Cache-Control, X-Request-Id

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}

API Keys

GET/api-access/identity

Verificare l'attuale proprietà chiave API e la disponibilità ricorrente

Free header-only API-chiave leggere. Restituisce account/key IDs pubblico e proprietà autorevole. Nessun corpo di richiesta. Non altera la risposta dei metadati /api-access esistente. Condivide il limite di lettura dell'account 120/minute. Fail chiuso su indisponibilità; non dedurre la proprietà da prefisso chiave, piano, o stato locale. Non sono accettati parametri di query. Le risposte non sono a magazzino.

Autenticazione: dataApiKey

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Risposte

200 Verificare l'attuale proprietà chiave API e la disponibilità ricorrente

Risposta 200 · application/json

APIKeyIdentity

Risposta 200
{
  "$ref": "#/components/schemas/APIKeyIdentity"
}

400 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 400 · application/problem+json

Problem

Risposta 400
{
  "$ref": "#/components/schemas/Problem"
}

401 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

409 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 409 · application/problem+json

Problem

Risposta 409
{
  "$ref": "#/components/schemas/Problem"
}

410 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 410 · application/problem+json

Problem

Risposta 410
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

429 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 429 · application/problem+json

Problem

Risposta 429
{
  "$ref": "#/components/schemas/Problem"
}

503 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
GET/api-keys

Elenco dei metadati chiave API

Autenticazione: cookieSession

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Risposte

200 API Keys senza segreti

Risposta 200 · application/json

ApiKey

Risposta 200
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ApiKey"
      }
    }
  }
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}
POST/api-keys

Creare una chiave API e rivelare il suo segreto una volta

Autenticazione: cookieSession + csrfToken

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

Idempotency-Key · header · richiesto

Schema
Schema
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

Richiesta corpo · richiesto

Schema · application/json

CreateApiKeyRequest

Schema
{
  "$ref": "#/components/schemas/CreateApiKeyRequest"
}

Risposte

201 Creato; lo stesso ripetizione idempotent può restituire la stessa risposta crittografata per cinque minuti

Risposta 201 · application/json

ApiKeyCreated

Risposta 201
{
  "$ref": "#/components/schemas/ApiKeyCreated"
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Autentico ma non consentito, o la convalida CSRF non è riuscita

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

409 Stato di risorse o conflitto di idempotency

Risposta 409 · application/problem+json

Problem

Risposta 409
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta di validazione non riuscita

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

503 Una dipendenza o un catalogo richiesti è temporaneamente non disponibile

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
DELETE/api-keys/{keyId}

Rivolgere una chiave API

Autenticazione: cookieSession + csrfToken

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

keyId · path · richiesto

Schema
Schema
{
  "type": "string",
  "pattern": "^key_"
}

Risposte

204 Votazioni

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Autentico ma non consentito, o la convalida CSRF non è riuscita

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

404 Risorse non trovate o non possedute dal chiamante

Risposta 404 · application/problem+json

Problem

Risposta 404
{
  "$ref": "#/components/schemas/Problem"
}

503 Una dipendenza o un catalogo richiesti è temporaneamente non disponibile

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/api-keys/{keyId}/rotate

Creare una chiave sostitutiva e programmare la revoca di vecchia chiave

Crea una nuova chiave e mantiene la vecchia chiave attiva fino a revokeOldAt. Per impostazione predefinita, la sovrapposizione dura 24 ore o fino alla scadenza della vecchia chiave, a seconda che sia precedente. Un revokeOldAt personalizzato deve essere in futuro, entro sette giorni, e non oltre la vecchia scadenza chiave.

Autenticazione: cookieSession + csrfToken

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

keyId · path · richiesto

Schema
Schema
{
  "type": "string",
  "pattern": "^key_"
}

Idempotency-Key · header · richiesto

Schema
Schema
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

Richiesta corpo · opzionale

Schema · application/json
Schema
{
  "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."
    }
  }
}

Risposte

201 Ricambio creato; segreto restituito una volta

Risposta 201 · application/json

ApiKeyCreated

Risposta 201
{
  "$ref": "#/components/schemas/ApiKeyCreated"
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Autentico ma non consentito, o la convalida CSRF non è riuscita

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

404 Risorse non trovate o non possedute dal chiamante

Risposta 404 · application/problem+json

Problem

Risposta 404
{
  "$ref": "#/components/schemas/Problem"
}

409 Stato di risorse o conflitto di idempotency

Risposta 409 · application/problem+json

Problem

Risposta 409
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta di validazione non riuscita

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

503 Una dipendenza o un catalogo richiesti è temporaneamente non disponibile

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
GET/api-access

Leggi le fonti autorizzate della chiave API e l'origine dei risultati

autenticazione X-API-Key gratuita, intestazione. Resi concesse solo al pubblico i nomi di origine e l'origine di archiviazione con riconsulto firmato configurata (null se non disponibile). Nessun account ID, chiave ID, le credenziali segrete o di archiviazione vengono restituite. MCP rivalida questo endpoint prima di ogni scoperta e chiamata degli strumenti, inclusi i risultati memorizzati nella cache. Non sono accettati parametri di richiesta o corpo di richiesta. Tutte le rotte /api-access condividono richieste 120 per minuto per IP client e ritorno Cache-Control privato, senza deposito. La chiave normale di tracciamento dell'ultimo utilizzo si verifica ancora.

Autenticazione: dataApiKey

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Risposte

200 Fonti pubbliche autorizzate e origine dei risultati

Risposta 200 · application/json

ApiAccess

Risposta 200
{
  "$ref": "#/components/schemas/ApiAccess"
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta di validazione non riuscita

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

429 Troppi account legge; riprovare dopo la finestra di tasso-limite

503 Una dipendenza o un catalogo richiesti è temporaneamente non disponibile

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}

Connessione dell'agente

GET/agent-connections/capabilities

Scopri il protocollo 2 onboarding disponibilità

Non sono accettati parametri di query. Le risposte non sono a magazzino. Le rotte dell'agente sono gestionali e funzionali; le distribuzioni possono restituire 404 quando sono disabilitate. X-API-Key è vietato sulle rotte degli agenti.

Autenticazione: Pubblico

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Risposte

200 Scopri il protocollo 2 onboarding disponibilità

Risposta 200 · application/json

AgentCapabilities

Risposta 200
{
  "$ref": "#/components/schemas/AgentCapabilities"
}

400 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 400 · application/problem+json

Problem

Risposta 400
{
  "$ref": "#/components/schemas/Problem"
}

401 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

409 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 409 · application/problem+json

Problem

Risposta 409
{
  "$ref": "#/components/schemas/Problem"
}

410 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 410 · application/problem+json

Problem

Risposta 410
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

429 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 429 · application/problem+json

Problem

Risposta 429
{
  "$ref": "#/components/schemas/Problem"
}

503 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/agent-connections/registrations

Creare o recuperare una connessione temporanea API-chiave

Persistere la prova di registrazione e l'ingresso esatto prima di POST. Stessa prova e il corpo recuperano lo stesso prova; il cambiamento di input produce conflitti. Prova temporanea: 1 Credit, 72 ore, 1 request/second, dimensione batch 1. I limiti di portata di origine rimangono autorevoli sul server. Non sono accettati parametri di query. Le risposte non sono a magazzino. Le rotte dell'agente sono gestionali e funzionali; le distribuzioni possono restituire 404 quando sono disabilitate. X-API-Key è vietato sulle rotte degli agenti.

Autenticazione: agentRegistrationProof

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Richiesta corpo · richiesto

Schema · application/json

AgentRegistrationRequest

Schema
{
  "$ref": "#/components/schemas/AgentRegistrationRequest"
}

Risposte

201 Creare o recuperare una connessione temporanea API-chiave

Risposta 201 · application/json

AgentRegistration

Risposta 201
{
  "$ref": "#/components/schemas/AgentRegistration"
}

400 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 400 · application/problem+json

Problem

Risposta 400
{
  "$ref": "#/components/schemas/Problem"
}

401 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

409 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 409 · application/problem+json

Problem

Risposta 409
{
  "$ref": "#/components/schemas/Problem"
}

410 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 410 · application/problem+json

Problem

Risposta 410
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

429 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 429 · application/problem+json

Problem

Risposta 429
{
  "$ref": "#/components/schemas/Problem"
}

503 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
GET/agent-connections/owned

Elenca le connessioni di proprietà del browser

Non sono accettati parametri di query. Le risposte non sono a magazzino. Le rotte dell'agente sono gestionali e funzionali; le distribuzioni possono restituire 404 quando sono disabilitate. X-API-Key è vietato sulle rotte degli agenti. Funzionamento di proprietà del browser. Sessione verificata completa richiesta; il chiamante non deve sostituire una chiave o una prova API.

Autenticazione: cookieSession

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Risposte

200 Elenca le connessioni di proprietà del browser

Risposta 200 · application/json

AgentConnection

Risposta 200
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "connections": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AgentConnection"
      }
    }
  },
  "required": [
    "connections"
  ]
}

400 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 400 · application/problem+json

Problem

Risposta 400
{
  "$ref": "#/components/schemas/Problem"
}

401 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

409 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 409 · application/problem+json

Problem

Risposta 409
{
  "$ref": "#/components/schemas/Problem"
}

410 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 410 · application/problem+json

Problem

Risposta 410
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

429 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 429 · application/problem+json

Problem

Risposta 429
{
  "$ref": "#/components/schemas/Problem"
}

503 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
GET/agent-connections/{connectionId}

Leggi lo stato di connessione temporanea

Non sono accettati parametri di query. Le risposte non sono a magazzino. Le rotte dell'agente sono gestionali e funzionali; le distribuzioni possono restituire 404 quando sono disabilitate. X-API-Key è vietato sulle rotte degli agenti.

Autenticazione: agentSetupCredential

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

connectionId · path · richiesto

Schema
Schema
{
  "type": "string",
  "pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}

Risposte

200 Leggi lo stato di connessione temporanea

Risposta 200 · application/json

AgentConnectionResponse

Risposta 200
{
  "$ref": "#/components/schemas/AgentConnectionResponse"
}

400 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 400 · application/problem+json

Problem

Risposta 400
{
  "$ref": "#/components/schemas/Problem"
}

401 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

409 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 409 · application/problem+json

Problem

Risposta 409
{
  "$ref": "#/components/schemas/Problem"
}

410 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 410 · application/problem+json

Problem

Risposta 410
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

429 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 429 · application/problem+json

Problem

Risposta 429
{
  "$ref": "#/components/schemas/Problem"
}

503 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
DELETE/agent-connections/{connectionId}

Rivolgere una connessione di proprietà

Non sono accettati parametri di query. Le risposte non sono a magazzino. Le rotte dell'agente sono gestionali e funzionali; le distribuzioni possono restituire 404 quando sono disabilitate. X-API-Key è vietato sulle rotte degli agenti. Funzionamento di proprietà del browser. Sessione verificata completa richiesta; il chiamante non deve sostituire una chiave o una prova API.

Autenticazione: cookieSession + csrfToken

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

connectionId · path · richiesto

Schema
Schema
{
  "type": "string",
  "pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}

Origin · header · richiesto

Schema
Schema
{
  "type": "string"
}

X-CSRF-Token · header · richiesto

Schema
Schema
{
  "type": "string"
}

Risposte

204 Rivolgere una connessione di proprietà

400 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 400 · application/problem+json

Problem

Risposta 400
{
  "$ref": "#/components/schemas/Problem"
}

401 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

409 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 409 · application/problem+json

Problem

Risposta 409
{
  "$ref": "#/components/schemas/Problem"
}

410 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 410 · application/problem+json

Problem

Risposta 410
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

429 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 429 · application/problem+json

Problem

Risposta 429
{
  "$ref": "#/components/schemas/Problem"
}

503 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
GET/agent-connections/{connectionId}/identity

Verificare i dati attuali chiave API per una connessione

Non sono accettati parametri di query. Le risposte non sono a magazzino. Le rotte dell'agente sono gestionali e funzionali; le distribuzioni possono restituire 404 quando sono disabilitate. X-API-Key è vietato sulle rotte degli agenti.

Autenticazione: agentIdentityKey

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

connectionId · path · richiesto

Schema
Schema
{
  "type": "string",
  "pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}

Risposte

200 Verificare i dati attuali chiave API per una connessione

Risposta 200 · application/json

AgentConnectionResponse

Risposta 200
{
  "$ref": "#/components/schemas/AgentConnectionResponse"
}

400 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 400 · application/problem+json

Problem

Risposta 400
{
  "$ref": "#/components/schemas/Problem"
}

401 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

409 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 409 · application/problem+json

Problem

Risposta 409
{
  "$ref": "#/components/schemas/Problem"
}

410 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 410 · application/problem+json

Problem

Risposta 410
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

429 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 429 · application/problem+json

Problem

Risposta 429
{
  "$ref": "#/components/schemas/Problem"
}

503 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
GET/agent-connections/{connectionId}/onboarding

Leggi lo stato di bordo recuperabile

Non sono accettati parametri di query. Le risposte non sono a magazzino. Le rotte dell'agente sono gestionali e funzionali; le distribuzioni possono restituire 404 quando sono disabilitate. X-API-Key è vietato sulle rotte degli agenti.

Autenticazione: agentHandoffProof

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

connectionId · path · richiesto

Schema
Schema
{
  "type": "string",
  "pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}

Risposte

200 Leggi lo stato di bordo recuperabile

Risposta 200 · application/json

AgentOnboardingStatus

Risposta 200
{
  "$ref": "#/components/schemas/AgentOnboardingStatus"
}

400 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 400 · application/problem+json

Problem

Risposta 400
{
  "$ref": "#/components/schemas/Problem"
}

401 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

409 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 409 · application/problem+json

Problem

Risposta 409
{
  "$ref": "#/components/schemas/Problem"
}

410 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 410 · application/problem+json

Problem

Risposta 410
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

429 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 429 · application/problem+json

Problem

Risposta 429
{
  "$ref": "#/components/schemas/Problem"
}

503 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/agent-connections/{connectionId}/claims

Creare un reclamo di approvazione del browser

Aprire claimPath su un'origine web di fiducia FlashData e visualizzare il codice separatamente. Non posizionare mai le credenziali o il codice di conferma nello URL. Non sono accettati parametri di query. Le risposte non sono a magazzino. Le rotte dell'agente sono gestionali e funzionali; le distribuzioni possono restituire 404 quando sono disabilitate. X-API-Key è vietato sulle rotte degli agenti.

Autenticazione: agentSetupCredential

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

connectionId · path · richiesto

Schema
Schema
{
  "type": "string",
  "pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}

Richiesta corpo · richiesto

Schema · application/json
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {},
  "required": []
}

Risposte

201 Creare un reclamo di approvazione del browser

Risposta 201 · application/json

AgentClaim

Risposta 201
{
  "$ref": "#/components/schemas/AgentClaim"
}

400 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 400 · application/problem+json

Problem

Risposta 400
{
  "$ref": "#/components/schemas/Problem"
}

401 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

409 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 409 · application/problem+json

Problem

Risposta 409
{
  "$ref": "#/components/schemas/Problem"
}

410 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 410 · application/problem+json

Problem

Risposta 410
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

429 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 429 · application/problem+json

Problem

Risposta 429
{
  "$ref": "#/components/schemas/Problem"
}

503 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/agent-connections/claims/{claimId}/confirm

Confermare il codice di reclamo in una sessione verificata del browser

Non sono accettati parametri di query. Le risposte non sono a magazzino. Le rotte dell'agente sono gestionali e funzionali; le distribuzioni possono restituire 404 quando sono disabilitate. X-API-Key è vietato sulle rotte degli agenti. Funzionamento di proprietà del browser. Sessione verificata completa richiesta; il chiamante non deve sostituire una chiave o una prova API.

Autenticazione: cookieSession + csrfToken

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

claimId · path · richiesto

Schema
Schema
{
  "type": "string",
  "pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}

Origin · header · richiesto

Schema
Schema
{
  "type": "string"
}

X-CSRF-Token · header · richiesto

Schema
Schema
{
  "type": "string"
}

Richiesta corpo · richiesto

Schema · application/json
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "code": {
      "type": "string",
      "pattern": "^\\d{8}$"
    }
  },
  "required": [
    "code"
  ]
}

Risposte

200 Confermare il codice di reclamo in una sessione verificata del browser

Risposta 200 · application/json

AgentBrowserClaim

Risposta 200
{
  "$ref": "#/components/schemas/AgentBrowserClaim"
}

400 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 400 · application/problem+json

Problem

Risposta 400
{
  "$ref": "#/components/schemas/Problem"
}

401 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

409 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 409 · application/problem+json

Problem

Risposta 409
{
  "$ref": "#/components/schemas/Problem"
}

410 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 410 · application/problem+json

Problem

Risposta 410
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

429 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 429 · application/problem+json

Problem

Risposta 429
{
  "$ref": "#/components/schemas/Problem"
}

503 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
GET/agent-connections/claims/{claimId}

Leggi un reclamo confermato nella sua sessione del browser

Non sono accettati parametri di query. Le risposte non sono a magazzino. Le rotte dell'agente sono gestionali e funzionali; le distribuzioni possono restituire 404 quando sono disabilitate. X-API-Key è vietato sulle rotte degli agenti. Funzionamento di proprietà del browser. Sessione verificata completa richiesta; il chiamante non deve sostituire una chiave o una prova API.

Autenticazione: cookieSession

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

claimId · path · richiesto

Schema
Schema
{
  "type": "string",
  "pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}

Risposte

200 Leggi un reclamo confermato nella sua sessione del browser

Risposta 200 · application/json

AgentClaimView

Risposta 200
{
  "$ref": "#/components/schemas/AgentClaimView"
}

400 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 400 · application/problem+json

Problem

Risposta 400
{
  "$ref": "#/components/schemas/Problem"
}

401 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

409 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 409 · application/problem+json

Problem

Risposta 409
{
  "$ref": "#/components/schemas/Problem"
}

410 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 410 · application/problem+json

Problem

Risposta 410
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

429 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 429 · application/problem+json

Problem

Risposta 429
{
  "$ref": "#/components/schemas/Problem"
}

503 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/agent-connections/claims/{claimId}/approve

Approva gli ambiti ridotti e il finanziamento dell'equilibrio dei conti

Non sono accettati parametri di query. Le risposte non sono a magazzino. Le rotte dell'agente sono gestionali e funzionali; le distribuzioni possono restituire 404 quando sono disabilitate. X-API-Key è vietato sulle rotte degli agenti. Funzionamento di proprietà del browser. Sessione verificata completa richiesta; il chiamante non deve sostituire una chiave o una prova API.

Autenticazione: cookieSession + csrfToken

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

claimId · path · richiesto

Schema
Schema
{
  "type": "string",
  "pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}

Origin · header · richiesto

Schema
Schema
{
  "type": "string"
}

X-CSRF-Token · header · richiesto

Schema
Schema
{
  "type": "string"
}

Richiesta corpo · richiesto

Schema · application/json

AgentApproval

Schema
{
  "$ref": "#/components/schemas/AgentApproval"
}

Risposte

200 Approva gli ambiti ridotti e il finanziamento dell'equilibrio dei conti

Risposta 200 · application/json

AgentConnection

Risposta 200
{
  "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 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 400 · application/problem+json

Problem

Risposta 400
{
  "$ref": "#/components/schemas/Problem"
}

401 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

409 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 409 · application/problem+json

Problem

Risposta 409
{
  "$ref": "#/components/schemas/Problem"
}

410 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 410 · application/problem+json

Problem

Risposta 410
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

429 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 429 · application/problem+json

Problem

Risposta 429
{
  "$ref": "#/components/schemas/Problem"
}

503 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/agent-connections/{connectionId}/handoff

Recuperare il proprietario approvato API chiave

La chiave del candidato scade nelle ore 24 fino all'installazione ACK. Persistere atomicamente, ricaricare in un processo fresco e verificare l'identità prima di ACK. Una consegna ripetuta recupera lo stesso candidato; la consegna confermata restituisce una ricevuta senza credenziali. Non sono accettati parametri di query. Le risposte non sono a magazzino. Le rotte dell'agente sono gestionali e funzionali; le distribuzioni possono restituire 404 quando sono disabilitate. X-API-Key è vietato sulle rotte degli agenti.

Autenticazione: agentHandoffProof

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

connectionId · path · richiesto

Schema
Schema
{
  "type": "string",
  "pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}

Richiesta corpo · richiesto

Schema · application/json
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {},
  "required": []
}

Risposte

200 Recuperare il proprietario approvato API chiave

Risposta 200 · application/json

AgentHandoff

Risposta 200
{
  "$ref": "#/components/schemas/AgentHandoff"
}

400 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 400 · application/problem+json

Problem

Risposta 400
{
  "$ref": "#/components/schemas/Problem"
}

401 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

409 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 409 · application/problem+json

Problem

Risposta 409
{
  "$ref": "#/components/schemas/Problem"
}

410 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 410 · application/problem+json

Problem

Risposta 410
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

429 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 429 · application/problem+json

Problem

Risposta 429
{
  "$ref": "#/components/schemas/Problem"
}

503 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/agent-connections/{connectionId}/handoff/ack

Riconoscimento verificata installazione chiavi proprietario

Caller deve aver già salvato il candidato e verificarlo in modo indipendente in un processo fresco. Segni ACK di successo installati, rimuove la scadenza chiave del candidato ed elimina il materiale recuperabile delle credenziali. Ripeto ACK è idempotent. Non sono accettati parametri di query. Le risposte non sono a magazzino. Le rotte dell'agente sono gestionali e funzionali; le distribuzioni possono restituire 404 quando sono disabilitate. X-API-Key è vietato sulle rotte degli agenti.

Autenticazione: agentHandoffProof

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

connectionId · path · richiesto

Schema
Schema
{
  "type": "string",
  "pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}

Richiesta corpo · richiesto

Schema · application/json
Schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "apiKey": {
      "type": "string"
    }
  },
  "required": [
    "apiKey"
  ]
}

Risposte

200 Riconoscimento verificata installazione chiavi proprietario

Risposta 200 · application/json

AgentHandoff

Risposta 200
{
  "$ref": "#/components/schemas/AgentHandoff"
}

400 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 400 · application/problem+json

Problem

Risposta 400
{
  "$ref": "#/components/schemas/Problem"
}

401 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

409 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 409 · application/problem+json

Problem

Risposta 409
{
  "$ref": "#/components/schemas/Problem"
}

410 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 410 · application/problem+json

Problem

Risposta 410
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

429 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 429 · application/problem+json

Problem

Risposta 429
{
  "$ref": "#/components/schemas/Problem"
}

503 Richiesta respinta; ispezionare il codice Problema. Non riprovare mai una mutazione ciecamente.

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}

Catalogo

GET/catalog/sources

Elenca le capacità di fonte pubblica senza i prezzi specifici del conto

Autenticazione: Pubblico

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Risposte

200 Catalogo delle fonti pubbliche

Intestazioni: Cache-Control

Risposta 200 · application/json

DataSource

Risposta 200
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DataSource"
      }
    }
  }
}
GET/plans

Elenca i piani e i prezzi pubblici USD

Autenticazione: Pubblico

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Risposte

200 Catalogo del piano pubblico

Intestazioni: Cache-Control

Risposta 200 · application/json

PlanCatalog

Risposta 200
{
  "$ref": "#/components/schemas/PlanCatalog"
}
GET/legal/current

Leggi le attuali versioni Termini e Privacy necessarie per l'iscrizione

Autenticazione: Pubblico

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Risposte

200 Catalogo della versione legale attuale

Intestazioni: Cache-Control

Risposta 200 · application/json

PublicLegalVersions

Risposta 200
{
  "$ref": "#/components/schemas/PublicLegalVersions"
}

Billing

GET/billing/subscription

Leggi l'effettivo abbonamento Stripe

Autenticazione: cookieSession

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Risposte

200 Abbonamento o diritto PAYG

Risposta 200 · application/json

Subscription

Risposta 200
{
  "$ref": "#/components/schemas/Subscription"
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}
POST/billing/checkout-sessions

Creare una sessione di checkout a righe

Abbonamenti e pacchetti di credito pubblicati utilizzano priceId. Un top-up personalizzato utilizza amountMinor invece (USD cents, $10 a $999,999.99); il server calcola i crediti al valore di credito fisso e crea un prezzo privato di Stripe una volta. Prodotto, prezzo del fornitore, valuta, successo URL e cancellare URL non sono mai accettati dal browser. I crediti sono concessi solo dopo un evento pagato verificato per l'importo citato.

Autenticazione: cookieSession + csrfToken

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

Idempotency-Key · header · richiesto

Schema
Schema
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

Richiesta corpo · richiesto

Schema · application/json
Schema
{
  "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"
        }
      }
    }
  ]
}

Risposte

201 Sessione di checkout Stripe

Risposta 201 · application/json

HostedSession

Risposta 201
{
  "$ref": "#/components/schemas/HostedSession"
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Autentico ma non consentito, o la convalida CSRF non è riuscita

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

409 Stato di risorse o conflitto di idempotency

Risposta 409 · application/problem+json

Problem

Risposta 409
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta di validazione non riuscita

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

502 Un fornitore a monte ha fallito

Risposta 502 · application/problem+json

Problem

Risposta 502
{
  "$ref": "#/components/schemas/Problem"
}

503 Il catalogo di fatturazione o il fornitore non è configurato o temporaneamente non è disponibile

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/billing/subscription-changes

Aggiorna l'abbonamento a Stripe corrente ad un prezzo più alto pubblicato

Il server verifica che il prezzo FlashData sia attivo, disponibile nella versione livemode corrente, denominato USD, ricorrente, stesso intervallo, e rigorosamente più costoso del prezzo di abbonamento corrente. Le opzioni di prodotto, prezzo del fornitore, valuta e prorazione non sono mai accettate dal browser. Il diritto locale e i crediti cambiano solo dopo che un evento verificato del fornitore è proiettato.

Autenticazione: cookieSession + csrfToken

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

Idempotency-Key · header · richiesto

Schema
Schema
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

Richiesta corpo · richiesto

Schema · application/json
Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "priceId"
  ],
  "properties": {
    "priceId": {
      "type": "string",
      "pattern": "^prc_"
    }
  }
}

Risposte

201 Cambio di iscrizione inviato a Stripe

Risposta 201 · application/json

SubscriptionChange

Risposta 201
{
  "$ref": "#/components/schemas/SubscriptionChange"
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Autentico ma non consentito, o la convalida CSRF non è riuscita

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

404 Risorse non trovate o non possedute dal chiamante

Risposta 404 · application/problem+json

Problem

Risposta 404
{
  "$ref": "#/components/schemas/Problem"
}

409 Stato di risorse o conflitto di idempotency

Risposta 409 · application/problem+json

Problem

Risposta 409
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta di validazione non riuscita

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

502 Un fornitore a monte ha fallito

Risposta 502 · application/problem+json

Problem

Risposta 502
{
  "$ref": "#/components/schemas/Problem"
}

503 Il catalogo di fatturazione o il fornitore non è configurato o temporaneamente non è disponibile

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/billing/portal-sessions

Creare una sessione del portale clienti Stripe

Autenticazione: cookieSession + csrfToken

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

Idempotency-Key · header · richiesto

Schema
Schema
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

Risposte

201 Sessione del portale clienti Stripe

Risposta 201 · application/json

HostedSession

Risposta 201
{
  "$ref": "#/components/schemas/HostedSession"
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Autentico ma non consentito, o la convalida CSRF non è riuscita

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

404 Risorse non trovate o non possedute dal chiamante

Risposta 404 · application/problem+json

Problem

Risposta 404
{
  "$ref": "#/components/schemas/Problem"
}

409 Stato di risorse o conflitto di idempotency

Risposta 409 · application/problem+json

Problem

Risposta 409
{
  "$ref": "#/components/schemas/Problem"
}

502 Un fornitore a monte ha fallito

Risposta 502 · application/problem+json

Problem

Risposta 502
{
  "$ref": "#/components/schemas/Problem"
}

503 Il catalogo di fatturazione o il fornitore non è configurato o temporaneamente non è disponibile

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/billing/subscription-cancellation

Orari o cancellazione dell'abbonamento a pagamento corrente

Impostare cancelAtPeriodEnd a true pianifica la cancellazione al termine del periodo di fatturazione corrente; false mantiene l'abbonamento. Gli ingressi si aggiornano dopo un evento verificato di abbonamento a Stripe. Questo endpoint non annulla mai immediatamente o emette un rimborso.

Autenticazione: cookieSession + csrfToken

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

Idempotency-Key · header · richiesto

Schema
Schema
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

Richiesta corpo · richiesto

Schema · application/json
Schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "cancelAtPeriodEnd"
  ],
  "properties": {
    "cancelAtPeriodEnd": {
      "type": "boolean"
    }
  }
}

Risposte

202 Aggiornamento di cancellazione inviato a Stripe

Risposta 202 · application/json

SubscriptionCancellationChange

Risposta 202
{
  "$ref": "#/components/schemas/SubscriptionCancellationChange"
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Autentico ma non consentito, o la convalida CSRF non è riuscita

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

404 Risorse non trovate o non possedute dal chiamante

Risposta 404 · application/problem+json

Problem

Risposta 404
{
  "$ref": "#/components/schemas/Problem"
}

409 Stato di risorse o conflitto di idempotency

Risposta 409 · application/problem+json

Problem

Risposta 409
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta di validazione non riuscita

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

502 Un fornitore a monte ha fallito

Risposta 502 · application/problem+json

Problem

Risposta 502
{
  "$ref": "#/components/schemas/Problem"
}

503 Il catalogo di fatturazione o il fornitore non è configurato o temporaneamente non è disponibile

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
GET/billing/invoices

Elenco Proiezioni di fatture Stripe

Autenticazione: cookieSession

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

cursor · query · opzionale

Schema
Schema
{
  "type": "string",
  "maxLength": 512
}

limit · query · opzionale

Schema
Schema
{
  "type": "integer",
  "minimum": 1,
  "maximum": 100,
  "default": 50
}

Risposte

200 Fatture

Risposta 200 · application/json

Invoice · Page

Risposta 200
{
  "allOf": [
    {
      "$ref": "#/components/schemas/Page"
    },
    {
      "type": "object",
      "properties": {
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Invoice"
          }
        }
      }
    }
  ]
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}
GET/billing/payments

Elenca le proiezioni di pagamento top-up e rimborso

Autenticazione: cookieSession

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

cursor · query · opzionale

Schema
Schema
{
  "type": "string",
  "maxLength": 512
}

limit · query · opzionale

Schema
Schema
{
  "type": "integer",
  "minimum": 1,
  "maximum": 100,
  "default": 50
}

Risposte

200 Storia di pagamento una volta senza segreti dei fornitori

Risposta 200 · application/json

BillingPaymentPage

Risposta 200
{
  "$ref": "#/components/schemas/BillingPaymentPage"
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

Crediti

GET/api-access/balance

Leggi il saldo del conto in diretta utilizzando un tasto API

Leggi l'attuale saldo di credito condiviso da tutte le chiavi API nel tuo account. Le prenotazioni attive possono ridurre il saldo disponibile. Questa richiesta non costa Crediti e non richiede parametri di query o corpo. Le risposte sono private e non vengono memorizzate nella cache; si applicano i limiti dei tassi di lettura del conto.

Autenticazione: dataApiKey

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Risposte

200 Bilancio firmato e non negativo disponibile Crediti

Risposta 200 · application/json

ApiAccessBalance

Risposta 200
{
  "$ref": "#/components/schemas/ApiAccessBalance"
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta di validazione non riuscita

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

429 Troppi account legge; riprovare dopo la finestra di tasso-limite

503 Una dipendenza o un catalogo richiesti è temporaneamente non disponibile

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
GET/api-access/pricing

Leggere i prezzi reali del conto per le fonti autorizzate dalla chiave API

Leggi i tassi di conto per le fonti consentite dalla chiave API. Il prezzo di null significa che la fonte non è disponibile. request_count conta query, non articoli restituiti; i tassi di download sono per TB (10^12 byte). Le stime non riservano crediti o capacità. Questa richiesta non costa Crediti. Le risposte sono private e non vengono memorizzate nella cache; si applicano i limiti dei tassi di lettura del conto.

Autenticazione: dataApiKey

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

source · query · opzionale

Una fonte concessa a questa chiave; omettere di leggere tutte le fonti concesse.

Schema

ApiAccessSource

Schema
{
  "$ref": "#/components/schemas/ApiAccessSource"
}

request_count · query · opzionale

Numero intero decimale di chiamate; non stima la dimensione del download.

Schema
Schema
{
  "type": "integer",
  "minimum": 1,
  "maximum": 100000,
  "default": 1
}

Risposte

200 Piano degli account e prezzi specifici per le fonti

Risposta 200 · application/json

ApiAccessPricing

Risposta 200
{
  "$ref": "#/components/schemas/ApiAccessPricing"
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Autentico ma non consentito, o la convalida CSRF non è riuscita

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta di validazione non riuscita

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

429 Troppi account legge; riprovare dopo la finestra di tasso-limite

503 Una dipendenza o un catalogo richiesti è temporaneamente non disponibile

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
GET/api-access/limits

Leggere i limiti del piano dell'account e i lavori in sospeso attuali utilizzando una chiave API

Leggi i tuoi limiti di lavoro, di dimensione batch e in attesa, oltre al conteggio in corso. Questi valori aiutano a pianificare le richieste, ma non si riservano capacità. Questa richiesta non costa Crediti e non richiede parametri di query o corpo. Le risposte sono private e non vengono memorizzate nella cache; si applicano i limiti dei tassi di lettura del conto.

Autenticazione: dataApiKey

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Risposte

200 Soffitti piani e conteggio corrente in sospeso

Risposta 200 · application/json

ApiAccessLimits

Risposta 200
{
  "$ref": "#/components/schemas/ApiAccessLimits"
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta di validazione non riuscita

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

429 Troppi account legge; riprovare dopo la finestra di tasso-limite

503 Una dipendenza o un catalogo richiesti è temporaneamente non disponibile

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
GET/usage

Leggi l'utilizzo dell'account per le fonti autorizzate dalla chiave API

Libero letto, autenticato solo da X-API-Key. Include tutte le chiavi dell'account ma solo le fonti concesse alla chiave di chiamata. Non restituisce testo di query, chiavi, dettagli di pagamento o altri account. Predefiniti a sette giorni; massimo giorni 31. Le date devono usare i timestamp UTC Z. Da è inclusiva ed esclusiva; entrambi sono arrotondati fino a minuti. Con da solo, per default a da + 7 giorni. Con nè, per è l'inizio del minuto successivo. Gli aggregati sono alla fine coerente; anche l'aggiornamento=false non garantisce che tutti gli eventi recenti siano ingeriti. Limite di lettura: richieste 60 al minuto per IP client.

Autenticazione: dataApiKey

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

source · query · opzionale

Una fonte di catalogo esatta concessa alla chiave di chiamata; omesso significa tutte le fonti concesse.

Schema
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 · opzionale

Schema
Schema
{
  "type": "string",
  "format": "date-time"
}

to · query · opzionale

Schema
Schema
{
  "type": "string",
  "format": "date-time"
}

Risposte

200 La richiesta spessa conta e addebita Crediti, con informazioni di freschezza

Risposta 200 · application/json

ApiKeyUsage

Risposta 200
{
  "$ref": "#/components/schemas/ApiKeyUsage"
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Autentico ma non consentito, o la convalida CSRF non è riuscita

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta di validazione non riuscita

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

429 Troppe volte l'uso legge; riprovare dopo la finestra tasso-limite

503 Una dipendenza o un catalogo richiesti è temporaneamente non disponibile

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
GET/credits/balance

Leggi la corrente disponibile e i crediti riservati

Autenticazione: cookieSession

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Risposte

200 Bilancio di credito

Risposta 200 · application/json

CreditBalance

Risposta 200
{
  "$ref": "#/components/schemas/CreditBalance"
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}
GET/credits/policy

Leggi l'efficace politica di concessione e di ricarica del credito del conto

Autenticazione: cookieSession

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Risposte

200 Politica di credito efficace

Risposta 200 · application/json

CreditPolicy

Risposta 200
{
  "$ref": "#/components/schemas/CreditPolicy"
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}
GET/credits/transactions

Elenco delle voci del registro di credito

Autenticazione: cookieSession

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

cursor · query · opzionale

Schema
Schema
{
  "type": "string",
  "maxLength": 512
}

limit · query · opzionale

Schema
Schema
{
  "type": "integer",
  "minimum": 1,
  "maximum": 100,
  "default": 50
}

type · query · opzionale

Schema

CreditEntryType

Schema
{
  "$ref": "#/components/schemas/CreditEntryType"
}

Risposte

200 Entrate Ledger

Risposta 200 · application/json

CreditTransaction · Page

Risposta 200
{
  "allOf": [
    {
      "$ref": "#/components/schemas/Page"
    },
    {
      "type": "object",
      "properties": {
        "data": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/CreditTransaction"
          }
        }
      }
    }
  ]
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

Crediti di prova

GET/trial-credit-request

Leggere l'ammissibilità del credito e la richiesta di vita dell'account

Autenticazione: cookieSession

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Risposte

200 Ammissibilità attuale, sovvenzione configurata e stato di richiesta

Intestazioni: Cache-Control

Risposta 200 · application/json

TrialCreditState

Risposta 200
{
  "$ref": "#/components/schemas/TrialCreditState"
}

401 Autenticazione richiesta o invalida

Intestazioni: Cache-Control, X-Request-Id

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

500 Si è verificato un errore interno inaspettato

Intestazioni: Cache-Control, X-Request-Id

Risposta 500 · application/problem+json

Problem

Risposta 500
{
  "$ref": "#/components/schemas/Problem"
}

503 Una dipendenza richiesta o un record di bordo è temporaneamente non disponibile

Intestazioni: Cache-Control, X-Request-Id

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}
POST/trial-credit-request

Inviare la richiesta di credito di prova di una vita del conto

L'importo della prova e il caso di utilizzo vengono salvati quando si invia la richiesta.

Autenticazione: cookieSession + csrfToken

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

Idempotency-Key · header · richiesto

Schema
Schema
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

Richiesta corpo · opzionale

Schema · application/json
Schema
{
  "type": "object",
  "additionalProperties": false
}

Risposte

201 Richiesta di credito creato e approvato automaticamente per gli account verificati idonei, indipendentemente dal fornitore di e-mail

Intestazioni: Cache-Control

Risposta 201 · application/json

TrialCreditState

Risposta 201
{
  "$ref": "#/components/schemas/TrialCreditState"
}

401 Autenticazione richiesta o invalida

Intestazioni: Cache-Control, X-Request-Id

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

403 Autentico ma non consentito, o la convalida CSRF non è riuscita

Intestazioni: Cache-Control, X-Request-Id

Risposta 403 · application/problem+json

Problem

Risposta 403
{
  "$ref": "#/components/schemas/Problem"
}

409 Stato di risorse o conflitto di idempotency

Intestazioni: Cache-Control, X-Request-Id

Risposta 409 · application/problem+json

Problem

Risposta 409
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta di validazione non riuscita

Intestazioni: Cache-Control, X-Request-Id

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

500 Si è verificato un errore interno inaspettato

Intestazioni: Cache-Control, X-Request-Id

Risposta 500 · application/problem+json

Problem

Risposta 500
{
  "$ref": "#/components/schemas/Problem"
}

503 Una dipendenza richiesta o un record di bordo è temporaneamente non disponibile

Intestazioni: Cache-Control, X-Request-Id

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}

Consegna

GET/delivery/webhooks

Elenco salvato completamento callback URLs

Autenticazione: cookieSession

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Risposte

200 Callback URLs

Risposta 200 · application/json

DeliveryWebhook

Risposta 200
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DeliveryWebhook"
      }
    }
  }
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}
POST/delivery/webhooks

Salvare il callback di completamento URL

Autenticazione: cookieSession + csrfToken

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Richiesta corpo · richiesto

Schema · application/json

CreateDeliveryWebhookRequest

Schema
{
  "$ref": "#/components/schemas/CreateDeliveryWebhookRequest"
}

Risposte

201 Creato

Risposta 201 · application/json

DeliveryWebhook

Risposta 201
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "webhook"
  ],
  "properties": {
    "webhook": {
      "$ref": "#/components/schemas/DeliveryWebhook"
    }
  }
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta di validazione non riuscita

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}
DELETE/delivery/webhooks/{webhookId}

Rimuovere il callback di completamento URL

Autenticazione: cookieSession + csrfToken

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

webhookId · path · richiesto

Schema
Schema
{
  "type": "string",
  "pattern": "^cbk_[A-Za-z0-9_-]{8,}$"
}

Risposte

204 Rimozione

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

404 Risorse non trovate o non possedute dal chiamante

Risposta 404 · application/problem+json

Problem

Risposta 404
{
  "$ref": "#/components/schemas/Problem"
}
POST/delivery/webhooks/{webhookId}/test

Invia un campione scarica-completo payload

Autenticazione: cookieSession + csrfToken

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

webhookId · path · richiesto

Schema
Schema
{
  "type": "string",
  "pattern": "^cbk_[A-Za-z0-9_-]{8,}$"
}

Risposte

200 Prova del test

Risposta 200 · application/json

DeliveryWebhook

Risposta 200
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "statusCode",
    "webhook"
  ],
  "properties": {
    "statusCode": {
      "type": "integer",
      "minimum": 0
    },
    "webhook": {
      "$ref": "#/components/schemas/DeliveryWebhook"
    }
  }
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

404 Risorse non trovate o non possedute dal chiamante

Risposta 404 · application/problem+json

Problem

Risposta 404
{
  "$ref": "#/components/schemas/Problem"
}

Lavori

Per la presentazione, lo stato e gli esempi di risultati, vedere Realtime e asincrona · Richieste Batch.

GET/jobs

Elenca i lavori API per lo spazio di lavoro corrente

Cursor-paginated storia attiva e archiviata. Predefiniti per gli ultimi sette giorni; ogni intervallo di date UTC è limitato ai giorni 31. Da è inclusiva ed è esclusiva, a minuto di precisione. I riassunti sono mantenuti asincroni e possono ingestione lag.

Autenticazione: cookieSession

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

cursor · query · opzionale

Schema
Schema
{
  "type": "string",
  "minLength": 1,
  "maxLength": 512
}

limit · query · opzionale

Schema
Schema
{
  "type": "integer",
  "minimum": 1,
  "maximum": 50
}

source · query · opzionale

Schema
Schema
{
  "type": "string",
  "pattern": "^(google|youtube|google_[a-z]+|youtube_[a-z_]+)$"
}

status · query · opzionale

Schema
Schema
{
  "type": "string",
  "enum": [
    "completed",
    "failed",
    "pending",
    "processing"
  ]
}

mode · query · opzionale

Schema
Schema
{
  "type": "string",
  "enum": [
    "async",
    "batch",
    "realtime"
  ]
}

from · query · opzionale

Schema
Schema
{
  "type": "string",
  "format": "date-time"
}

to · query · opzionale

Schema
Schema
{
  "type": "string",
  "format": "date-time"
}

Risposte

200 Pagina del lavoro

Risposta 200 · application/json

ConsoleJob · Pagination

Risposta 200
{
  "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 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta di validazione non riuscita

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}
GET/jobs/{jobId}

Leggi un lavoro Data API

Leggi job.status per verificare il progresso e job.error se l'elaborazione non è riuscita. JSON è il predefinito; utilizzare Accept: text/plain per il testo leggibile. X-Respond-With viene ignorato qui. Seguire Retry-After quando fornito prima di controllare di nuovo.

Autenticazione: cookieSession o dataApiKey

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

Accept · header · opzionale

application/json restituisce la risposta strutturata originale; text/plain restituisce gli stessi campi del testo normale indentato. Sono supportate gamme standard di media e pesi q; manca Accept o un default di wildcard globale a JSON. X-Respond-With viene ignorato sui endpoint di presentazione e di job-status. Gli errori rimangono strutturati JSON. Entrambi i tipi di risposta utilizzano il parametro UTF-8; è supportato un parametro charset=utf-8.

Schema
Schema
{
  "type": "string"
}

jobId · path · richiesto

Schema
Schema
{
  "type": "string",
  "pattern": "^job_[A-Za-z0-9_-]+$"
}

Risposte

200 Dettagli del lavoro

Risposta 200 · application/json

ConsoleJob

Risposta 200
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "job"
  ],
  "properties": {
    "job": {
      "$ref": "#/components/schemas/ConsoleJob"
    }
  }
}
Risposta 200 · text/plain
Risposta 200
{
  "type": "string"
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

404 Risorse non trovate o non possedute dal chiamante

Risposta 404 · application/problem+json

Problem

Risposta 404
{
  "$ref": "#/components/schemas/Problem"
}

406 Né application/json né text/plain sono accettabili; la risposta è JSON

Risposta 406 · application/json

QueryRepresentationError

Risposta 406
{
  "$ref": "#/components/schemas/QueryRepresentationError"
}
GET/jobs/{jobId}/results

Scarica un risultato asincastro completato

Per impostazione predefinita, autentica l'accesso e reindirizza a un R2 URL privato di breve durata; i client ricevono l'originale JSON direttamente da R2. Accept: text/plain restituisce in modo indipendente HTTP 200 con i campi di risultato originali come testo normale indentato. X-Respond-With: markdown seleziona il contenuto Markdown: application/json lo avvolge nel contenuto accanto ai metadati originali, sostituendo i risultati; text/plain restituisce i metadati seguiti da Markdown. Manca Accept o un default di wildcard globale a JSON. La formattazione non presenta un'altra domanda o crediti di query di carica. I risultati archiviati scadono ore 24 dopo il completamento. Gli errori rimangono strutturati JSON.

Autenticazione: cookieSession o dataApiKey

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

X-Respond-With · header · opzionale

Impostare il markdown per restituire il contenuto dei risultati come Markdown. Omettere di mantenere i campi di risultato originali. Accept seleziona in modo indipendente JSON o testo normale. Solo query in tempo reale e risultato del lavoro completato legge il supporto di questo intestazione. Non cambia le presentazioni di lavoro, lo stato, le API di account, i callback, i file Bulk, i download binari o le risposte del protocollo MCP.

Schema
Schema
{
  "type": "string",
  "enum": [
    "markdown"
  ]
}

Accept · header · opzionale

Selezionare application/json o text/plain indipendentemente da X-Respond-With. Senza X-Respond-With, text/plain restituisce i campi originali con indentazione; JSON mantiene i campi di risposta originali (risultato completo reindirizza alla memorizzazione). Con markdown, JSON restituisce contenuti più metadati e testo semplice restituisce metadati seguiti da Markdown. Sono supportate gamme standard di media e pesi q; manca Accept o un default di wildcard globale a JSON. Entrambi i tipi di risposta utilizzano il parametro UTF-8; è supportato un parametro charset=utf-8.

Schema
Schema
{
  "type": "string"
}

jobId · path · richiesto

Schema
Schema
{
  "type": "string",
  "pattern": "^job_[A-Za-z0-9_-]+$"
}

Risposte

200 I campi originali del testo in pianura o Markdown sono ritornati direttamente; JSON originale da R2 dopo aver seguito il reindirizzamento predefinito

Risposta 200 · application/json

MarkdownQueryResult

Risposta 200
{
  "anyOf": [
    {
      "$ref": "#/components/schemas/MarkdownQueryResult"
    },
    {
      "type": "object",
      "additionalProperties": true
    }
  ]
}
Risposta 200 · text/plain
Risposta 200
{
  "type": "string"
}

302 Reindirizza lo JSON originale nello storage R2 privato quando viene selezionato JSON senza X-Respond-With

Intestazioni: Location

400 Valore X-Respond-With non supportato; risposta è JSON

Risposta 400 · application/json

QueryRepresentationError

Risposta 400
{
  "$ref": "#/components/schemas/QueryRepresentationError"
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

404 Risorse non trovate o non possedute dal chiamante

Risposta 404 · application/problem+json

Problem

Risposta 404
{
  "$ref": "#/components/schemas/Problem"
}

406 Né application/json né text/plain sono accettabili; la risposta è JSON

Risposta 406 · application/json

QueryRepresentationError

Risposta 406
{
  "$ref": "#/components/schemas/QueryRepresentationError"
}

409 Stato di risorse o conflitto di idempotency

Risposta 409 · application/problem+json

Problem

Risposta 409
{
  "$ref": "#/components/schemas/Problem"
}

410 Risultato scaduto

Risposta 410 · application/problem+json

Problem

Risposta 410
{
  "$ref": "#/components/schemas/Problem"
}

422 L’attività non è riuscita. Se disponibile, il campo detail della risposta riporta il motivo registrato.

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}

503 Una dipendenza o un catalogo richiesti è temporaneamente non disponibile

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}

API di elaborazione Bulk

Gli endpoint Bulk hanno un riferimento dedicato con parametri, esempi di richiesta e schemi di risposta. Elaborazione Bulk aperta API

Playground

POST/playground/run

Eseguire una query parco giochi come l'attuale spazio di lavoro

Autenticazione: cookieSession + csrfToken

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Richiesta corpo · richiesto

Schema · application/json
Schema
{
  "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
    }
  }
}

Risposte

200 A monte della risposta di dati API catturata per il parco giochi

Risposta 200 · application/json
Risposta 200
{
  "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 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

422 Richiesta di validazione non riuscita

Risposta 422 · application/problem+json

Problem

Risposta 422
{
  "$ref": "#/components/schemas/Problem"
}
GET/playground/jobs/{jobId}/download

Scarica un artefatto Playground completato nel browser corrente

Autenticazione: cookieSession

Server: https://api.flashdata.dev/v2

Server: http://localhost:5000/v2

Parametri

jobId · path · richiesto

Schema
Schema
{
  "type": "string",
  "pattern": "^job_[A-Za-z0-9_-]+$"
}

Risposte

200 Temporanea browserdownload artefatto

Intestazioni: Content-Disposition, Content-Length

Risposta 200 · application/octet-stream
Risposta 200
{
  "type": "string",
  "format": "binary"
}

401 Autenticazione richiesta o invalida

Risposta 401 · application/problem+json

Problem

Risposta 401
{
  "$ref": "#/components/schemas/Problem"
}

404 Risorse non trovate o non possedute dal chiamante

Risposta 404 · application/problem+json

Problem

Risposta 404
{
  "$ref": "#/components/schemas/Problem"
}

409 Stato di risorse o conflitto di idempotency

Risposta 409 · application/problem+json

Problem

Risposta 409
{
  "$ref": "#/components/schemas/Problem"
}

410 L'artefatto temporaneo è scaduto

Risposta 410 · application/problem+json

Problem

Risposta 410
{
  "$ref": "#/components/schemas/Problem"
}

503 Una dipendenza o un catalogo richiesti è temporaneamente non disponibile

Risposta 503 · application/problem+json

Problem

Risposta 503
{
  "$ref": "#/components/schemas/Problem"
}

Definizioni dello schema

APIKeyIdentity
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
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
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
AgentApproval
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "scopes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "allowAccountBalance": {
      "const": true
    }
  },
  "required": [
    "scopes",
    "allowAccountBalance"
  ]
}
AgentBrowserClaim
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
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
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
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
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
AgentConnectionResponse
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "connection": {
      "$ref": "#/components/schemas/AgentConnection"
    }
  },
  "required": [
    "connection"
  ]
}
AgentHandoff
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
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
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
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
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
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
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
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
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
ApiAccessPlan
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "billingMode": {
      "type": "string"
    },
    "status": {
      "type": "string"
    }
  }
}
ApiAccessPricing
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
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
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
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
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
BillingPaymentPage
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "pagination"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/BillingPayment"
      }
    },
    "pagination": {
      "$ref": "#/components/schemas/Pagination"
    }
  }
}
BillingPayment
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
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
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
BulkJobPage
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "pagination"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/BulkJob"
      }
    },
    "pagination": {
      "$ref": "#/components/schemas/Pagination"
    }
  }
}
BulkJobResponse
BulkJobResponse
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "job"
  ],
  "properties": {
    "job": {
      "$ref": "#/components/schemas/BulkJob"
    }
  }
}
ConsoleJob
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
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
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
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
CreateDeliveryWebhookRequest
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "name",
    "url"
  ],
  "properties": {
    "name": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "format": "uri"
    }
  }
}
CreditBalance
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
CreditEntryType
{
  "type": "string",
  "enum": [
    "subscription_grant",
    "topup_grant",
    "payment_reversal",
    "admin_adjustment",
    "trial_grant"
  ]
}
CreditPolicy
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
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
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
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
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
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
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"
    }
  }
}
LegalAcceptanceRequest
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
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
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
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
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
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
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
Page
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "data",
    "pagination"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {}
    },
    "pagination": {
      "$ref": "#/components/schemas/Pagination"
    }
  }
}
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
Password
{
  "type": "string",
  "minLength": 8,
  "maxLength": 128,
  "writeOnly": true
}
PlanCatalog
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
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
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
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
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
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
FieldError
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "field",
    "code",
    "message"
  ],
  "properties": {
    "field": {
      "type": "string"
    },
    "code": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}
PublicLegalVersions
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
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
PublicStatusComponent
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "name",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "operational",
        "degraded",
        "outage"
      ]
    }
  }
}
PublicTrialOffer
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
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
Reauthentication
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "reauthenticatedUntil"
  ],
  "properties": {
    "reauthenticatedUntil": {
      "type": "string",
      "format": "date-time"
    }
  }
}
RegisterRequest
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
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
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
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
SubscriptionCancellationChange
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "cancelAtPeriodEnd",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^sub_"
    },
    "cancelAtPeriodEnd": {
      "type": "boolean"
    },
    "status": {
      "type": "string",
      "enum": [
        "submitted"
      ]
    }
  }
}
SubscriptionChange
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
TokenRequest
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "token"
  ],
  "properties": {
    "token": {
      "type": "string",
      "minLength": 32,
      "maxLength": 256,
      "writeOnly": true
    }
  }
}
TrialCreditState
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
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
TrialCreditRequestStatus
{
  "type": "string",
  "enum": [
    "pending",
    "approved",
    "rejected"
  ]
}
UpdateAccountRequest
UpdateAccountRequest
{
  "type": "object",
  "additionalProperties": false,
  "minProperties": 1,
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "timezone": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    }
  }
}
UpdateBulkJobRequest
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
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
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."
    }
  }
}