Überspringen zum Inhalt
DE
API-Schlüssel
Dokumentation durchsuchen

API-Referenz

Management API-Referenz

Durchsuchen Sie Endpunkte für Konten, Schlüssel, Abrechnung und Jobs. Jeder Endpunkt listet seine eigenen Authentifizierungs- und Zugriffsanforderungen auf.

Lesen Sie Ihr Konto mit einem API-Schlüssel

Die Management API Basis URL ist https://api.flashdata.dev/v2. Dieser kostenlose Lesevorgang gibt den aktuellen Schlüssel und das aktuelle Konto IDs und den Besitz zurück. Setzen Sie FLASHDATA_API_KEY, bevor Sie den Befehl ausführen.

Überprüfen Sie den aktuellen Schlüssel · 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'

Erwarten Sie HTTP 200 auf Erfolg. Überprüfen Sie die Authentifizierungszeile jedes Endpunkts: dataApiKey verwendet X-API-Key; cookieSession verwendet eine angemeldete Browsersitzung. Schema der Identitätsantwort

Download der OpenAPI-Spezifikation des Kunden. Es umfasst Abfragen, Jobs, Konten, API-Schlüssel und Abrechnung.

Abfrageparameter und Anforderungscode werden im Google und YouTube API Referenzen.

Authentifizierungssysteme

RegelungAnforderungen
dataApiKey

X-API-Key · header

FlashData API Schlüssel. Der Zugriff auf den Job ist auf die Quellbereiche des Schlüssels beschränkt.

cookieSession

__Host-fd_session · cookie

Undurchsichtige Web-Sitzung. Der Browser kann dieses Cookie nicht lesen.

csrfToken

X-CSRF-Token · header

apiKey

agentRegistrationProof

Beharren Sie auf einem kryptographisch zufälligen 32-Byte base64url-Beweis und einer genauen Anforderung VOR dem Senden; Wiederherstellen nur mit dem gleichen Beweis und Körper. Kein OAuth Token.

agentSetupCredential

Temporäre Einrichtungsnachweise nur für Status- und Anspruchserstellung. Kein API-Datenschlüssel.

agentHandoffProof

Nachweis verwendet, um den Besitzerschlüssel wiederherzustellen und die Installation zu bestätigen. Niemals an eine Datenabfrage gesendet.

agentIdentityKey

Gewöhnlicher FlashData API-Schlüssel in Authorization Bearer, nur auf Agentenidentität. Datenabfragen verwenden stattdessen X-API-Key.

System

GET/health

Service-Gesundheit

Authentifizierung: öffentlich

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

Server: http://localhost:5000/v2

Antworten

200 Gesund

200 · application/json

Health

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

Lesen Sie die Zusammenfassung des Status der öffentlichen Komponente

Authentifizierung: öffentlich

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

Server: http://localhost:5000/v2

Antworten

200 Zusammenfassung des öffentlichen Status

Kopfzeilen: Cache-Control

200 · application/json

PublicStatus

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

Authen

GET/oauth/requests/{requestId}

Lesen Sie eine App-Autorisierungsanfrage und binden Sie sie an die aktuelle Sitzung

Vollständige Sitzung erforderlich. Die Anfrage läuft nach zehn Minuten ab. Antwort ist No-Store.

Authentifizierung: cookieSession

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

Server: http://localhost:5000/v2

Parameter

requestId · path · erforderlich

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

Antworten

200 Angeforderte App Berechtigungen

200 · application/json

OAuthConsent

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

403 Authentifiziert, aber nicht erlaubt, oder CSRF-Validierung fehlgeschlagen

403 · application/problem+json

Problem

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

410 Anfrage abgelaufen, verwendet oder an eine andere Sitzung gebunden

410 · application/problem+json

Problem

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

Genehmigen oder verweigern Sie eine App-Autorisierungsanfrage

Vollständige Sitzung, CSRF und erlaubt Origin erforderlich. Verbraucht die Anfrage einmal. Antwort ist No-Store.

Authentifizierung: cookieSession + csrfToken

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

Server: http://localhost:5000/v2

Parameter

requestId · path · erforderlich

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

Antragsstellen · erforderlich

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

Antworten

200 Registrierter Kunden-Callback mit Code oder Denial, Staat und Emittent

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

403 Authentifiziert, aber nicht erlaubt, oder CSRF-Validierung fehlgeschlagen

403 · application/problem+json

Problem

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

410 Autorisierungsanfrage nicht verfügbar; Starten einer neuen Verbindung

410 · application/problem+json

Problem

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

422 Antragsvalidierung fehlgeschlagen

422 · application/problem+json

Problem

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

Erstellen Sie ein ausstehendes FlashData-Konto

Die eingereichten Nutzungsbedingungen und Datenschutzversionen müssen mit dem aktuell veröffentlichten Rechtspaket übereinstimmen.

Authentifizierung: öffentlich

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

Server: http://localhost:5000/v2

Antragsstellen · erforderlich

Schema · application/json

RegisterRequest

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

Antworten

201 Konto erstellt; E-Mail-Verifizierung erforderlich

Kopfzeilen: Cache-Control, X-Request-Id

201 · application/json

RegisterResponse

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

409 Ressourcenzustand oder Idempotenzkonflikt

409 · application/problem+json

Problem

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

422 Antragsvalidierung fehlgeschlagen

422 · application/problem+json

Problem

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

429 Rate, Parallelität, Batch oder Pending-Job-Limit überschritten

Kopfzeilen: Retry-After

429 · application/problem+json

Problem

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

500 Ein unerwarteter interner Fehler ist aufgetreten

500 · application/problem+json

Problem

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

503 Eine erforderliche Abhängigkeit oder ein Katalog ist vorübergehend nicht verfügbar

503 · application/problem+json

Problem

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

Erstellen Sie eine undurchsichtige Web-Sitzung

Setzt das Secure, HttpOnly `__Host-fd_session` Cookie. Ausstehende Konten eine eingeschränkte email_verification-Sitzung für das Verifizierungs-Dashboard erhalten. Berechtigte verifizierte Konten erhalten ihre einmaligen Testgutschriften bei der Anmeldung, wenn sie nicht bereits gewährt wurden. Ein aktives Konto eine vollständige Sitzung erhält, es sei denn, seine migrierte Identität erfordert noch eine aktuelle rechtliche Akzeptanz, in diesem Fall erhält es eine eingeschränkte legal_acceptance Sitzung. Ein Konto mit einer geplanten Löschanforderung erhält eine eingeschränkte deletion_recovery-Sitzung. Konten, deren Löschung ist processing/failed/completed und gesperrte Konten erhalten 403.

Authentifizierung: öffentlich

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

Server: http://localhost:5000/v2

Antragsstellen · erforderlich

Schema · application/json

LoginRequest

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

Antworten

200 Authentifiziert

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

200 · application/json

LoginResponse

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

403 Login ist verboten; Problem.code ist email_not_verified, account_suspended, account_deletion_processing, account_deletion_failed oder account_deleted.

403 · application/problem+json

Problem

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

422 Antragsvalidierung fehlgeschlagen

422 · application/problem+json

Problem

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

423 Konto vorübergehend gesperrt

Kopfzeilen: Retry-After

423 · application/problem+json

Problem

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

429 Rate, Parallelität, Batch oder Pending-Job-Limit überschritten

Kopfzeilen: Retry-After

429 · application/problem+json

Problem

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

Die aktuelle Sitzung abbrechen

Authentifizierung: cookieSession + csrfToken

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

Server: http://localhost:5000/v2

Antworten

204 Sitzung widerrufen und Cookie gelöscht

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

403 Authentifiziert, aber nicht erlaubt, oder CSRF-Validierung fehlgeschlagen

403 · application/problem+json

Problem

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

Lesen Sie das aktuelle Konto und den Benutzer

Authentifizierung: cookieSession

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

Server: http://localhost:5000/v2

Antworten

200 Leistungsbilanz

Kopfzeilen: Cache-Control, X-Request-Id

200 · application/json

Account

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

Holen Sie sich das CSRF-Token an die aktuelle Sitzung gebunden

Authentifizierung: cookieSession

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

Server: http://localhost:5000/v2

Antworten

200 CSRF

Kopfzeilen: Cache-Control, X-Request-Id

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

Anfordern oder erneutes Senden einer E-Mail-Verifizierungsnachricht

Gibt für jede syntaktisch gültige E-Mail die gleiche Antwort zurück, unabhängig davon, ob das Konto fehlt, anhängig, aktiv, gesperrt oder gelöscht ist. Berechtigte Pending-Konten erhalten einen gedrehten einmaligen Link nach dem erneuten Abklingen.

Authentifizierung: öffentlich

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

Server: http://localhost:5000/v2

Antragsstellen · erforderlich

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

Antworten

202 Antrag angenommen. Die Antwort verrät nicht, ob ein Konto existiert.

Kopfzeilen: Cache-Control, X-Request-Id

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

422 Validierung der anonymen Authentifizierungsanforderung fehlgeschlagen

Kopfzeilen: Cache-Control, X-Request-Id

422 · application/problem+json

Problem

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

429 Anonyme Authentifizierungsrate überschritten

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

429 · application/problem+json

Problem

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

500 Unerwarteter anonymer Authentifizierungsfehler

Kopfzeilen: Cache-Control, X-Request-Id

500 · application/problem+json

Problem

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

503 Eine anonyme Authentifizierungsabhängigkeit ist vorübergehend nicht verfügbar

Kopfzeilen: Cache-Control, X-Request-Id

503 · application/problem+json

Problem

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

Überprüfen Sie eine E-Mail und aktivieren Sie das Konto

Atomisch verbraucht das Einmal-Token und aktiviert das Konto und den Benutzer. Es gelten bestehende Konto- und Trial-Credit-Regeln. Ohne eine Anmeldesitzung meldet sich der Benutzer explizit an. Eine zulässige Ursprungsanfrage, die die passende Anmeldesitzung und ihre X-CSRF-Token enthält, kann ein gedrehtes Sitzungscookie für dasselbe verifizierte Konto erhalten; ein Verifizierungstoken allein wird sich niemals bei einem Benutzer anmelden.

Authentifizierung: öffentlich

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

Server: http://localhost:5000/v2

Antragsstellen · erforderlich

Schema · application/json

TokenRequest

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

Antworten

200 Konto aktiviert

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

200 · application/json

Account

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

410 Einmal-Token ist ungültig, abgelaufen, ungültig gemacht, bereits verwendet oder hat ein gleichzeitiges Bestätigungsrennen verloren. Problem.code ist `token_unavailable`.

Kopfzeilen: Cache-Control, X-Request-Id

410 · application/problem+json

Problem

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

422 Validierung der anonymen Authentifizierungsanforderung fehlgeschlagen

Kopfzeilen: Cache-Control, X-Request-Id

422 · application/problem+json

Problem

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

429 Anonyme Authentifizierungsrate überschritten

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

429 · application/problem+json

Problem

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

500 Unerwarteter anonymer Authentifizierungsfehler

Kopfzeilen: Cache-Control, X-Request-Id

500 · application/problem+json

Problem

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

503 Eine anonyme Authentifizierungsabhängigkeit ist vorübergehend nicht verfügbar

Kopfzeilen: Cache-Control, X-Request-Id

503 · application/problem+json

Problem

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

Setzen Sie die ursprüngliche Anmeldesitzung nach der E-Mail-Verifizierung fort

Erfordert einen zulässigen Ursprung und das CSRF-Token, das an eine Live-Passwort-authentifizierungssitzung gebunden ist. Retouren, die bis zur Überprüfung des eigenen Kontos dieser Sitzung anhängig sind, einschließlich der Überprüfung in einem anderen Browser. Atomically widerruft die Anmeldesitzung und gibt eine neue Voll- oder Rechtsakzeptanzsitzung aus. Akzeptiert kein Konto ID, E-Mail, Passwort oder Verifizierungstoken, umgeht die rechtliche Akzeptanz oder gewährt Credits.

Authentifizierung: cookieSession + csrfToken

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

Server: http://localhost:5000/v2

Antragsstellen · erforderlich

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

Antworten

200 Anmeldesitzung rotiert

Kopfzeilen: Set-Cookie, Cache-Control

200 · application/json

LoginResponse

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

202 E-Mail-Verifizierung steht aus; keine neue Sitzung

Kopfzeilen: Cache-Control

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

403 Authentifiziert, aber nicht erlaubt, oder CSRF-Validierung fehlgeschlagen

403 · application/problem+json

Problem

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

422 Antragsvalidierung fehlgeschlagen

422 · application/problem+json

Problem

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

500 Ein unerwarteter interner Fehler ist aufgetreten

500 · application/problem+json

Problem

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

Fordern Sie eine Passwort-Reset-E-Mail an

Gibt immer die gleiche 202-Antwort für eine syntaktisch gültige E-Mail zurück, unabhängig von der Existenz des Kontos oder des Lebenszyklusstatus. Nur berechtigte aktive oder gesperrte Identitäten erhalten Mail.

Authentifizierung: öffentlich

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

Server: http://localhost:5000/v2

Antragsstellen · erforderlich

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

Antworten

202 Antrag angenommen. Die Antwort verrät nicht, ob ein Konto existiert.

Kopfzeilen: Cache-Control, X-Request-Id

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

422 Validierung der anonymen Authentifizierungsanforderung fehlgeschlagen

Kopfzeilen: Cache-Control, X-Request-Id

422 · application/problem+json

Problem

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

429 Anonyme Authentifizierungsrate überschritten

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

429 · application/problem+json

Problem

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

500 Unerwarteter anonymer Authentifizierungsfehler

Kopfzeilen: Cache-Control, X-Request-Id

500 · application/problem+json

Problem

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

503 Eine anonyme Authentifizierungsabhängigkeit ist vorübergehend nicht verfügbar

Kopfzeilen: Cache-Control, X-Request-Id

503 · application/problem+json

Problem

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

Legen Sie ein neues Passwort fest und widerrufen Sie bestehende Sitzungen

Atomically verbraucht das Passwort-Reset-Token, speichert einen neuen Argon2id-Anmeldenachweis, widerruft jede bestehende Sitzung und ungültig macht andere Passwort-Reset-Token. Es protokolliert den benutzer nicht oder erstellt eine sitzung.

Authentifizierung: öffentlich

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

Server: http://localhost:5000/v2

Antragsstellen · erforderlich

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

Antworten

204 Passwort aktualisiert; bestehende Sitzungen widerrufen

Kopfzeilen: Cache-Control, X-Request-Id

410 Einmal-Token ist ungültig, abgelaufen, ungültig gemacht, bereits verwendet oder hat ein gleichzeitiges Bestätigungsrennen verloren. Problem.code ist `token_unavailable`.

Kopfzeilen: Cache-Control, X-Request-Id

410 · application/problem+json

Problem

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

422 Validierung der anonymen Authentifizierungsanforderung fehlgeschlagen

Kopfzeilen: Cache-Control, X-Request-Id

422 · application/problem+json

Problem

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

429 Anonyme Authentifizierungsrate überschritten

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

429 · application/problem+json

Problem

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

500 Unerwarteter anonymer Authentifizierungsfehler

Kopfzeilen: Cache-Control, X-Request-Id

500 · application/problem+json

Problem

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

503 Eine anonyme Authentifizierungsabhängigkeit ist vorübergehend nicht verfügbar

Kopfzeilen: Cache-Control, X-Request-Id

503 · application/problem+json

Problem

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

Aktive Sitzungen für den aktuellen Benutzer auflisten

Authentifizierung: cookieSession

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

Server: http://localhost:5000/v2

Antworten

200 Sitzungen

Kopfzeilen: Cache-Control, X-Request-Id

200 · application/json

Session

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

Alle Sitzungen außer der aktuellen abbrechen

Authentifizierung: cookieSession + csrfToken

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

Server: http://localhost:5000/v2

Antworten

204 Andere Sitzungen widerrufen

Kopfzeilen: Cache-Control, X-Request-Id

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

403 Authentifiziert, aber nicht erlaubt, oder CSRF-Validierung fehlgeschlagen

403 · application/problem+json

Problem

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

Eine Sitzung abbrechen

Authentifizierung: cookieSession + csrfToken

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

Server: http://localhost:5000/v2

Parameter

sessionId · path · erforderlich

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

Antworten

204 Sitzung widerrufen. War es die aktuelle Session, wird das Cookie gelöscht.

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

403 Authentifiziert, aber nicht erlaubt, oder CSRF-Validierung fehlgeschlagen

403 · application/problem+json

Problem

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

404 Ressource nicht gefunden oder nicht im besitz des anrufers.

404 · application/problem+json

Problem

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

409 Ressourcenzustand oder Idempotenzkonflikt

409 · application/problem+json

Problem

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

422 Antragsvalidierung fehlgeschlagen

422 · application/problem+json

Problem

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

503 Eine erforderliche Abhängigkeit oder ein Katalog ist vorübergehend nicht verfügbar

503 · application/problem+json

Problem

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

Überprüfen Sie das aktuelle Passwort für eine sensible Operation

Zeichnet einen kurzlebigen, aktuellen Beweis auf der aktuellen serverseitigen Sitzung auf.

Authentifizierung: cookieSession + csrfToken

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

Server: http://localhost:5000/v2

Antragsstellen · erforderlich

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

Antworten

200 Sitzung hat kürzlich Authentifizierung

Kopfzeilen: Cache-Control, X-Request-Id

200 · application/json

Reauthentication

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

403 Authentifiziert, aber nicht erlaubt, oder CSRF-Validierung fehlgeschlagen

403 · application/problem+json

Problem

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

429 Rate, Parallelität, Batch oder Pending-Job-Limit überschritten

Kopfzeilen: Retry-After

429 · application/problem+json

Problem

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

Ändern Sie das Passwort und drehen Sie die aktuelle Sitzung

Authentifizierung: cookieSession + csrfToken

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

Server: http://localhost:5000/v2

Antragsstellen · erforderlich

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
    }
  }
}

Antworten

204 Passwort geändert; aktuelle Sitzung wurde gedreht und andere Sitzungen wurden widerrufen, wenn sie angefordert wurden

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

403 Authentifiziert, aber nicht erlaubt, oder CSRF-Validierung fehlgeschlagen

403 · application/problem+json

Problem

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

422 Antragsvalidierung fehlgeschlagen

422 · application/problem+json

Problem

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

Konto

GET/oauth/connections

Listen Sie die verbundenen Apps des Girokontos auf

Vollständige Sitzung erforderlich. Leer, wenn das Konto keine verbundenen Apps hat. Antwort ist No-Store.

Authentifizierung: cookieSession

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

Server: http://localhost:5000/v2

Antworten

200 Connected apps

200 · application/json

OAuthConnection

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

403 Authentifiziert, aber nicht erlaubt, oder CSRF-Validierung fehlgeschlagen

403 · application/problem+json

Problem

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

Widerruf einer verbundenen App und ihres dedizierten API-Schlüssels

Vollständige Sitzung, CSRF und erlaubt Origin erforderlich. Account Ownership wird durchgesetzt. Antwort ist No-Store.

Authentifizierung: cookieSession + csrfToken

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

Server: http://localhost:5000/v2

Parameter

grantId · path · erforderlich

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

Antworten

204 Genehmigung widerrufen

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

403 Authentifiziert, aber nicht erlaubt, oder CSRF-Validierung fehlgeschlagen

403 · application/problem+json

Problem

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

404 Ressource nicht gefunden oder nicht im besitz des anrufers.

404 · application/problem+json

Problem

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

Lesen Sie die Kontoeinstellungen

Authentifizierung: cookieSession

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

Server: http://localhost:5000/v2

Antworten

200 Konto

200 · application/json

Account

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

Profileinstellungen aktualisieren

Authentifizierung: cookieSession + csrfToken

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

Server: http://localhost:5000/v2

Antragsstellen · erforderlich

Schema · application/json

UpdateAccountRequest

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

Antworten

200 Aktualisiertes Konto

200 · application/json

Account

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

403 Authentifiziert, aber nicht erlaubt, oder CSRF-Validierung fehlgeschlagen

403 · application/problem+json

Problem

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

422 Antragsvalidierung fehlgeschlagen

422 · application/problem+json

Problem

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

Planen Sie die Löschung des Kontos und widerrufen Sie alle bestehenden Sitzungen und API Keys

Administratorkonten müssen ihre Plattformrolle durch den geprüften Operator-Workflow widerrufen haben, bevor die Löschung geplant werden kann. Eine eindeutige aktive Löschanforderung ist die natürliche Idempotenzgrenze. Gleichzeitige authentifizierte Zeitpläne geben die gleiche Anforderung zurück. Nach dem Widerruf der Sitzung wird eine verlorene Antwort wiederhergestellt, indem man sich im deletion_recovery-Modus anmeldet und GET /account/deletion liest; widerrufene Sitzungen werden niemals zur Wiederholung akzeptiert.

Authentifizierung: cookieSession + csrfToken

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

Server: http://localhost:5000/v2

Antragsstellen · erforderlich

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

Antworten

202 Löschung geplant; aktive Sitzungen und Schlüssel widerrufen

202 · application/json

AccountDeletionRequest

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

403 Authentifiziert, aber nicht erlaubt, oder CSRF-Validierung fehlgeschlagen

403 · application/problem+json

Problem

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

409 Ressourcenzustand oder Idempotenzkonflikt

409 · application/problem+json

Problem

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

422 Antragsvalidierung fehlgeschlagen

422 · application/problem+json

Problem

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

Lesen Sie den Antrag auf Löschung des aktuellen Kontos

Authentifizierung: cookieSession

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

Server: http://localhost:5000/v2

Antworten

200 Aktueller Löschantrag

200 · application/json

AccountDeletionRequest

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

404 Ressource nicht gefunden oder nicht im besitz des anrufers.

404 · application/problem+json

Problem

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

Stornieren Sie eine geplante Löschung während der Nachfrist

Verwendet einen planmäßigen bis stornierten Vergleich und Satz. Ein Prozessorrennen gibt 409 zurück; nach dem Erfolg wird die Wiederherstellungssitzung gedreht und kann den alten Übergang nicht wiederholen.

Authentifizierung: cookieSession + csrfToken

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

Server: http://localhost:5000/v2

Antworten

204 Löschung storniert, Konto reaktiviert und Wiederherstellungssitzung gemäß dem Legal-Akzeptanz-Gate gedreht

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

403 Authentifiziert, aber nicht erlaubt, oder CSRF-Validierung fehlgeschlagen

403 · application/problem+json

Problem

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

404 Ressource nicht gefunden oder nicht im besitz des anrufers.

404 · application/problem+json

Problem

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

409 Ressourcenzustand oder Idempotenzkonflikt

409 · application/problem+json

Problem

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

Accept die derzeit veröffentlichten Allgemeinen Geschäftsbedingungen und Datenschutzversionen

Hängt eine unveränderliche rechtliche Akzeptanz an, löscht das Migrationsgate und dreht die Sitzung. Stale eingereichte Versionen werden abgelehnt.

Authentifizierung: cookieSession + csrfToken

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

Server: http://localhost:5000/v2

Antragsstellen · erforderlich

Schema · application/json

LegalAcceptanceRequest

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

Antworten

200 Legale Akzeptanz aufgezeichnet und Session in den vollen Modus gedreht

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

200 · application/json

LoginResponse

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

403 Authentifiziert, aber nicht erlaubt, oder CSRF-Validierung fehlgeschlagen

403 · application/problem+json

Problem

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

404 Ressource nicht gefunden oder nicht im besitz des anrufers.

404 · application/problem+json

Problem

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

422 Antragsvalidierung fehlgeschlagen

422 · application/problem+json

Problem

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

Onboarding

GET/onboarding

Read Resumable Onboarding Fortschritte

Authentifizierung: cookieSession

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

Server: http://localhost:5000/v2

Antworten

200 Aktueller Onboarding-Zustand

Kopfzeilen: Cache-Control, X-Request-Id

200 · application/json

OnboardingProgress

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

401 Authentifizierung erforderlich oder ungültig

Kopfzeilen: Cache-Control, X-Request-Id

401 · application/problem+json

Problem

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

500 Ein unerwarteter interner Fehler ist aufgetreten

Kopfzeilen: Cache-Control, X-Request-Id

500 · application/problem+json

Problem

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

503 Eine erforderliche Abhängigkeit oder Onboarding-Aufzeichnung ist vorübergehend nicht verfügbar

Kopfzeilen: Cache-Control, X-Request-Id

503 · application/problem+json

Problem

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

Onboarding voranbringen, ohne den Fortschritt rückwärts bewegen zu lassen

Authentifizierung: cookieSession + csrfToken

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

Server: http://localhost:5000/v2

Antragsstellen · erforderlich

Schema · application/json

UpdateOnboardingRequest

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

Antworten

200 Aktualisierter Onboarding-Zustand

Kopfzeilen: Cache-Control, X-Request-Id

200 · application/json

OnboardingProgress

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

401 Authentifizierung erforderlich oder ungültig

Kopfzeilen: Cache-Control, X-Request-Id

401 · application/problem+json

Problem

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

403 Authentifiziert, aber nicht erlaubt, oder CSRF-Validierung fehlgeschlagen

Kopfzeilen: Cache-Control, X-Request-Id

403 · application/problem+json

Problem

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

409 Ressourcenzustand oder Idempotenzkonflikt

Kopfzeilen: Cache-Control, X-Request-Id

409 · application/problem+json

Problem

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

422 Antragsvalidierung fehlgeschlagen

Kopfzeilen: Cache-Control, X-Request-Id

422 · application/problem+json

Problem

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

500 Ein unerwarteter interner Fehler ist aufgetreten

Kopfzeilen: Cache-Control, X-Request-Id

500 · application/problem+json

Problem

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

503 Eine erforderliche Abhängigkeit oder Onboarding-Aufzeichnung ist vorübergehend nicht verfügbar

Kopfzeilen: Cache-Control, X-Request-Id

503 · application/problem+json

Problem

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

Übersicht

GET/overview

Lesen Sie das Account Dashboard Aggregat

Authentifizierung: cookieSession

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

Server: http://localhost:5000/v2

Antworten

200 Übersicht über den Umfang der Konten

Kopfzeilen: Cache-Control, X-Request-Id

200 · application/json

ConsoleOverview

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

401 Authentifizierung erforderlich oder ungültig

Kopfzeilen: Cache-Control, X-Request-Id

401 · application/problem+json

Problem

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

500 Ein unerwarteter interner Fehler ist aufgetreten

Kopfzeilen: Cache-Control, X-Request-Id

500 · application/problem+json

Problem

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

503 Eine erforderliche Abhängigkeit oder Onboarding-Aufzeichnung ist vorübergehend nicht verfügbar

Kopfzeilen: Cache-Control, X-Request-Id

503 · application/problem+json

Problem

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

API Keys

GET/api-access/identity

Überprüfen Sie den aktuellen API Schlüsselbesitz und die wiederkehrende Bereitschaft

Kostenlose Header-only API-Schlüssel gelesen. Gibt öffentliche account/key IDs und autoritatives Eigentum zurück. Keine beantragende Stelle. Ändert nicht die bestehende /api-access Metadatenantwort. Teilen Sie das 120/minute Konto-Leselimit. Fail geschlossen auf Nichtverfügbarkeit; schließen Sie nicht das Eigentum von Schlüsselpräfix, Plan oder lokalen Staat. Es werden keine Abfrageparameter akzeptiert. Antworten sind No-Store.

Authentifizierung: dataApiKey

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

Server: http://localhost:5000/v2

Antworten

200 Überprüfen Sie den aktuellen API Schlüsselbesitz und die wiederkehrende Bereitschaft

200 · application/json

APIKeyIdentity

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

400 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

400 · application/problem+json

Problem

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

401 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

401 · application/problem+json

Problem

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

403 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

403 · application/problem+json

Problem

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

409 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

409 · application/problem+json

Problem

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

410 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

410 · application/problem+json

Problem

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

422 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

422 · application/problem+json

Problem

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

429 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

429 · application/problem+json

Problem

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

503 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

503 · application/problem+json

Problem

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

Liste API Key Metadaten

Authentifizierung: cookieSession

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

Server: http://localhost:5000/v2

Antworten

200 API Keys ohne Geheimnisse

200 · application/json

ApiKey

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

Erstellen Sie einen API-Schlüssel und enthüllen Sie sein Geheimnis einmal

Authentifizierung: cookieSession + csrfToken

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

Server: http://localhost:5000/v2

Parameter

Idempotency-Key · header · erforderlich

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

Antragsstellen · erforderlich

Schema · application/json

CreateApiKeyRequest

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

Antworten

201 Erstellt; die gleiche idempotente Wiederholung kann die gleiche verschlüsselte Antwort für fünf Minuten zurückgeben

201 · application/json

ApiKeyCreated

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

403 Authentifiziert, aber nicht erlaubt, oder CSRF-Validierung fehlgeschlagen

403 · application/problem+json

Problem

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

409 Ressourcenzustand oder Idempotenzkonflikt

409 · application/problem+json

Problem

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

422 Antragsvalidierung fehlgeschlagen

422 · application/problem+json

Problem

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

503 Eine erforderliche Abhängigkeit oder ein Katalog ist vorübergehend nicht verfügbar

503 · application/problem+json

Problem

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

Einen API Key widerrufen

Authentifizierung: cookieSession + csrfToken

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

Server: http://localhost:5000/v2

Parameter

keyId · path · erforderlich

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

Antworten

204 widerrufen

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

403 Authentifiziert, aber nicht erlaubt, oder CSRF-Validierung fehlgeschlagen

403 · application/problem+json

Problem

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

404 Ressource nicht gefunden oder nicht im besitz des anrufers.

404 · application/problem+json

Problem

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

503 Eine erforderliche Abhängigkeit oder ein Katalog ist vorübergehend nicht verfügbar

503 · application/problem+json

Problem

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

Erstellen Sie einen Ersatzschlüssel und planen Sie den Widerruf des alten Schlüssels

Erstellt einen neuen Schlüssel und hält den alten Schlüssel aktiv, bis revokeOldAt. Standardmäßig dauert die Überlappung 24 Stunden oder bis der alte Schlüssel abläuft, je nachdem, was früher ist. Ein benutzerdefiniertes revokeOldAt muss in der Zukunft innerhalb von sieben Tagen und nicht später als der alte Schlüsselablauf sein.

Authentifizierung: cookieSession + csrfToken

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

Server: http://localhost:5000/v2

Parameter

keyId · path · erforderlich

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

Idempotency-Key · header · erforderlich

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

Antragsstellen · fakultativ

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."
    }
  }
}

Antworten

201 Ersatz geschaffen; Geheimnis einmal zurückgegeben

201 · application/json

ApiKeyCreated

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

403 Authentifiziert, aber nicht erlaubt, oder CSRF-Validierung fehlgeschlagen

403 · application/problem+json

Problem

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

404 Ressource nicht gefunden oder nicht im besitz des anrufers.

404 · application/problem+json

Problem

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

409 Ressourcenzustand oder Idempotenzkonflikt

409 · application/problem+json

Problem

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

422 Antragsvalidierung fehlgeschlagen

422 · application/problem+json

Problem

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

503 Eine erforderliche Abhängigkeit oder ein Katalog ist vorübergehend nicht verfügbar

503 · application/problem+json

Problem

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

Lesen Sie den aufrufenden API-Schlüssel autorisierte Quellen und Ergebnis Herkunft

Kostenlose Header-Only-X-API-Key-Authentifizierung. Nur gewährte Renditen öffentlich Source-Namen und konfigurierter signierter Ergebnisspeicher-Ursprung (null wenn) nicht verfügbar. Es werden kein Konto ID, Schlüssel ID, geheime oder Speicherdaten zurückgegeben. Local MCP revalidiert diesen Endpunkt vor jeder Werkzeugerkennung und jedem Aufruf, Einschließlich der zwischengespeicherten Ergebnislesungen. Es werden keine Abfrageparameter oder Request Body akzeptiert. Alle /api-access Routen teilen 120 Anfragen pro Minute pro Client-IP und Rückgabe Cache-Control privat, No-store. Das normale, zuletzt verwendete Schlüssel-Tracking findet weiterhin statt.

Authentifizierung: dataApiKey

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

Server: http://localhost:5000/v2

Antworten

200 Zugelassene öffentliche Quellen und Herkunft des Ergebnisses

200 · application/json

ApiAccess

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

422 Antragsvalidierung fehlgeschlagen

422 · application/problem+json

Problem

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

429 Zu viele Accounts lesen; versuchen Sie es erneut nach dem Zeitlimitfenster

503 Eine erforderliche Abhängigkeit oder ein Katalog ist vorübergehend nicht verfügbar

503 · application/problem+json

Problem

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

Agentenverbindungen

GET/agent-connections/capabilities

Verfügbarkeit des Protokolls 2 Onboarding

Es werden keine Abfrageparameter akzeptiert. Antworten sind No-Store. Agentenrouten sind nur für die Verwaltung und Feature-Gated; Bereitstellungen können 404 zurückgeben, wenn sie deaktiviert sind. X-API-Key ist auf Agentenrouten verboten.

Authentifizierung: öffentlich

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

Server: http://localhost:5000/v2

Antworten

200 Verfügbarkeit des Protokolls 2 Onboarding

200 · application/json

AgentCapabilities

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

400 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

400 · application/problem+json

Problem

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

401 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

401 · application/problem+json

Problem

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

403 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

403 · application/problem+json

Problem

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

409 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

409 · application/problem+json

Problem

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

410 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

410 · application/problem+json

Problem

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

422 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

422 · application/problem+json

Problem

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

429 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

429 · application/problem+json

Problem

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

503 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

503 · application/problem+json

Problem

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

Erstellen oder Wiederherstellen einer temporären API-Schlüsselverbindung

Beharren Sie auf dem Registrierungsnachweis und der genauen Eingabe vor POST. Derselbe Beweis und derselbe Körper erholen die gleiche Studie; wechselnde Eingaben ergeben Konflikte. Temporäre Testversion: 1 Credit, 72 Stunden, 1 request/second, Chargengröße 1. Source scope limits bleiben auf dem server autoritativ. Es werden keine Abfrageparameter akzeptiert. Antworten sind No-Store. Agentenrouten sind nur für die Verwaltung und Feature-Gated; Bereitstellungen können 404 zurückgeben, wenn sie deaktiviert sind. X-API-Key ist auf Agentenrouten verboten.

Authentifizierung: agentRegistrationProof

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

Server: http://localhost:5000/v2

Antragsstellen · erforderlich

Schema · application/json

AgentRegistrationRequest

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

Antworten

201 Erstellen oder Wiederherstellen einer temporären API-Schlüsselverbindung

201 · application/json

AgentRegistration

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

400 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

400 · application/problem+json

Problem

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

401 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

401 · application/problem+json

Problem

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

403 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

403 · application/problem+json

Problem

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

409 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

409 · application/problem+json

Problem

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

410 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

410 · application/problem+json

Problem

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

422 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

422 · application/problem+json

Problem

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

429 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

429 · application/problem+json

Problem

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

503 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

503 · application/problem+json

Problem

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

Browsereigene Verbindungen auflisten

Es werden keine Abfrageparameter akzeptiert. Antworten sind No-Store. Agentenrouten sind nur für die Verwaltung und Feature-Gated; Bereitstellungen können 404 zurückgeben, wenn sie deaktiviert sind. X-API-Key ist auf Agentenrouten verboten. Browser-eigener Betrieb. Vollständig verifizierte Sitzung erforderlich; Anrufer dürfen keinen API-Schlüssel oder Proof ersetzen.

Authentifizierung: cookieSession

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

Server: http://localhost:5000/v2

Antworten

200 Browsereigene Verbindungen auflisten

200 · application/json

AgentConnection

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

400 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

400 · application/problem+json

Problem

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

401 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

401 · application/problem+json

Problem

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

403 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

403 · application/problem+json

Problem

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

409 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

409 · application/problem+json

Problem

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

410 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

410 · application/problem+json

Problem

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

422 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

422 · application/problem+json

Problem

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

429 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

429 · application/problem+json

Problem

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

503 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

503 · application/problem+json

Problem

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

Lesen Sie den temporären Verbindungsstatus

Es werden keine Abfrageparameter akzeptiert. Antworten sind No-Store. Agentenrouten sind nur für die Verwaltung und Feature-Gated; Bereitstellungen können 404 zurückgeben, wenn sie deaktiviert sind. X-API-Key ist auf Agentenrouten verboten.

Authentifizierung: agentSetupCredential

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

Server: http://localhost:5000/v2

Parameter

connectionId · path · erforderlich

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

Antworten

200 Lesen Sie den temporären Verbindungsstatus

200 · application/json

AgentConnectionResponse

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

400 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

400 · application/problem+json

Problem

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

401 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

401 · application/problem+json

Problem

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

403 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

403 · application/problem+json

Problem

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

409 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

409 · application/problem+json

Problem

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

410 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

410 · application/problem+json

Problem

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

422 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

422 · application/problem+json

Problem

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

429 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

429 · application/problem+json

Problem

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

503 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

503 · application/problem+json

Problem

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

Eine Owned Connection widerrufen

Es werden keine Abfrageparameter akzeptiert. Antworten sind No-Store. Agentenrouten sind nur für die Verwaltung und Feature-Gated; Bereitstellungen können 404 zurückgeben, wenn sie deaktiviert sind. X-API-Key ist auf Agentenrouten verboten. Browser-eigener Betrieb. Vollständig verifizierte Sitzung erforderlich; Anrufer dürfen keinen API-Schlüssel oder Proof ersetzen.

Authentifizierung: cookieSession + csrfToken

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

Server: http://localhost:5000/v2

Parameter

connectionId · path · erforderlich

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

Origin · header · erforderlich

Schema
Schema
{
  "type": "string"
}

X-CSRF-Token · header · erforderlich

Schema
Schema
{
  "type": "string"
}

Antworten

204 Eine Owned Connection widerrufen

400 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

400 · application/problem+json

Problem

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

401 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

401 · application/problem+json

Problem

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

403 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

403 · application/problem+json

Problem

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

409 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

409 · application/problem+json

Problem

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

410 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

410 · application/problem+json

Problem

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

422 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

422 · application/problem+json

Problem

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

429 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

429 · application/problem+json

Problem

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

503 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

503 · application/problem+json

Problem

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

Überprüfen Sie die aktuellen Daten API Schlüssel für eine Verbindung

Es werden keine Abfrageparameter akzeptiert. Antworten sind No-Store. Agentenrouten sind nur für die Verwaltung und Feature-Gated; Bereitstellungen können 404 zurückgeben, wenn sie deaktiviert sind. X-API-Key ist auf Agentenrouten verboten.

Authentifizierung: agentIdentityKey

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

Server: http://localhost:5000/v2

Parameter

connectionId · path · erforderlich

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

Antworten

200 Überprüfen Sie die aktuellen Daten API Schlüssel für eine Verbindung

200 · application/json

AgentConnectionResponse

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

400 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

400 · application/problem+json

Problem

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

401 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

401 · application/problem+json

Problem

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

403 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

403 · application/problem+json

Problem

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

409 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

409 · application/problem+json

Problem

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

410 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

410 · application/problem+json

Problem

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

422 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

422 · application/problem+json

Problem

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

429 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

429 · application/problem+json

Problem

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

503 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

503 · application/problem+json

Problem

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

Read Recoveryable Onboarding Zustand

Es werden keine Abfrageparameter akzeptiert. Antworten sind No-Store. Agentenrouten sind nur für die Verwaltung und Feature-Gated; Bereitstellungen können 404 zurückgeben, wenn sie deaktiviert sind. X-API-Key ist auf Agentenrouten verboten.

Authentifizierung: agentHandoffProof

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

Server: http://localhost:5000/v2

Parameter

connectionId · path · erforderlich

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

Antworten

200 Read Recoveryable Onboarding Zustand

200 · application/json

AgentOnboardingStatus

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

400 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

400 · application/problem+json

Problem

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

401 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

401 · application/problem+json

Problem

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

403 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

403 · application/problem+json

Problem

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

409 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

409 · application/problem+json

Problem

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

410 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

410 · application/problem+json

Problem

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

422 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

422 · application/problem+json

Problem

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

429 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

429 · application/problem+json

Problem

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

503 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

503 · application/problem+json

Problem

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

Erstellen eines Browser-Genehmigungsanspruchs

Öffnen Sie claimPath auf einem vertrauenswürdigen FlashData Web-Ursprung und zeigen Sie den Code separat an. Platzieren Sie niemals Anmeldeinformationen oder den Bestätigungscode in URL. Es werden keine Abfrageparameter akzeptiert. Antworten sind No-Store. Agentenrouten sind nur für die Verwaltung und Feature-Gated; Bereitstellungen können 404 zurückgeben, wenn sie deaktiviert sind. X-API-Key ist auf Agentenrouten verboten.

Authentifizierung: agentSetupCredential

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

Server: http://localhost:5000/v2

Parameter

connectionId · path · erforderlich

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

Antragsstellen · erforderlich

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

Antworten

201 Erstellen eines Browser-Genehmigungsanspruchs

201 · application/json

AgentClaim

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

400 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

400 · application/problem+json

Problem

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

401 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

401 · application/problem+json

Problem

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

403 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

403 · application/problem+json

Problem

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

409 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

409 · application/problem+json

Problem

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

410 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

410 · application/problem+json

Problem

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

422 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

422 · application/problem+json

Problem

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

429 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

429 · application/problem+json

Problem

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

503 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

503 · application/problem+json

Problem

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

Bestätigen Sie den Anspruchscode in einer verifizierten Browsersitzung

Es werden keine Abfrageparameter akzeptiert. Antworten sind No-Store. Agentenrouten sind nur für die Verwaltung und Feature-Gated; Bereitstellungen können 404 zurückgeben, wenn sie deaktiviert sind. X-API-Key ist auf Agentenrouten verboten. Browser-eigener Betrieb. Vollständig verifizierte Sitzung erforderlich; Anrufer dürfen keinen API-Schlüssel oder Proof ersetzen.

Authentifizierung: cookieSession + csrfToken

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

Server: http://localhost:5000/v2

Parameter

claimId · path · erforderlich

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

Origin · header · erforderlich

Schema
Schema
{
  "type": "string"
}

X-CSRF-Token · header · erforderlich

Schema
Schema
{
  "type": "string"
}

Antragsstellen · erforderlich

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

Antworten

200 Bestätigen Sie den Anspruchscode in einer verifizierten Browsersitzung

200 · application/json

AgentBrowserClaim

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

400 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

400 · application/problem+json

Problem

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

401 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

401 · application/problem+json

Problem

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

403 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

403 · application/problem+json

Problem

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

409 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

409 · application/problem+json

Problem

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

410 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

410 · application/problem+json

Problem

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

422 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

422 · application/problem+json

Problem

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

429 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

429 · application/problem+json

Problem

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

503 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

503 · application/problem+json

Problem

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

Lesen Sie einen bestätigten Anspruch in seiner Browsersitzung

Es werden keine Abfrageparameter akzeptiert. Antworten sind No-Store. Agentenrouten sind nur für die Verwaltung und Feature-Gated; Bereitstellungen können 404 zurückgeben, wenn sie deaktiviert sind. X-API-Key ist auf Agentenrouten verboten. Browser-eigener Betrieb. Vollständig verifizierte Sitzung erforderlich; Anrufer dürfen keinen API-Schlüssel oder Proof ersetzen.

Authentifizierung: cookieSession

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

Server: http://localhost:5000/v2

Parameter

claimId · path · erforderlich

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

Antworten

200 Lesen Sie einen bestätigten Anspruch in seiner Browsersitzung

200 · application/json

AgentClaimView

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

400 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

400 · application/problem+json

Problem

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

401 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

401 · application/problem+json

Problem

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

403 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

403 · application/problem+json

Problem

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

409 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

409 · application/problem+json

Problem

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

410 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

410 · application/problem+json

Problem

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

422 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

422 · application/problem+json

Problem

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

429 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

429 · application/problem+json

Problem

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

503 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

503 · application/problem+json

Problem

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

Genehmigung von reduzierten Umfangen und Kontostandsfinanzierungen

Es werden keine Abfrageparameter akzeptiert. Antworten sind No-Store. Agentenrouten sind nur für die Verwaltung und Feature-Gated; Bereitstellungen können 404 zurückgeben, wenn sie deaktiviert sind. X-API-Key ist auf Agentenrouten verboten. Browser-eigener Betrieb. Vollständig verifizierte Sitzung erforderlich; Anrufer dürfen keinen API-Schlüssel oder Proof ersetzen.

Authentifizierung: cookieSession + csrfToken

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

Server: http://localhost:5000/v2

Parameter

claimId · path · erforderlich

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

Origin · header · erforderlich

Schema
Schema
{
  "type": "string"
}

X-CSRF-Token · header · erforderlich

Schema
Schema
{
  "type": "string"
}

Antragsstellen · erforderlich

Schema · application/json

AgentApproval

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

Antworten

200 Genehmigung von reduzierten Umfangen und Kontostandsfinanzierungen

200 · application/json

AgentConnection

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 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

400 · application/problem+json

Problem

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

401 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

401 · application/problem+json

Problem

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

403 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

403 · application/problem+json

Problem

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

409 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

409 · application/problem+json

Problem

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

410 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

410 · application/problem+json

Problem

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

422 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

422 · application/problem+json

Problem

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

429 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

429 · application/problem+json

Problem

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

503 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

503 · application/problem+json

Problem

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

Wiederherstellen des genehmigten Besitzers API Schlüssel

Der Kandidatenschlüssel läuft in 24 Stunden bis zur Installation ACK ab. Beharren Sie atomar, laden Sie in einem neuen Prozess nach und überprüfen Sie die Identität vor ACK. Eine wiederholte Lieferung stellt den gleichen Kandidaten wieder her; bestätigte Lieferung gibt eine Quittung ohne Anmeldeinformationen zurück. Es werden keine Abfrageparameter akzeptiert. Antworten sind No-Store. Agentenrouten sind nur für die Verwaltung und Feature-Gated; Bereitstellungen können 404 zurückgeben, wenn sie deaktiviert sind. X-API-Key ist auf Agentenrouten verboten.

Authentifizierung: agentHandoffProof

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

Server: http://localhost:5000/v2

Parameter

connectionId · path · erforderlich

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

Antragsstellen · erforderlich

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

Antworten

200 Wiederherstellen des genehmigten Besitzers API Schlüssel

200 · application/json

AgentHandoff

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

400 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

400 · application/problem+json

Problem

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

401 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

401 · application/problem+json

Problem

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

403 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

403 · application/problem+json

Problem

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

409 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

409 · application/problem+json

Problem

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

410 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

410 · application/problem+json

Problem

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

422 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

422 · application/problem+json

Problem

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

429 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

429 · application/problem+json

Problem

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

503 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

503 · application/problem+json

Problem

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

Bestätigen Sie die verifizierte Installation des Eigentümerschlüssels

Der Anrufer muss den Kandidaten bereits gespeichert und in einem neuen Prozess unabhängig verifiziert haben. Erfolgreiche ACK-Marken installiert, entfernt den Ablauf des Kandidatenschlüssels und löscht wiederherstellbares Anmeldematerial. Wiederholtes ACK ist idempotent. Es werden keine Abfrageparameter akzeptiert. Antworten sind No-Store. Agentenrouten sind nur für die Verwaltung und Feature-Gated; Bereitstellungen können 404 zurückgeben, wenn sie deaktiviert sind. X-API-Key ist auf Agentenrouten verboten.

Authentifizierung: agentHandoffProof

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

Server: http://localhost:5000/v2

Parameter

connectionId · path · erforderlich

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

Antragsstellen · erforderlich

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

Antworten

200 Bestätigen Sie die verifizierte Installation des Eigentümerschlüssels

200 · application/json

AgentHandoff

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

400 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

400 · application/problem+json

Problem

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

401 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

401 · application/problem+json

Problem

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

403 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

403 · application/problem+json

Problem

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

409 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

409 · application/problem+json

Problem

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

410 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

410 · application/problem+json

Problem

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

422 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

422 · application/problem+json

Problem

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

429 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

429 · application/problem+json

Problem

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

503 Abgelehnte Anforderung; prüfen Sie den Problemcode. Versuchen Sie niemals eine Mutation blind.

503 · application/problem+json

Problem

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

Katalog

GET/catalog/sources

Öffentliche Quellenfähigkeiten ohne kontospezifische Preise auflisten

Authentifizierung: öffentlich

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

Server: http://localhost:5000/v2

Antworten

200 Öffentlicher Quellenkatalog

Kopfzeilen: Cache-Control

200 · application/json

DataSource

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

Liste der öffentlichen USD-Pläne und Preise

Authentifizierung: öffentlich

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

Server: http://localhost:5000/v2

Antworten

200 Öffentlicher Plankatalog

Kopfzeilen: Cache-Control

200 · application/json

PlanCatalog

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

Lesen Sie die aktuellen Nutzungsbedingungen und Datenschutzversionen, die für die Anmeldung erforderlich sind

Authentifizierung: öffentlich

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

Server: http://localhost:5000/v2

Antworten

200 Aktueller Katalog der rechtlichen Version

Kopfzeilen: Cache-Control

200 · application/json

PublicLegalVersions

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

Billing

GET/billing/subscription

Lesen Sie das effektive Stripe Abonnement

Authentifizierung: cookieSession

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

Server: http://localhost:5000/v2

Antworten

200 Abonnement oder PAYG Berechtigung

200 · application/json

Subscription

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

Erstellen Sie eine Stripe-gehostete Checkout-Sitzung

Abonnements und veröffentlichte Kreditpakete verwenden priceId. Ein benutzerdefiniertes Top-up verwendet stattdessen amountMinor (USD Cent, $10 bis $999,999.99); Der Server berechnet Credits zum festen Kreditwert und erstellt einen privaten Einmal-Streifenpreis. Produkt, Anbieterpreis, Währung, Erfolg URL und Abbruch URL werden niemals vom Browser akzeptiert. Credits werden erst nach einem verifizierten bezahlten Ereignis für den angegebenen Betrag gewährt.

Authentifizierung: cookieSession + csrfToken

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

Server: http://localhost:5000/v2

Parameter

Idempotency-Key · header · erforderlich

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

Antragsstellen · erforderlich

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"
        }
      }
    }
  ]
}

Antworten

201 Stripe Checkout Session

201 · application/json

HostedSession

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

403 Authentifiziert, aber nicht erlaubt, oder CSRF-Validierung fehlgeschlagen

403 · application/problem+json

Problem

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

409 Ressourcenzustand oder Idempotenzkonflikt

409 · application/problem+json

Problem

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

422 Antragsvalidierung fehlgeschlagen

422 · application/problem+json

Problem

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

502 Ein Upstream-Anbieter ist gescheitert

502 · application/problem+json

Problem

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

503 Der Abrechnungskatalog oder -anbieter ist nicht konfiguriert oder vorübergehend nicht verfügbar

503 · application/problem+json

Problem

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

Upgrade des aktuellen Stripe-Abonnements auf einen höheren veröffentlichten Preis

Der Server überprüft, ob der FlashData-Preis aktiv ist, im aktuellen Live-Modus verfügbar ist, USD-denominiert ist, sich wiederholt, das gleiche Intervall hat und streng teurer ist als der aktuelle Abonnementpreis. Produkt-, Anbieterpreis-, Währungs- und Prorationsoptionen werden vom Browser niemals akzeptiert. Lokale Berechtigungen und Credits ändern sich erst, nachdem ein verifiziertes Provider-Ereignis projiziert wurde.

Authentifizierung: cookieSession + csrfToken

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

Server: http://localhost:5000/v2

Parameter

Idempotency-Key · header · erforderlich

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

Antragsstellen · erforderlich

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

Antworten

201 Abonnementänderung bei Stripe eingereicht

201 · application/json

SubscriptionChange

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

403 Authentifiziert, aber nicht erlaubt, oder CSRF-Validierung fehlgeschlagen

403 · application/problem+json

Problem

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

404 Ressource nicht gefunden oder nicht im besitz des anrufers.

404 · application/problem+json

Problem

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

409 Ressourcenzustand oder Idempotenzkonflikt

409 · application/problem+json

Problem

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

422 Antragsvalidierung fehlgeschlagen

422 · application/problem+json

Problem

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

502 Ein Upstream-Anbieter ist gescheitert

502 · application/problem+json

Problem

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

503 Der Abrechnungskatalog oder -anbieter ist nicht konfiguriert oder vorübergehend nicht verfügbar

503 · application/problem+json

Problem

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

Erstellen einer Stripe Customer Portal Session

Authentifizierung: cookieSession + csrfToken

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

Server: http://localhost:5000/v2

Parameter

Idempotency-Key · header · erforderlich

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

Antworten

201 Stripe Customer Portal Sitzung

201 · application/json

HostedSession

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

403 Authentifiziert, aber nicht erlaubt, oder CSRF-Validierung fehlgeschlagen

403 · application/problem+json

Problem

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

404 Ressource nicht gefunden oder nicht im besitz des anrufers.

404 · application/problem+json

Problem

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

409 Ressourcenzustand oder Idempotenzkonflikt

409 · application/problem+json

Problem

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

502 Ein Upstream-Anbieter ist gescheitert

502 · application/problem+json

Problem

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

503 Der Abrechnungskatalog oder -anbieter ist nicht konfiguriert oder vorübergehend nicht verfügbar

503 · application/problem+json

Problem

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

Zeitplan oder Aufhebung des aktuellen bezahlten Abonnements

Setzen von cancelAtPeriodEnd auf true Termine Stornierung am aktuellen Abrechnungszeitraum Ende; false behält das Abonnement. Berechtigungsaktualisierung nach einem verifizierten stripe-abonnementereignis. Dieser Endpunkt storniert niemals sofort oder gibt eine Rückerstattung aus.

Authentifizierung: cookieSession + csrfToken

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

Server: http://localhost:5000/v2

Parameter

Idempotency-Key · header · erforderlich

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

Antragsstellen · erforderlich

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

Antworten

202 Stornierungsupdate bei Stripe eingereicht

202 · application/json

SubscriptionCancellationChange

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

403 Authentifiziert, aber nicht erlaubt, oder CSRF-Validierung fehlgeschlagen

403 · application/problem+json

Problem

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

404 Ressource nicht gefunden oder nicht im besitz des anrufers.

404 · application/problem+json

Problem

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

409 Ressourcenzustand oder Idempotenzkonflikt

409 · application/problem+json

Problem

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

422 Antragsvalidierung fehlgeschlagen

422 · application/problem+json

Problem

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

502 Ein Upstream-Anbieter ist gescheitert

502 · application/problem+json

Problem

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

503 Der Abrechnungskatalog oder -anbieter ist nicht konfiguriert oder vorübergehend nicht verfügbar

503 · application/problem+json

Problem

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

Liste: Projektionen der Rechnungen

Authentifizierung: cookieSession

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

Server: http://localhost:5000/v2

Parameter

cursor · query · fakultativ

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

limit · query · fakultativ

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

Antworten

200 Rechnungen

200 · application/json

Invoice · Page

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

Liste Account-Scoped Top-up und Erstattungszahlung Projektionen

Authentifizierung: cookieSession

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

Server: http://localhost:5000/v2

Parameter

cursor · query · fakultativ

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

limit · query · fakultativ

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

Antworten

200 Einmalige Zahlungshistorie ohne Anbietergeheimnisse

200 · application/json

BillingPaymentPage

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

Guthaben

GET/api-access/balance

Lesen Sie den Live-Kontostand mit einem API Schlüssel

Lesen Sie das aktuelle Guthaben, das von allen API-Schlüsseln in Ihrem Konto geteilt wird. Aktive Reservierungen können das verfügbare Guthaben reduzieren. Diese Anfrage kostet keine Credits und nimmt keine Abfrageparameter oder Körper. Die Antworten sind privat und werden nicht zwischengespeichert; es gelten Tariflimits für Kontolese.

Authentifizierung: dataApiKey

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

Server: http://localhost:5000/v2

Antworten

200 Signierter Saldo und nicht negative verfügbare Credits

200 · application/json

ApiAccessBalance

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

422 Antragsvalidierung fehlgeschlagen

422 · application/problem+json

Problem

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

429 Zu viele Accounts lesen; versuchen Sie es erneut nach dem Zeitlimitfenster

503 Eine erforderliche Abhängigkeit oder ein Katalog ist vorübergehend nicht verfügbar

503 · application/problem+json

Problem

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

Lesen Sie die tatsächlichen Kontopreise für Quellen, die vom API-Schlüssel autorisiert wurden

Lesen Sie Ihre Kontoraten für Quellen, die mit dem API-Schlüssel zulässig sind. Ein null-Preis bedeutet, dass die Quelle nicht verfügbar ist. request_count zählt Abfragen, nicht zurückgegebene Artikel; Download-Raten sind pro TB (10^12 Bytes). Schätzungen reservieren keine Credits oder Kapazitäten. Diese Anfrage kostet keine Credits. Die Antworten sind privat und werden nicht zwischengespeichert; es gelten Tariflimits für Kontolese.

Authentifizierung: dataApiKey

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

Server: http://localhost:5000/v2

Parameter

source · query · fakultativ

Eine Quelle, die diesem Schlüssel gewährt wurde; lassen Sie alle gewährten Quellen aus.

Schema

ApiAccessSource

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

request_count · query · fakultativ

Dezimale ganzzahlige anzahl der anrufe; schätzt die download-größe nicht.

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

Antworten

200 Kontoplan und quellenspezifische Preise

200 · application/json

ApiAccessPricing

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

403 Authentifiziert, aber nicht erlaubt, oder CSRF-Validierung fehlgeschlagen

403 · application/problem+json

Problem

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

422 Antragsvalidierung fehlgeschlagen

422 · application/problem+json

Problem

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

429 Zu viele Accounts lesen; versuchen Sie es erneut nach dem Zeitlimitfenster

503 Eine erforderliche Abhängigkeit oder ein Katalog ist vorübergehend nicht verfügbar

503 · application/problem+json

Problem

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

Lesen Sie Kontoplanlimits und aktuelle ausstehende Jobs mit einem API-Schlüssel

Lesen Sie Ihre Parallelitäts-, Batch-Größe- und Pending-Job-Limits sowie die aktuelle Pending-Zählung. Diese Werte helfen bei der Planung von Anfragen, reservieren jedoch keine Kapazität. Diese Anfrage kostet keine Credits und nimmt keine Abfrageparameter oder Körper. Die Antworten sind privat und werden nicht zwischengespeichert; es gelten Tariflimits für Kontolese.

Authentifizierung: dataApiKey

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

Server: http://localhost:5000/v2

Antworten

200 Planobergrenzen und laufende anstehende Zählung

200 · application/json

ApiAccessLimits

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

422 Antragsvalidierung fehlgeschlagen

422 · application/problem+json

Problem

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

429 Zu viele Accounts lesen; versuchen Sie es erneut nach dem Zeitlimitfenster

503 Eine erforderliche Abhängigkeit oder ein Katalog ist vorübergehend nicht verfügbar

503 · application/problem+json

Problem

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

Lesen Sie die Kontonutzung für Quellen, die durch den API-Schlüssel autorisiert wurden

Kostenlos gelesen, authentifiziert nur durch X-API-Key. Enthält alle Kontoschlüssel, aber Nur Quellen, die dem Anrufschlüssel zugewiesen wurden. Gibt keinen Abfragetext, Schlüssel zurück, Zahlungsdaten oder andere Konten. Standardmäßig bis sieben Tage; maximale 31 Tage. Datumsangaben müssen UTC Z-Zeitstempel verwenden. Von ist inklusiv und exklusiv; Beide sind auf Minuten abgerundet. Mit von allein, zu standardmäßigen von + 7 Tagen. Mit weder, to ist der Beginn der nächsten Minute. Aggregate werden schließlich konsistent; auch update=false garantiert nicht, dass alle aktuellen Ereignisse aufgenommen werden. Lies Limit: 60 Anfragen pro Minute pro Client-IP.

Authentifizierung: dataApiKey

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

Server: http://localhost:5000/v2

Parameter

source · query · fakultativ

Eine exakte Katalogquelle, die dem aufrufenden Schlüssel gewährt wird; ausgelassen bedeutet alle gewährten Quellen.

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 · fakultativ

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

to · query · fakultativ

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

Antworten

200 Scoped Request zählt und belastete Credits, mit Frischeinformationen

200 · application/json

ApiKeyUsage

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

403 Authentifiziert, aber nicht erlaubt, oder CSRF-Validierung fehlgeschlagen

403 · application/problem+json

Problem

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

422 Antragsvalidierung fehlgeschlagen

422 · application/problem+json

Problem

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

429 Zu viele Nutzungslesungen; Wiederholen nach dem Rate-Limit-Fenster

503 Eine erforderliche Abhängigkeit oder ein Katalog ist vorübergehend nicht verfügbar

503 · application/problem+json

Problem

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

Lesen Sie aktuelle verfügbare und reservierte Credits

Authentifizierung: cookieSession

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

Server: http://localhost:5000/v2

Antworten

200 Kreditausfall

200 · application/json

CreditBalance

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

Lesen Sie die effektive Konto-Garantie und Gebührenpolitik

Authentifizierung: cookieSession

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

Server: http://localhost:5000/v2

Antworten

200 Effektive Kreditpolitik

200 · application/json

CreditPolicy

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

Liste Kredit-Ledger-Einträge

Authentifizierung: cookieSession

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

Server: http://localhost:5000/v2

Parameter

cursor · query · fakultativ

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

limit · query · fakultativ

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

type · query · fakultativ

Schema

CreditEntryType

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

Antworten

200 Ledgereinträge

200 · application/json

CreditTransaction · Page

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

Trial Credits

GET/trial-credit-request

Lesen Sie die Berechtigung für Trial Credit und die lebenslange Anforderung des Kontos

Authentifizierung: cookieSession

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

Server: http://localhost:5000/v2

Antworten

200 Aktuelle Förderfähigkeit, konfigurierter Zuschuss und Antragszustand

Kopfzeilen: Cache-Control

200 · application/json

TrialCreditState

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

401 Authentifizierung erforderlich oder ungültig

Kopfzeilen: Cache-Control, X-Request-Id

401 · application/problem+json

Problem

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

500 Ein unerwarteter interner Fehler ist aufgetreten

Kopfzeilen: Cache-Control, X-Request-Id

500 · application/problem+json

Problem

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

503 Eine erforderliche Abhängigkeit oder Onboarding-Aufzeichnung ist vorübergehend nicht verfügbar

Kopfzeilen: Cache-Control, X-Request-Id

503 · application/problem+json

Problem

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

Senden Sie die One Lifetime Trial Credit-Anfrage des Kontos

Der Probebetrag und der Anwendungsfall werden gespeichert, wenn Sie die Anfrage einreichen.

Authentifizierung: cookieSession + csrfToken

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

Server: http://localhost:5000/v2

Parameter

Idempotency-Key · header · erforderlich

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

Antragsstellen · fakultativ

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

Antworten

201 Testkreditanforderung erstellt und automatisch genehmigt für berechtigte verifizierte Konten, unabhängig vom E-Mail-Anbieter

Kopfzeilen: Cache-Control

201 · application/json

TrialCreditState

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

401 Authentifizierung erforderlich oder ungültig

Kopfzeilen: Cache-Control, X-Request-Id

401 · application/problem+json

Problem

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

403 Authentifiziert, aber nicht erlaubt, oder CSRF-Validierung fehlgeschlagen

Kopfzeilen: Cache-Control, X-Request-Id

403 · application/problem+json

Problem

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

409 Ressourcenzustand oder Idempotenzkonflikt

Kopfzeilen: Cache-Control, X-Request-Id

409 · application/problem+json

Problem

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

422 Antragsvalidierung fehlgeschlagen

Kopfzeilen: Cache-Control, X-Request-Id

422 · application/problem+json

Problem

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

500 Ein unerwarteter interner Fehler ist aufgetreten

Kopfzeilen: Cache-Control, X-Request-Id

500 · application/problem+json

Problem

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

503 Eine erforderliche Abhängigkeit oder Onboarding-Aufzeichnung ist vorübergehend nicht verfügbar

Kopfzeilen: Cache-Control, X-Request-Id

503 · application/problem+json

Problem

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

Lieferung

GET/delivery/webhooks

Liste gespeicherter Abschluss Callback URLs

Authentifizierung: cookieSession

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

Server: http://localhost:5000/v2

Antworten

200 Rückruf URLs

200 · application/json

DeliveryWebhook

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

Speichern Sie einen Abschluss Callback URL

Authentifizierung: cookieSession + csrfToken

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

Server: http://localhost:5000/v2

Antragsstellen · erforderlich

Schema · application/json

CreateDeliveryWebhookRequest

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

Antworten

201 Geschaffen

201 · application/json

DeliveryWebhook

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

422 Antragsvalidierung fehlgeschlagen

422 · application/problem+json

Problem

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

Entfernen Sie einen Abschluss Callback URL

Authentifizierung: cookieSession + csrfToken

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

Server: http://localhost:5000/v2

Parameter

webhookId · path · erforderlich

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

Antworten

204 Entfernt

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

404 Ressource nicht gefunden oder nicht im besitz des anrufers.

404 · application/problem+json

Problem

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

Senden Sie eine Beispiel-Download-vollständige Nutzlast

Authentifizierung: cookieSession + csrfToken

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

Server: http://localhost:5000/v2

Parameter

webhookId · path · erforderlich

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

Antworten

200 Versuch Versuch

200 · application/json

DeliveryWebhook

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

404 Ressource nicht gefunden oder nicht im besitz des anrufers.

404 · application/problem+json

Problem

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

Arbeitsplätze

Für Einreichung, Status und Ergebnisbeispiele siehe Realtime und async · Batch-Anfragen.

GET/jobs

Listendaten API-Jobs für den aktuellen Arbeitsbereich

Cursor-paginierte aktive und archivierte Geschichte. Standardmäßig bis zu den letzten sieben Tagen; jeder UTC-Datumsbereich ist auf 31-Tage beschränkt. From ist inklusive und to ist exklusiv, mit minutiöser Präzision. Zusammenfassungen werden asynchron gehalten und können die Einnahme verzögern.

Authentifizierung: cookieSession

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

Server: http://localhost:5000/v2

Parameter

cursor · query · fakultativ

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

limit · query · fakultativ

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

source · query · fakultativ

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

status · query · fakultativ

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

mode · query · fakultativ

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

from · query · fakultativ

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

to · query · fakultativ

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

Antworten

200 Jobseite

200 · application/json

ConsoleJob · Pagination

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 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

422 Antragsvalidierung fehlgeschlagen

422 · application/problem+json

Problem

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

Lesen Sie einen Daten API Job

Lesen Sie job.status, um den Fortschritt und job.error zu überprüfen, wenn die Verarbeitung fehlgeschlagen ist. JSON ist der Standard; Verwenden Sie Accept: text/plain für lesbaren Text. X-Respond-With wird hier ignoriert. Folgen Sie Retry-After, wenn Sie es erhalten haben, bevor Sie es erneut überprüfen.

Authentifizierung: cookieSession oder dataApiKey

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

Server: http://localhost:5000/v2

Parameter

Accept · header · fakultativ

application/json gibt die ursprüngliche strukturierte Antwort zurück; text/plain gibt die gleichen Felder wie eingerückter Klartext zurück. Standard-Medienbereiche und q-Gewichte werden unterstützt; fehlende Accept oder eine globale Platzhaltereinstellung ist standardmäßig auf JSON. X-Respond-With wird bei Einreichungs- und Jobstatus-Endpunkten ignoriert. Fehler bleiben strukturiert JSON. Beide Antworttypen verwenden UTF-8; ein expliziter Parameter charset=utf-8 wird unterstützt.

Schema
Schema
{
  "type": "string"
}

jobId · path · erforderlich

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

Antworten

200 Stellenangaben

200 · application/json

ConsoleJob

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

404 Ressource nicht gefunden oder nicht im besitz des anrufers.

404 · application/problem+json

Problem

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

406 Weder application/json noch text/plain sind akzeptabel; Antwort ist JSON

406 · application/json

QueryRepresentationError

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

Laden Sie ein abgeschlossenes async Ergebnis herunter

Standardmäßig authentifiziert den Zugriff und leitet zu einem kurzlebigen privaten R2 URL um; Clients erhalten das ursprüngliche JSON direkt von R2. Accept: text/plain gibt HTTP 200 mit den ursprünglichen Ergebnisfeldern als eingerückten Klartext unabhängig zurück. X-Respond-With: Markdown wählt Markdown-Inhalte aus: application/json wickelt sie in den Inhalt neben den ursprünglichen Metadaten ein und ersetzt die Ergebnisse; text/plain gibt Metadaten gefolgt von Markdown zurück. Fehlende Accept oder eine globale Platzhalter-Standards zu JSON. Die Formatierung sendet keine weitere Abfrage oder berechnet Abfragegutschriften. Gespeicherte Ergebnisse verfallen 24 Stunden nach Abschluss. Fehler bleiben strukturiert JSON.

Authentifizierung: cookieSession oder dataApiKey

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

Server: http://localhost:5000/v2

Parameter

X-Respond-With · header · fakultativ

Setzen Sie auf Markdown, um den Ergebnisinhalt als Markdown zurückzugeben. Vermeiden Sie es, die ursprünglichen Ergebnisfelder beizubehalten. Accept wählt unabhängig voneinander JSON oder Klartext aus. Nur Echtzeit-Abfragen und abgeschlossene Jobergebnis-Reads unterstützen diesen Header. Es ändert sich nicht Job-Einreichungen, Status, Konto-APIs, Rückrufe, Bulk-Dateien, binäre Downloads oder MCP-Protokollantworten.

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

Accept · header · fakultativ

Wählen Sie application/json oder text/plain unabhängig von X-Respond-With. Ohne X-Respond-With gibt text/plain die ursprünglichen Felder mit Einrückung zurück; JSON behält die ursprünglichen Antwortfelder bei (abgeschlossenes Ergebnis liest Redirect to Storage). Mit Markdown gibt JSON Inhalte plus Metadaten zurück und Klartext gibt Metadaten gefolgt von Markdown zurück. Standard-Medienbereiche und q-Gewichte werden unterstützt; fehlende Accept oder eine globale Platzhaltereinstellung ist standardmäßig auf JSON. Beide Antworttypen verwenden UTF-8; ein expliziter Parameter charset=utf-8 wird unterstützt.

Schema
Schema
{
  "type": "string"
}

jobId · path · erforderlich

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

Antworten

200 Einfachtext-Originalfelder oder Markdown direkt zurückgegeben; Original-JSON von R2 nach Befolgen der Standard-Weiterleitung

200 · application/json

MarkdownQueryResult

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

302 Weiterleitung zum ursprünglichen JSON im privaten R2-Speicher, wenn JSON ohne X-Respond-With ausgewählt wurde

Kopfzeilen: Location

400 Nicht unterstützter X-Respond-With-Wert; Antwort ist JSON

400 · application/json

QueryRepresentationError

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

404 Ressource nicht gefunden oder nicht im besitz des anrufers.

404 · application/problem+json

Problem

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

406 Weder application/json noch text/plain sind akzeptabel; Antwort ist JSON

406 · application/json

QueryRepresentationError

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

409 Ressourcenzustand oder Idempotenzkonflikt

409 · application/problem+json

Problem

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

410 Ergebnis abgelaufen

410 · application/problem+json

Problem

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

422 Der Auftrag ist fehlgeschlagen. Wenn ein gespeicherter Fehlergrund vorliegt, enthält ihn das Feld detail der Antwort.

422 · application/problem+json

Problem

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

503 Eine erforderliche Abhängigkeit oder ein Katalog ist vorübergehend nicht verfügbar

503 · application/problem+json

Problem

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

API für Bulk-Verarbeitung

Bulk-Endpunkte haben eine dedizierte Referenz mit Parametern, Anforderungsbeispielen und Antwortschemata. Offene Bulk Verarbeitung API

Playground

POST/playground/run

Führen Sie eine Spielplatzabfrage als aktuellen Arbeitsbereich aus

Authentifizierung: cookieSession + csrfToken

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

Server: http://localhost:5000/v2

Antragsstellen · erforderlich

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
    }
  }
}

Antworten

200 Upstream Daten API Antwort für den Spielplatz erfasst

200 · application/json
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 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

422 Antragsvalidierung fehlgeschlagen

422 · application/problem+json

Problem

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

Laden Sie ein abgeschlossenes Spielplatz-Artefakt im aktuellen Browser herunter

Authentifizierung: cookieSession

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

Server: http://localhost:5000/v2

Parameter

jobId · path · erforderlich

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

Antworten

200 Temporäres Browser-Download-Artefakt

Kopfzeilen: Content-Disposition, Content-Length

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

401 Authentifizierung erforderlich oder ungültig

401 · application/problem+json

Problem

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

404 Ressource nicht gefunden oder nicht im besitz des anrufers.

404 · application/problem+json

Problem

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

409 Ressourcenzustand oder Idempotenzkonflikt

409 · application/problem+json

Problem

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

410 Das temporäre Artefakt ist abgelaufen

410 · application/problem+json

Problem

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

503 Eine erforderliche Abhängigkeit oder ein Katalog ist vorübergehend nicht verfügbar

503 · application/problem+json

Problem

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

Schemadefinitionen

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."
    }
  }
}