Aller au contenu
FR
Obtenir une clé API
Parcourir la documentation

Référence API

Référence de l’API de gestion

Consultez les points d’accès pour les comptes, les clés, la facturation et les tâches. Chacun précise ses exigences d’authentification et d’accès.

Consulter votre compte avec une clé API

L’URL de base de l’API de gestion est https://api.flashdata.dev/v2. Cette lecture gratuite renvoie les identifiants du compte et de la clé actuelle, ainsi que les informations de propriété. Définissez FLASHDATA_API_KEY avant d’exécuter la commande.

Vérifier la clé actuelle · 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'

En cas de succès, la réponse est HTTP 200. Vérifiez la ligne d’authentification de chaque point d’accès : dataApiKey utilise X-API-Key ; cookieSession utilise une session de navigateur connectée. Schéma de la réponse d’identité

Télécharger la spécification OpenAPI publique. Elle couvre les requêtes, les tâches, les comptes, les clés API et la facturation.

Les paramètres de requête et les exemples de code figurent dans les références API Google et YouTube.

Modes d’authentification

ModeExigence
dataApiKey

X-API-Key · header

Clé API FlashData. L’accès aux tâches est limité aux sources autorisées par la clé.

cookieSession

__Host-fd_session · cookie

Session web opaque. Le cookie n’est pas lisible par le code exécuté dans le navigateur.

csrfToken

X-CSRF-Token · header

apiKey

agentRegistrationProof

Avant tout envoi, enregistrez durablement une preuve de 32 octets générés aléatoirement avec un générateur cryptographique, encodée en base64url, ainsi que la requête exacte. Récupérez l’accès uniquement avec cette même preuve et ce même corps de requête. Ce n’est pas un jeton OAuth.

agentSetupCredential

Identifiant temporaire de configuration, réservé à la lecture de l’état et à la création d’une demande de rattachement. Ce n’est pas une clé de l’API de données.

agentHandoffProof

Preuve utilisée pour récupérer la clé du propriétaire et confirmer son installation. Ne l’envoyez jamais dans une requête de données.

agentIdentityKey

Clé API FlashData ordinaire dans Authorization Bearer, uniquement pour l’identité de l’agent. Les requêtes de données utilisent X-API-Key à la place.

Système

GET/health

État du service

Authentification : Public

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

Serveur : http://localhost:5000/v2

Réponses

200 Opérationnel

Réponse 200 · application/json

Health

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

Lire le résumé public de l’état des composants

Authentification : Public

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

Serveur : http://localhost:5000/v2

Réponses

200 Résumé public de l’état des services

En-têtes : Cache-Control

Réponse 200 · application/json

PublicStatus

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

Authentification

GET/oauth/requests/{requestId}

Lire une demande d’autorisation d’application et la lier à la session actuelle

Session complète requise. La demande expire après dix minutes. La réponse utilise no-store.

Authentification : cookieSession

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

Serveur : http://localhost:5000/v2

Paramètres

requestId · path · obligatoire

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

Réponses

200 Autorisations demandées par l’application

Réponse 200 · application/json

OAuthConsent

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

403 Authentification réussie, mais accès non autorisé, ou validation CSRF échouée

Réponse 403 · application/problem+json

Problem

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

410 Demande expirée, déjà utilisée ou liée à une autre session

Réponse 410 · application/problem+json

Problem

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

Approuver ou refuser une demande d’autorisation d’application

Session complète, validation CSRF et en-tête Origin autorisé requis. La demande ne peut être utilisée qu’une fois. La réponse utilise no-store.

Authentification : cookieSession + csrfToken

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

Serveur : http://localhost:5000/v2

Paramètres

requestId · path · obligatoire

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

Corps de la requête · obligatoire

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

Réponses

200 Callback enregistré du client, avec code ou refus, état et émetteur

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

403 Authentification réussie, mais accès non autorisé, ou validation CSRF échouée

Réponse 403 · application/problem+json

Problem

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

410 Demande d’autorisation indisponible ; démarrez une nouvelle connexion

Réponse 410 · application/problem+json

Problem

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

422 Échec de la validation de la requête

Réponse 422 · application/problem+json

Problem

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

Créer un compte FlashData en attente de vérification

Les versions soumises des conditions d’utilisation et de la politique de confidentialité doivent correspondre aux documents actuellement publiés.

Authentification : Public

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

Serveur : http://localhost:5000/v2

Corps de la requête · obligatoire

Schéma · application/json

RegisterRequest

Schéma
{
  "$ref": "#/components/schemas/RegisterRequest"
}

Réponses

201 Compte créé ; vérification de l’adresse e-mail requise

En-têtes : Cache-Control, X-Request-Id

Réponse 201 · application/json

RegisterResponse

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

409 Conflit d’état de la ressource ou d’idempotence

Réponse 409 · application/problem+json

Problem

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

422 Échec de la validation de la requête

Réponse 422 · application/problem+json

Problem

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

429 Limite de débit, de requêtes simultanées, de taille de batch ou de tâches en attente dépassée

En-têtes : Retry-After

Réponse 429 · application/problem+json

Problem

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

500 Une erreur interne inattendue est survenue

Réponse 500 · application/problem+json

Problem

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

503 Une dépendance ou un catalogue requis est temporairement indisponible

Réponse 503 · application/problem+json

Problem

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

Créer une session web opaque

Définit le cookie Secure, HttpOnly `__Host-fd_session`. Les comptes en attente reçoivent une session restreinte email_verification pour le tableau de vérification. Les comptes vérifiés éligibles reçoivent leurs crédits d’essai uniques à la connexion s’ils n’ont pas déjà été accordés. Un compte actif reçoit une session complète, sauf si son identité migrée exige encore l’acceptation des documents juridiques en vigueur : il reçoit alors une session restreinte legal_acceptance. Un compte dont la suppression est planifiée reçoit une session restreinte deletion_recovery. Les comptes dont la suppression est à l’état processing/failed/completed, ainsi que les comptes suspendus, reçoivent 403.

Authentification : Public

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

Serveur : http://localhost:5000/v2

Corps de la requête · obligatoire

Schéma · application/json

LoginRequest

Schéma
{
  "$ref": "#/components/schemas/LoginRequest"
}

Réponses

200 Authentification réussie

En-têtes : Set-Cookie, Cache-Control, X-Request-Id

Réponse 200 · application/json

LoginResponse

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

403 Connexion interdite ; Problem.code vaut email_not_verified, account_suspended, account_deletion_processing, account_deletion_failed ou account_deleted

Réponse 403 · application/problem+json

Problem

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

422 Échec de la validation de la requête

Réponse 422 · application/problem+json

Problem

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

423 Compte temporairement verrouillé

En-têtes : Retry-After

Réponse 423 · application/problem+json

Problem

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

429 Limite de débit, de requêtes simultanées, de taille de batch ou de tâches en attente dépassée

En-têtes : Retry-After

Réponse 429 · application/problem+json

Problem

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

Révoquer la session actuelle

Authentification : cookieSession + csrfToken

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

Serveur : http://localhost:5000/v2

Réponses

204 Session révoquée et cookie supprimé

En-têtes : Set-Cookie, Cache-Control, X-Request-Id

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

403 Authentification réussie, mais accès non autorisé, ou validation CSRF échouée

Réponse 403 · application/problem+json

Problem

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

Lire le compte et l’utilisateur actuels

Authentification : cookieSession

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

Serveur : http://localhost:5000/v2

Réponses

200 Compte actuel

En-têtes : Cache-Control, X-Request-Id

Réponse 200 · application/json

Account

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

Obtenir le jeton CSRF lié à la session actuelle

Authentification : cookieSession

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

Serveur : http://localhost:5000/v2

Réponses

200 Jeton CSRF

En-têtes : Cache-Control, X-Request-Id

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

Demander ou renvoyer un e-mail de vérification

Pour toute adresse e-mail syntaxiquement valide, renvoie la même réponse, que le compte soit absent, en attente, actif, suspendu ou supprimé. Les comptes en attente éligibles reçoivent un nouveau lien à usage unique après le délai imposé entre deux envois ; ce lien remplace le précédent.

Authentification : Public

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

Serveur : http://localhost:5000/v2

Corps de la requête · obligatoire

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

Réponses

202 Demande acceptée. La réponse ne révèle pas si un compte existe.

En-têtes : Cache-Control, X-Request-Id

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

422 Échec de la validation de la requête d’authentification anonyme

En-têtes : Cache-Control, X-Request-Id

Réponse 422 · application/problem+json

Problem

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

429 Limite de débit de l’authentification anonyme dépassée

En-têtes : Cache-Control, Retry-After, X-Request-Id

Réponse 429 · application/problem+json

Problem

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

500 Une erreur inattendue d’authentification anonyme est survenue

En-têtes : Cache-Control, X-Request-Id

Réponse 500 · application/problem+json

Problem

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

503 Une dépendance de l’authentification anonyme est temporairement indisponible

En-têtes : Cache-Control, X-Request-Id

Réponse 503 · application/problem+json

Problem

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

Vérifier l’adresse e-mail et activer le compte

Consomme le jeton à usage unique et active le compte et l’utilisateur dans une opération atomique. Les règles existantes relatives aux comptes et aux crédits d’essai s’appliquent. Sans session d’inscription, l’utilisateur doit se connecter explicitement. Une requête d’une origine autorisée, accompagnée de la session d’inscription correspondante et de son X-CSRF-Token, peut recevoir un cookie de session renouvelé pour le même compte vérifié. Un jeton de vérification seul ne connecte jamais l’utilisateur.

Authentification : Public

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

Serveur : http://localhost:5000/v2

Corps de la requête · obligatoire

Schéma · application/json

TokenRequest

Schéma
{
  "$ref": "#/components/schemas/TokenRequest"
}

Réponses

200 Compte activé

En-têtes : Set-Cookie, Cache-Control, X-Request-Id

Réponse 200 · application/json

Account

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

410 Le jeton à usage unique est invalide, expiré, invalidé, déjà utilisé ou consommé par une confirmation concurrente. Problem.code vaut `token_unavailable`.

En-têtes : Cache-Control, X-Request-Id

Réponse 410 · application/problem+json

Problem

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

422 Échec de la validation de la requête d’authentification anonyme

En-têtes : Cache-Control, X-Request-Id

Réponse 422 · application/problem+json

Problem

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

429 Limite de débit de l’authentification anonyme dépassée

En-têtes : Cache-Control, Retry-After, X-Request-Id

Réponse 429 · application/problem+json

Problem

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

500 Une erreur inattendue d’authentification anonyme est survenue

En-têtes : Cache-Control, X-Request-Id

Réponse 500 · application/problem+json

Problem

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

503 Une dépendance de l’authentification anonyme est temporairement indisponible

En-têtes : Cache-Control, X-Request-Id

Réponse 503 · application/problem+json

Problem

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

Reprendre la session d’inscription d’origine après vérification de l’adresse e-mail

Nécessite un en-tête Origin autorisé et le jeton CSRF lié à une session de vérification d’e-mail encore valide, authentifiée par mot de passe. Renvoie pending tant que le compte de cette session n’est pas vérifié, y compris si la vérification a lieu dans un autre navigateur. Révoque la session d’inscription et crée une nouvelle session complète ou d’acceptation juridique dans une opération atomique. N’accepte aucun identifiant de compte, adresse e-mail, mot de passe ou jeton de vérification ; ne contourne pas l’acceptation juridique et n’accorde aucun crédit.

Authentification : cookieSession + csrfToken

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

Serveur : http://localhost:5000/v2

Corps de la requête · obligatoire

Schéma · application/json
Schéma
{
  "type": "object",
  "additionalProperties": false
}

Réponses

200 Session d’inscription renouvelée

En-têtes : Set-Cookie, Cache-Control

Réponse 200 · application/json

LoginResponse

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

202 Vérification de l’adresse e-mail en attente ; aucune nouvelle session

En-têtes : Cache-Control

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

403 Authentification réussie, mais accès non autorisé, ou validation CSRF échouée

Réponse 403 · application/problem+json

Problem

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

422 Échec de la validation de la requête

Réponse 422 · application/problem+json

Problem

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

500 Une erreur interne inattendue est survenue

Réponse 500 · application/problem+json

Problem

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

Demander un e-mail de réinitialisation du mot de passe

Renvoie toujours la même réponse 202 pour une adresse e-mail syntaxiquement valide, que le compte existe ou non et quel que soit son état. Seules les identités actives ou verrouillées éligibles reçoivent un e-mail.

Authentification : Public

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

Serveur : http://localhost:5000/v2

Corps de la requête · obligatoire

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

Réponses

202 Demande acceptée. La réponse ne révèle pas si un compte existe.

En-têtes : Cache-Control, X-Request-Id

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

422 Échec de la validation de la requête d’authentification anonyme

En-têtes : Cache-Control, X-Request-Id

Réponse 422 · application/problem+json

Problem

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

429 Limite de débit de l’authentification anonyme dépassée

En-têtes : Cache-Control, Retry-After, X-Request-Id

Réponse 429 · application/problem+json

Problem

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

500 Une erreur inattendue d’authentification anonyme est survenue

En-têtes : Cache-Control, X-Request-Id

Réponse 500 · application/problem+json

Problem

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

503 Une dépendance de l’authentification anonyme est temporairement indisponible

En-têtes : Cache-Control, X-Request-Id

Réponse 503 · application/problem+json

Problem

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

Définir un nouveau mot de passe et révoquer les sessions existantes

Consomme le jeton de réinitialisation, enregistre le nouveau secret d’authentification avec Argon2id, révoque toutes les sessions existantes et invalide les autres jetons de réinitialisation, dans une opération atomique. Ne connecte pas l’utilisateur et ne crée aucune session.

Authentification : Public

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

Serveur : http://localhost:5000/v2

Corps de la requête · obligatoire

Schéma · application/json

Password

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

Réponses

204 Mot de passe mis à jour ; sessions existantes révoquées

En-têtes : Cache-Control, X-Request-Id

410 Le jeton à usage unique est invalide, expiré, invalidé, déjà utilisé ou consommé par une confirmation concurrente. Problem.code vaut `token_unavailable`.

En-têtes : Cache-Control, X-Request-Id

Réponse 410 · application/problem+json

Problem

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

422 Échec de la validation de la requête d’authentification anonyme

En-têtes : Cache-Control, X-Request-Id

Réponse 422 · application/problem+json

Problem

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

429 Limite de débit de l’authentification anonyme dépassée

En-têtes : Cache-Control, Retry-After, X-Request-Id

Réponse 429 · application/problem+json

Problem

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

500 Une erreur inattendue d’authentification anonyme est survenue

En-têtes : Cache-Control, X-Request-Id

Réponse 500 · application/problem+json

Problem

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

503 Une dépendance de l’authentification anonyme est temporairement indisponible

En-têtes : Cache-Control, X-Request-Id

Réponse 503 · application/problem+json

Problem

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

Lister les sessions actives de l’utilisateur actuel

Authentification : cookieSession

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

Serveur : http://localhost:5000/v2

Réponses

200 Sessions

En-têtes : Cache-Control, X-Request-Id

Réponse 200 · application/json

Session

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

Révoquer toutes les sessions sauf la session actuelle

Authentification : cookieSession + csrfToken

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

Serveur : http://localhost:5000/v2

Réponses

204 Autres sessions révoquées

En-têtes : Cache-Control, X-Request-Id

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

403 Authentification réussie, mais accès non autorisé, ou validation CSRF échouée

Réponse 403 · application/problem+json

Problem

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

Révoquer une session

Authentification : cookieSession + csrfToken

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

Serveur : http://localhost:5000/v2

Paramètres

sessionId · path · obligatoire

Schéma
Schéma
{
  "type": "string",
  "pattern": "^ses_"
}

Réponses

204 Session révoquée. S’il s’agissait de la session actuelle, le cookie est supprimé.

En-têtes : Set-Cookie, Cache-Control, X-Request-Id

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

403 Authentification réussie, mais accès non autorisé, ou validation CSRF échouée

Réponse 403 · application/problem+json

Problem

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

404 Ressource introuvable ou n’appartenant pas au compte appelant

Réponse 404 · application/problem+json

Problem

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

409 Conflit d’état de la ressource ou d’idempotence

Réponse 409 · application/problem+json

Problem

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

422 Échec de la validation de la requête

Réponse 422 · application/problem+json

Problem

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

503 Une dépendance ou un catalogue requis est temporairement indisponible

Réponse 503 · application/problem+json

Problem

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

Vérifier le mot de passe actuel avant une opération sensible

Enregistre une preuve d’authentification récente à durée de validité limitée dans la session actuelle, côté serveur.

Authentification : cookieSession + csrfToken

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

Serveur : http://localhost:5000/v2

Corps de la requête · obligatoire

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

Réponses

200 La session dispose d’une authentification récente

En-têtes : Cache-Control, X-Request-Id

Réponse 200 · application/json

Reauthentication

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

403 Authentification réussie, mais accès non autorisé, ou validation CSRF échouée

Réponse 403 · application/problem+json

Problem

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

429 Limite de débit, de requêtes simultanées, de taille de batch ou de tâches en attente dépassée

En-têtes : Retry-After

Réponse 429 · application/problem+json

Problem

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

Modifier le mot de passe et renouveler la session actuelle

Authentification : cookieSession + csrfToken

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

Serveur : http://localhost:5000/v2

Corps de la requête · obligatoire

Schéma · application/json

Password

Schéma
{
  "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
    }
  }
}

Réponses

204 Mot de passe modifié ; session actuelle renouvelée et autres sessions révoquées si demandé

En-têtes : Set-Cookie, Cache-Control, X-Request-Id

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

403 Authentification réussie, mais accès non autorisé, ou validation CSRF échouée

Réponse 403 · application/problem+json

Problem

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

422 Échec de la validation de la requête

Réponse 422 · application/problem+json

Problem

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

Compte

GET/oauth/connections

Lister les applications connectées au compte actuel

Session complète requise. La liste est vide si le compte n’a aucune application connectée. La réponse utilise no-store.

Authentification : cookieSession

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

Serveur : http://localhost:5000/v2

Réponses

200 Applications connectées

Réponse 200 · application/json

OAuthConnection

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

403 Authentification réussie, mais accès non autorisé, ou validation CSRF échouée

Réponse 403 · application/problem+json

Problem

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

Révoquer une application connectée et sa clé API dédiée

Session complète, validation CSRF et en-tête Origin autorisé requis. Le serveur vérifie que l’autorisation appartient au compte. La réponse utilise no-store.

Authentification : cookieSession + csrfToken

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

Serveur : http://localhost:5000/v2

Paramètres

grantId · path · obligatoire

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

Réponses

204 Autorisation révoquée

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

403 Authentification réussie, mais accès non autorisé, ou validation CSRF échouée

Réponse 403 · application/problem+json

Problem

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

404 Ressource introuvable ou n’appartenant pas au compte appelant

Réponse 404 · application/problem+json

Problem

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

Lire les paramètres du compte

Authentification : cookieSession

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

Serveur : http://localhost:5000/v2

Réponses

200 Compte

Réponse 200 · application/json

Account

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

Mettre à jour les paramètres du profil

Authentification : cookieSession + csrfToken

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

Serveur : http://localhost:5000/v2

Corps de la requête · obligatoire

Schéma · application/json

UpdateAccountRequest

Schéma
{
  "$ref": "#/components/schemas/UpdateAccountRequest"
}

Réponses

200 Compte mis à jour

Réponse 200 · application/json

Account

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

403 Authentification réussie, mais accès non autorisé, ou validation CSRF échouée

Réponse 403 · application/problem+json

Problem

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

422 Échec de la validation de la requête

Réponse 422 · application/problem+json

Problem

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

Planifier la suppression du compte et révoquer toutes les sessions et clés API existantes

Avant de planifier leur suppression, les comptes administrateur doivent perdre leur rôle sur la plateforme via la procédure opérateur auditée. L’unique demande de suppression active détermine l’idempotence : des demandes authentifiées simultanées renvoient la même demande. Après révocation des sessions, une réponse perdue se récupère en se connectant en mode deletion_recovery puis en appelant GET /account/deletion. Les sessions révoquées ne sont jamais acceptées pour répéter la requête.

Authentification : cookieSession + csrfToken

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

Serveur : http://localhost:5000/v2

Corps de la requête · obligatoire

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

Réponses

202 Suppression planifiée ; sessions et clés actives révoquées

Réponse 202 · application/json

AccountDeletionRequest

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

403 Authentification réussie, mais accès non autorisé, ou validation CSRF échouée

Réponse 403 · application/problem+json

Problem

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

409 Conflit d’état de la ressource ou d’idempotence

Réponse 409 · application/problem+json

Problem

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

422 Échec de la validation de la requête

Réponse 422 · application/problem+json

Problem

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

Lire la demande de suppression du compte actuel

Authentification : cookieSession

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

Serveur : http://localhost:5000/v2

Réponses

200 Demande de suppression actuelle

Réponse 200 · application/json

AccountDeletionRequest

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

404 Ressource introuvable ou n’appartenant pas au compte appelant

Réponse 404 · application/problem+json

Problem

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

Annuler une suppression planifiée pendant le délai de grâce

Effectue une transition atomique de scheduled vers cancelled après vérification de l’état attendu. Si le traitement de suppression entre en concurrence, renvoie 409. Après succès, la session de récupération est renouvelée et ne peut pas répéter l’ancienne transition.

Authentification : cookieSession + csrfToken

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

Serveur : http://localhost:5000/v2

Réponses

204 Suppression annulée, compte réactivé et session de récupération renouvelée selon l’exigence d’acceptation des documents juridiques

En-têtes : Set-Cookie, Cache-Control, X-Request-Id

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

403 Authentification réussie, mais accès non autorisé, ou validation CSRF échouée

Réponse 403 · application/problem+json

Problem

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

404 Ressource introuvable ou n’appartenant pas au compte appelant

Réponse 404 · application/problem+json

Problem

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

409 Conflit d’état de la ressource ou d’idempotence

Réponse 409 · application/problem+json

Problem

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

Accepter les versions publiées des conditions d’utilisation et de la politique de confidentialité

Ajoute une preuve d’acceptation juridique immuable, lève le blocage lié à la migration et renouvelle la session. Les versions soumises obsolètes sont refusées.

Authentification : cookieSession + csrfToken

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

Serveur : http://localhost:5000/v2

Corps de la requête · obligatoire

Schéma · application/json

LegalAcceptanceRequest

Schéma
{
  "$ref": "#/components/schemas/LegalAcceptanceRequest"
}

Réponses

200 Acceptation juridique enregistrée et session renouvelée en mode complet

En-têtes : Set-Cookie, Cache-Control, X-Request-Id

Réponse 200 · application/json

LoginResponse

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

403 Authentification réussie, mais accès non autorisé, ou validation CSRF échouée

Réponse 403 · application/problem+json

Problem

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

404 Ressource introuvable ou n’appartenant pas au compte appelant

Réponse 404 · application/problem+json

Problem

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

422 Échec de la validation de la requête

Réponse 422 · application/problem+json

Problem

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

Configuration initiale

GET/onboarding

Lire l’avancement de la configuration initiale pour pouvoir la reprendre

Authentification : cookieSession

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

Serveur : http://localhost:5000/v2

Réponses

200 État actuel de la configuration initiale

En-têtes : Cache-Control, X-Request-Id

Réponse 200 · application/json

OnboardingProgress

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

401 Authentification requise ou invalide

En-têtes : Cache-Control, X-Request-Id

Réponse 401 · application/problem+json

Problem

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

500 Une erreur interne inattendue est survenue

En-têtes : Cache-Control, X-Request-Id

Réponse 500 · application/problem+json

Problem

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

503 Une dépendance ou un enregistrement de configuration initiale requis est temporairement indisponible

En-têtes : Cache-Control, X-Request-Id

Réponse 503 · application/problem+json

Problem

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

Faire avancer la configuration initiale sans autoriser de retour en arrière

Authentification : cookieSession + csrfToken

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

Serveur : http://localhost:5000/v2

Corps de la requête · obligatoire

Schéma · application/json

UpdateOnboardingRequest

Schéma
{
  "$ref": "#/components/schemas/UpdateOnboardingRequest"
}

Réponses

200 État de la configuration initiale mis à jour

En-têtes : Cache-Control, X-Request-Id

Réponse 200 · application/json

OnboardingProgress

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

401 Authentification requise ou invalide

En-têtes : Cache-Control, X-Request-Id

Réponse 401 · application/problem+json

Problem

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

403 Authentification réussie, mais accès non autorisé, ou validation CSRF échouée

En-têtes : Cache-Control, X-Request-Id

Réponse 403 · application/problem+json

Problem

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

409 Conflit d’état de la ressource ou d’idempotence

En-têtes : Cache-Control, X-Request-Id

Réponse 409 · application/problem+json

Problem

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

422 Échec de la validation de la requête

En-têtes : Cache-Control, X-Request-Id

Réponse 422 · application/problem+json

Problem

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

500 Une erreur interne inattendue est survenue

En-têtes : Cache-Control, X-Request-Id

Réponse 500 · application/problem+json

Problem

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

503 Une dépendance ou un enregistrement de configuration initiale requis est temporairement indisponible

En-têtes : Cache-Control, X-Request-Id

Réponse 503 · application/problem+json

Problem

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

Vue d’ensemble

GET/overview

Lire les données agrégées du tableau de bord du compte

Authentification : cookieSession

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

Serveur : http://localhost:5000/v2

Réponses

200 Vue d’ensemble limitée au compte

En-têtes : Cache-Control, X-Request-Id

Réponse 200 · application/json

ConsoleOverview

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

401 Authentification requise ou invalide

En-têtes : Cache-Control, X-Request-Id

Réponse 401 · application/problem+json

Problem

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

500 Une erreur interne inattendue est survenue

En-têtes : Cache-Control, X-Request-Id

Réponse 500 · application/problem+json

Problem

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

503 Une dépendance ou un enregistrement de configuration initiale requis est temporairement indisponible

En-têtes : Cache-Control, X-Request-Id

Réponse 503 · application/problem+json

Problem

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

Clés API

GET/api-access/identity

Vérifier le propriétaire de la clé API actuelle et son aptitude aux tâches récurrentes

Lecture gratuite, authentifiée par la clé API dans l’en-tête uniquement. Renvoie les identifiants publics du compte et de la clé, ainsi que la propriété établie par le serveur. Aucun corps de requête. Ne modifie pas la réponse de métadonnées existante de /api-access. Partage la limite de 120 lectures de compte par minute. Si la vérification est indisponible, interrompez l’opération ; ne déduisez pas la propriété du préfixe de la clé, de l’offre ou de l’état local. Aucun paramètre d’URL n’est accepté. Les réponses utilisent no-store.

Authentification : dataApiKey

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

Serveur : http://localhost:5000/v2

Réponses

200 Vérifier le propriétaire de la clé API actuelle et son aptitude aux tâches récurrentes

Réponse 200 · application/json

APIKeyIdentity

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

400 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 400 · application/problem+json

Problem

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

401 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 401 · application/problem+json

Problem

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

403 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 403 · application/problem+json

Problem

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

409 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 409 · application/problem+json

Problem

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

410 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 410 · application/problem+json

Problem

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

422 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 422 · application/problem+json

Problem

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

429 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 429 · application/problem+json

Problem

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

503 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 503 · application/problem+json

Problem

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

Lister les métadonnées des clés API

Authentification : cookieSession

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

Serveur : http://localhost:5000/v2

Réponses

200 Clés API sans leurs secrets

Réponse 200 · application/json

ApiKey

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

Créer une clé API et révéler son secret une seule fois

Authentification : cookieSession + csrfToken

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

Serveur : http://localhost:5000/v2

Paramètres

Idempotency-Key · header · obligatoire

Schéma
Schéma
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

Corps de la requête · obligatoire

Schéma · application/json

CreateApiKeyRequest

Schéma
{
  "$ref": "#/components/schemas/CreateApiKeyRequest"
}

Réponses

201 Clé créée ; une répétition idempotente de la même requête peut récupérer la même réponse chiffrée pendant cinq minutes

Réponse 201 · application/json

ApiKeyCreated

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

403 Authentification réussie, mais accès non autorisé, ou validation CSRF échouée

Réponse 403 · application/problem+json

Problem

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

409 Conflit d’état de la ressource ou d’idempotence

Réponse 409 · application/problem+json

Problem

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

422 Échec de la validation de la requête

Réponse 422 · application/problem+json

Problem

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

503 Une dépendance ou un catalogue requis est temporairement indisponible

Réponse 503 · application/problem+json

Problem

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

Révoquer une clé API

Authentification : cookieSession + csrfToken

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

Serveur : http://localhost:5000/v2

Paramètres

keyId · path · obligatoire

Schéma
Schéma
{
  "type": "string",
  "pattern": "^key_"
}

Réponses

204 Clé révoquée

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

403 Authentification réussie, mais accès non autorisé, ou validation CSRF échouée

Réponse 403 · application/problem+json

Problem

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

404 Ressource introuvable ou n’appartenant pas au compte appelant

Réponse 404 · application/problem+json

Problem

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

503 Une dépendance ou un catalogue requis est temporairement indisponible

Réponse 503 · application/problem+json

Problem

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

Créer une clé de remplacement et planifier la révocation de l’ancienne

Crée une nouvelle clé et maintient l’ancienne active jusqu’à revokeOldAt. Par défaut, les deux clés restent actives pendant 24 heures, ou jusqu’à l’expiration de l’ancienne si elle survient plus tôt. Une valeur revokeOldAt personnalisée doit être future, dans les sept jours et au plus tard à l’expiration de l’ancienne clé.

Authentification : cookieSession + csrfToken

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

Serveur : http://localhost:5000/v2

Paramètres

keyId · path · obligatoire

Schéma
Schéma
{
  "type": "string",
  "pattern": "^key_"
}

Idempotency-Key · header · obligatoire

Schéma
Schéma
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

Corps de la requête · facultatif

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

Réponses

201 Clé de remplacement créée ; secret renvoyé une seule fois

Réponse 201 · application/json

ApiKeyCreated

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

403 Authentification réussie, mais accès non autorisé, ou validation CSRF échouée

Réponse 403 · application/problem+json

Problem

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

404 Ressource introuvable ou n’appartenant pas au compte appelant

Réponse 404 · application/problem+json

Problem

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

409 Conflit d’état de la ressource ou d’idempotence

Réponse 409 · application/problem+json

Problem

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

422 Échec de la validation de la requête

Réponse 422 · application/problem+json

Problem

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

503 Une dépendance ou un catalogue requis est temporairement indisponible

Réponse 503 · application/problem+json

Problem

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

Lire les sources autorisées par la clé API appelante et l’origine des résultats

Lecture gratuite, authentifiée uniquement par l’en-tête X-API-Key. Renvoie les noms des sources publiques autorisées et l’origine configurée du stockage des résultats signés (null si indisponible). Aucun identifiant de compte ou de clé, secret ou identifiant de stockage n’est renvoyé. Le serveur MCP local revérifie ce point d’accès avant chaque découverte ou appel d’outil, y compris pour lire un résultat en cache. Aucun paramètre de requête ni corps de requête n’est accepté. Toutes les routes /api-access partagent une limite de 120 requêtes par minute et par IP cliente et renvoient Cache-Control private, no-store. La dernière utilisation de la clé reste enregistrée.

Authentification : dataApiKey

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

Serveur : http://localhost:5000/v2

Réponses

200 Sources publiques autorisées et origine des résultats

Réponse 200 · application/json

ApiAccess

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

422 Échec de la validation de la requête

Réponse 422 · application/problem+json

Problem

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

429 Trop de lectures du compte ; réessayez après la fenêtre de limitation

503 Une dépendance ou un catalogue requis est temporairement indisponible

Réponse 503 · application/problem+json

Problem

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

Connexions d’agents

GET/agent-connections/capabilities

Vérifier la disponibilité du protocole 2 de configuration des agents

Aucun paramètre d’URL n’est accepté. Les réponses utilisent no-store. Ces routes agent sont réservées à l’API de gestion et dépendent de l’activation de la fonctionnalité ; elles peuvent renvoyer 404 si celle-ci est désactivée. X-API-Key est interdit sur ces routes.

Authentification : Public

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

Serveur : http://localhost:5000/v2

Réponses

200 Vérifier la disponibilité du protocole 2 de configuration des agents

Réponse 200 · application/json

AgentCapabilities

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

400 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 400 · application/problem+json

Problem

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

401 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 401 · application/problem+json

Problem

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

403 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 403 · application/problem+json

Problem

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

409 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 409 · application/problem+json

Problem

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

410 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 410 · application/problem+json

Problem

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

422 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 422 · application/problem+json

Problem

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

429 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 429 · application/problem+json

Problem

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

503 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 503 · application/problem+json

Problem

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

Créer ou récupérer une connexion temporaire avec clé API

Enregistrez la preuve d’inscription et les données exactes avant le POST. La même preuve et le même corps permettent de retrouver le même essai ; modifier les données provoque un conflit. Essai temporaire : 1 crédit, 72 heures, 1 requête par seconde et 1 élément par batch. Les autorisations par source sont appliquées par le serveur. Aucun paramètre d’URL n’est accepté. Les réponses utilisent no-store. Ces routes agent sont réservées à l’API de gestion et dépendent de l’activation de la fonctionnalité ; elles peuvent renvoyer 404 si celle-ci est désactivée. X-API-Key est interdit sur ces routes.

Authentification : agentRegistrationProof

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

Serveur : http://localhost:5000/v2

Corps de la requête · obligatoire

Schéma · application/json

AgentRegistrationRequest

Schéma
{
  "$ref": "#/components/schemas/AgentRegistrationRequest"
}

Réponses

201 Créer ou récupérer une connexion temporaire avec clé API

Réponse 201 · application/json

AgentRegistration

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

400 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 400 · application/problem+json

Problem

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

401 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 401 · application/problem+json

Problem

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

403 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 403 · application/problem+json

Problem

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

409 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 409 · application/problem+json

Problem

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

410 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 410 · application/problem+json

Problem

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

422 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 422 · application/problem+json

Problem

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

429 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 429 · application/problem+json

Problem

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

503 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 503 · application/problem+json

Problem

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

Lister les connexions du propriétaire depuis le navigateur

Aucun paramètre d’URL n’est accepté. Les réponses utilisent no-store. Ces routes agent sont réservées à l’API de gestion et dépendent de l’activation de la fonctionnalité ; elles peuvent renvoyer 404 si celle-ci est désactivée. X-API-Key est interdit sur ces routes. Opération réservée au navigateur du propriétaire. Une session complète d’un compte vérifié est requise ; l’appelant ne peut pas la remplacer par une clé API ou une preuve.

Authentification : cookieSession

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

Serveur : http://localhost:5000/v2

Réponses

200 Lister les connexions du propriétaire depuis le navigateur

Réponse 200 · application/json

AgentConnection

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

400 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 400 · application/problem+json

Problem

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

401 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 401 · application/problem+json

Problem

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

403 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 403 · application/problem+json

Problem

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

409 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 409 · application/problem+json

Problem

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

410 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 410 · application/problem+json

Problem

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

422 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 422 · application/problem+json

Problem

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

429 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 429 · application/problem+json

Problem

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

503 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 503 · application/problem+json

Problem

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

Lire l’état d’une connexion temporaire

Aucun paramètre d’URL n’est accepté. Les réponses utilisent no-store. Ces routes agent sont réservées à l’API de gestion et dépendent de l’activation de la fonctionnalité ; elles peuvent renvoyer 404 si celle-ci est désactivée. X-API-Key est interdit sur ces routes.

Authentification : agentSetupCredential

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

Serveur : http://localhost:5000/v2

Paramètres

connectionId · path · obligatoire

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

Réponses

200 Lire l’état d’une connexion temporaire

Réponse 200 · application/json

AgentConnectionResponse

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

400 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 400 · application/problem+json

Problem

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

401 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 401 · application/problem+json

Problem

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

403 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 403 · application/problem+json

Problem

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

409 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 409 · application/problem+json

Problem

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

410 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 410 · application/problem+json

Problem

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

422 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 422 · application/problem+json

Problem

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

429 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 429 · application/problem+json

Problem

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

503 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 503 · application/problem+json

Problem

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

Révoquer une connexion appartenant au compte

Aucun paramètre d’URL n’est accepté. Les réponses utilisent no-store. Ces routes agent sont réservées à l’API de gestion et dépendent de l’activation de la fonctionnalité ; elles peuvent renvoyer 404 si celle-ci est désactivée. X-API-Key est interdit sur ces routes. Opération réservée au navigateur du propriétaire. Une session complète d’un compte vérifié est requise ; l’appelant ne peut pas la remplacer par une clé API ou une preuve.

Authentification : cookieSession + csrfToken

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

Serveur : http://localhost:5000/v2

Paramètres

connectionId · path · obligatoire

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

Origin · header · obligatoire

Schéma
Schéma
{
  "type": "string"
}

X-CSRF-Token · header · obligatoire

Schéma
Schéma
{
  "type": "string"
}

Réponses

204 Révoquer une connexion appartenant au compte

400 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 400 · application/problem+json

Problem

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

401 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 401 · application/problem+json

Problem

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

403 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 403 · application/problem+json

Problem

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

409 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 409 · application/problem+json

Problem

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

410 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 410 · application/problem+json

Problem

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

422 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 422 · application/problem+json

Problem

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

429 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 429 · application/problem+json

Problem

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

503 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 503 · application/problem+json

Problem

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

Vérifier la clé actuelle de l’API de données pour une connexion

Aucun paramètre d’URL n’est accepté. Les réponses utilisent no-store. Ces routes agent sont réservées à l’API de gestion et dépendent de l’activation de la fonctionnalité ; elles peuvent renvoyer 404 si celle-ci est désactivée. X-API-Key est interdit sur ces routes.

Authentification : agentIdentityKey

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

Serveur : http://localhost:5000/v2

Paramètres

connectionId · path · obligatoire

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

Réponses

200 Vérifier la clé actuelle de l’API de données pour une connexion

Réponse 200 · application/json

AgentConnectionResponse

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

400 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 400 · application/problem+json

Problem

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

401 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 401 · application/problem+json

Problem

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

403 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 403 · application/problem+json

Problem

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

409 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 409 · application/problem+json

Problem

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

410 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 410 · application/problem+json

Problem

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

422 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 422 · application/problem+json

Problem

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

429 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 429 · application/problem+json

Problem

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

503 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 503 · application/problem+json

Problem

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

Lire l’état enregistré pour reprendre la configuration

Aucun paramètre d’URL n’est accepté. Les réponses utilisent no-store. Ces routes agent sont réservées à l’API de gestion et dépendent de l’activation de la fonctionnalité ; elles peuvent renvoyer 404 si celle-ci est désactivée. X-API-Key est interdit sur ces routes.

Authentification : agentHandoffProof

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

Serveur : http://localhost:5000/v2

Paramètres

connectionId · path · obligatoire

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

Réponses

200 Lire l’état enregistré pour reprendre la configuration

Réponse 200 · application/json

AgentOnboardingStatus

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

400 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 400 · application/problem+json

Problem

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

401 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 401 · application/problem+json

Problem

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

403 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 403 · application/problem+json

Problem

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

409 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 409 · application/problem+json

Problem

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

410 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 410 · application/problem+json

Problem

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

422 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 422 · application/problem+json

Problem

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

429 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 429 · application/problem+json

Problem

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

503 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 503 · application/problem+json

Problem

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

Créer une demande de rattachement à approuver dans le navigateur

Ouvrez claimPath sur une origine web FlashData de confiance et affichez le code séparément. Ne placez jamais d’identifiants ni le code de confirmation dans l’URL. Aucun paramètre d’URL n’est accepté. Les réponses utilisent no-store. Ces routes agent sont réservées à l’API de gestion et dépendent de l’activation de la fonctionnalité ; elles peuvent renvoyer 404 si celle-ci est désactivée. X-API-Key est interdit sur ces routes.

Authentification : agentSetupCredential

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

Serveur : http://localhost:5000/v2

Paramètres

connectionId · path · obligatoire

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

Corps de la requête · obligatoire

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

Réponses

201 Créer une demande de rattachement à approuver dans le navigateur

Réponse 201 · application/json

AgentClaim

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

400 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 400 · application/problem+json

Problem

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

401 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 401 · application/problem+json

Problem

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

403 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 403 · application/problem+json

Problem

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

409 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 409 · application/problem+json

Problem

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

410 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 410 · application/problem+json

Problem

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

422 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 422 · application/problem+json

Problem

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

429 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 429 · application/problem+json

Problem

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

503 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 503 · application/problem+json

Problem

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

Confirmer le code de rattachement dans une session de navigateur vérifiée

Aucun paramètre d’URL n’est accepté. Les réponses utilisent no-store. Ces routes agent sont réservées à l’API de gestion et dépendent de l’activation de la fonctionnalité ; elles peuvent renvoyer 404 si celle-ci est désactivée. X-API-Key est interdit sur ces routes. Opération réservée au navigateur du propriétaire. Une session complète d’un compte vérifié est requise ; l’appelant ne peut pas la remplacer par une clé API ou une preuve.

Authentification : cookieSession + csrfToken

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

Serveur : http://localhost:5000/v2

Paramètres

claimId · path · obligatoire

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

Origin · header · obligatoire

Schéma
Schéma
{
  "type": "string"
}

X-CSRF-Token · header · obligatoire

Schéma
Schéma
{
  "type": "string"
}

Corps de la requête · obligatoire

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

Réponses

200 Confirmer le code de rattachement dans une session de navigateur vérifiée

Réponse 200 · application/json

AgentBrowserClaim

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

400 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 400 · application/problem+json

Problem

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

401 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 401 · application/problem+json

Problem

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

403 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 403 · application/problem+json

Problem

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

409 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 409 · application/problem+json

Problem

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

410 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 410 · application/problem+json

Problem

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

422 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 422 · application/problem+json

Problem

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

429 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 429 · application/problem+json

Problem

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

503 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 503 · application/problem+json

Problem

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

Lire une demande de rattachement confirmée dans sa session de navigateur

Aucun paramètre d’URL n’est accepté. Les réponses utilisent no-store. Ces routes agent sont réservées à l’API de gestion et dépendent de l’activation de la fonctionnalité ; elles peuvent renvoyer 404 si celle-ci est désactivée. X-API-Key est interdit sur ces routes. Opération réservée au navigateur du propriétaire. Une session complète d’un compte vérifié est requise ; l’appelant ne peut pas la remplacer par une clé API ou une preuve.

Authentification : cookieSession

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

Serveur : http://localhost:5000/v2

Paramètres

claimId · path · obligatoire

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

Réponses

200 Lire une demande de rattachement confirmée dans sa session de navigateur

Réponse 200 · application/json

AgentClaimView

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

400 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 400 · application/problem+json

Problem

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

401 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 401 · application/problem+json

Problem

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

403 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 403 · application/problem+json

Problem

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

409 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 409 · application/problem+json

Problem

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

410 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 410 · application/problem+json

Problem

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

422 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 422 · application/problem+json

Problem

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

429 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 429 · application/problem+json

Problem

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

503 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 503 · application/problem+json

Problem

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

Approuver un périmètre de permissions réduit et l’utilisation du solde du compte

Aucun paramètre d’URL n’est accepté. Les réponses utilisent no-store. Ces routes agent sont réservées à l’API de gestion et dépendent de l’activation de la fonctionnalité ; elles peuvent renvoyer 404 si celle-ci est désactivée. X-API-Key est interdit sur ces routes. Opération réservée au navigateur du propriétaire. Une session complète d’un compte vérifié est requise ; l’appelant ne peut pas la remplacer par une clé API ou une preuve.

Authentification : cookieSession + csrfToken

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

Serveur : http://localhost:5000/v2

Paramètres

claimId · path · obligatoire

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

Origin · header · obligatoire

Schéma
Schéma
{
  "type": "string"
}

X-CSRF-Token · header · obligatoire

Schéma
Schéma
{
  "type": "string"
}

Corps de la requête · obligatoire

Schéma · application/json

AgentApproval

Schéma
{
  "$ref": "#/components/schemas/AgentApproval"
}

Réponses

200 Approuver un périmètre de permissions réduit et l’utilisation du solde du compte

Réponse 200 · application/json

AgentConnection

Réponse 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 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 400 · application/problem+json

Problem

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

401 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 401 · application/problem+json

Problem

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

403 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 403 · application/problem+json

Problem

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

409 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 409 · application/problem+json

Problem

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

410 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 410 · application/problem+json

Problem

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

422 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 422 · application/problem+json

Problem

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

429 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 429 · application/problem+json

Problem

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

503 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 503 · application/problem+json

Problem

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

Récupérer la clé API du propriétaire après approbation

La clé candidate expire au bout de 24 heures tant que son installation n’est pas confirmée par un ACK. Enregistrez-la de manière atomique, relisez-la dans un nouveau processus et vérifiez l’identité avant l’ACK. Répéter la récupération renvoie la même clé candidate ; une fois l’installation confirmée, seul un reçu sans identifiants est renvoyé. Aucun paramètre d’URL n’est accepté. Les réponses utilisent no-store. Ces routes agent sont réservées à l’API de gestion et dépendent de l’activation de la fonctionnalité ; elles peuvent renvoyer 404 si celle-ci est désactivée. X-API-Key est interdit sur ces routes.

Authentification : agentHandoffProof

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

Serveur : http://localhost:5000/v2

Paramètres

connectionId · path · obligatoire

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

Corps de la requête · obligatoire

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

Réponses

200 Récupérer la clé API du propriétaire après approbation

Réponse 200 · application/json

AgentHandoff

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

400 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 400 · application/problem+json

Problem

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

401 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 401 · application/problem+json

Problem

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

403 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 403 · application/problem+json

Problem

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

409 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 409 · application/problem+json

Problem

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

410 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 410 · application/problem+json

Problem

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

422 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 422 · application/problem+json

Problem

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

429 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 429 · application/problem+json

Problem

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

503 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 503 · application/problem+json

Problem

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

Confirmer l’installation vérifiée de la clé du propriétaire

L’appelant doit avoir enregistré la clé candidate et l’avoir vérifiée indépendamment dans un nouveau processus. Un ACK réussi marque l’installation, supprime l’expiration de la clé candidate et efface les données permettant de récupérer les identifiants. Répéter l’ACK est idempotent. Aucun paramètre d’URL n’est accepté. Les réponses utilisent no-store. Ces routes agent sont réservées à l’API de gestion et dépendent de l’activation de la fonctionnalité ; elles peuvent renvoyer 404 si celle-ci est désactivée. X-API-Key est interdit sur ces routes.

Authentification : agentHandoffProof

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

Serveur : http://localhost:5000/v2

Paramètres

connectionId · path · obligatoire

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

Corps de la requête · obligatoire

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

Réponses

200 Confirmer l’installation vérifiée de la clé du propriétaire

Réponse 200 · application/json

AgentHandoff

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

400 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 400 · application/problem+json

Problem

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

401 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 401 · application/problem+json

Problem

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

403 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 403 · application/problem+json

Problem

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

409 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 409 · application/problem+json

Problem

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

410 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 410 · application/problem+json

Problem

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

422 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 422 · application/problem+json

Problem

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

429 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 429 · application/problem+json

Problem

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

503 Requête rejetée ; examinez le code Problem. Ne répétez jamais aveuglément une opération qui modifie l’état.

Réponse 503 · application/problem+json

Problem

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

Catalogue

GET/catalog/sources

Lister les capacités des sources publiques, sans les tarifs propres au compte

Authentification : Public

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

Serveur : http://localhost:5000/v2

Réponses

200 Catalogue public des sources

En-têtes : Cache-Control

Réponse 200 · application/json

DataSource

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

Lister les offres et les tarifs publics en USD

Authentification : Public

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

Serveur : http://localhost:5000/v2

Réponses

200 Catalogue public des offres

En-têtes : Cache-Control

Réponse 200 · application/json

PlanCatalog

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

Lire les versions des conditions d’utilisation et de la politique de confidentialité requises pour l’inscription

Authentification : Public

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

Serveur : http://localhost:5000/v2

Réponses

200 Versions en vigueur des documents juridiques

En-têtes : Cache-Control

Réponse 200 · application/json

PublicLegalVersions

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

Facturation

GET/billing/subscription

Lire l’abonnement Stripe applicable au compte

Authentification : cookieSession

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

Serveur : http://localhost:5000/v2

Réponses

200 Abonnement ou droits Pay As You Go

Réponse 200 · application/json

Subscription

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

Créer une session de paiement hébergée par Stripe Checkout

Les abonnements et les packs de crédits publiés utilisent priceId. Une recharge personnalisée utilise amountMinor à la place, en cents USD, pour un montant compris entre 10 et 999 999,99 USD. Le serveur calcule les crédits selon leur valeur fixe et crée un tarif Stripe privé à usage unique. Le produit, le tarif du fournisseur, la devise et les URL de succès ou d’annulation ne sont jamais acceptés depuis le navigateur. Les crédits ne sont accordés qu’après vérification d’un événement de paiement correspondant au montant annoncé.

Authentification : cookieSession + csrfToken

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

Serveur : http://localhost:5000/v2

Paramètres

Idempotency-Key · header · obligatoire

Schéma
Schéma
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

Corps de la requête · obligatoire

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

Réponses

201 Session Stripe Checkout

Réponse 201 · application/json

HostedSession

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

403 Authentification réussie, mais accès non autorisé, ou validation CSRF échouée

Réponse 403 · application/problem+json

Problem

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

409 Conflit d’état de la ressource ou d’idempotence

Réponse 409 · application/problem+json

Problem

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

422 Échec de la validation de la requête

Réponse 422 · application/problem+json

Problem

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

502 Un fournisseur en amont a échoué

Réponse 502 · application/problem+json

Problem

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

503 Le catalogue de facturation ou le fournisseur n’est pas configuré, ou est temporairement indisponible

Réponse 503 · application/problem+json

Problem

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

Passer l’abonnement Stripe actuel à un tarif publié supérieur

Le serveur vérifie que le tarif FlashData est actif, disponible dans le mode livemode actuel, libellé en USD, récurrent, de même périodicité et strictement supérieur au tarif de l’abonnement actuel. Le produit, le tarif du fournisseur, la devise et les options de prorata ne sont jamais acceptés depuis le navigateur. Les droits et crédits locaux ne changent qu’après intégration d’un événement vérifié du fournisseur.

Authentification : cookieSession + csrfToken

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

Serveur : http://localhost:5000/v2

Paramètres

Idempotency-Key · header · obligatoire

Schéma
Schéma
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

Corps de la requête · obligatoire

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

Réponses

201 Changement d’abonnement soumis à Stripe

Réponse 201 · application/json

SubscriptionChange

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

403 Authentification réussie, mais accès non autorisé, ou validation CSRF échouée

Réponse 403 · application/problem+json

Problem

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

404 Ressource introuvable ou n’appartenant pas au compte appelant

Réponse 404 · application/problem+json

Problem

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

409 Conflit d’état de la ressource ou d’idempotence

Réponse 409 · application/problem+json

Problem

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

422 Échec de la validation de la requête

Réponse 422 · application/problem+json

Problem

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

502 Un fournisseur en amont a échoué

Réponse 502 · application/problem+json

Problem

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

503 Le catalogue de facturation ou le fournisseur n’est pas configuré, ou est temporairement indisponible

Réponse 503 · application/problem+json

Problem

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

Créer une session du portail client Stripe

Authentification : cookieSession + csrfToken

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

Serveur : http://localhost:5000/v2

Paramètres

Idempotency-Key · header · obligatoire

Schéma
Schéma
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

Réponses

201 Session du portail client Stripe

Réponse 201 · application/json

HostedSession

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

403 Authentification réussie, mais accès non autorisé, ou validation CSRF échouée

Réponse 403 · application/problem+json

Problem

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

404 Ressource introuvable ou n’appartenant pas au compte appelant

Réponse 404 · application/problem+json

Problem

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

409 Conflit d’état de la ressource ou d’idempotence

Réponse 409 · application/problem+json

Problem

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

502 Un fournisseur en amont a échoué

Réponse 502 · application/problem+json

Problem

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

503 Le catalogue de facturation ou le fournisseur n’est pas configuré, ou est temporairement indisponible

Réponse 503 · application/problem+json

Problem

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

Planifier ou annuler la résiliation de l’abonnement payant actuel

Définir cancelAtPeriodEnd sur true planifie la résiliation à la fin de la période de facturation actuelle ; false maintient l’abonnement. Les droits sont mis à jour après réception d’un événement d’abonnement Stripe vérifié. Ce point d’accès n’effectue jamais de résiliation immédiate ni de remboursement.

Authentification : cookieSession + csrfToken

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

Serveur : http://localhost:5000/v2

Paramètres

Idempotency-Key · header · obligatoire

Schéma
Schéma
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

Corps de la requête · obligatoire

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

Réponses

202 Modification de la résiliation soumise à Stripe

Réponse 202 · application/json

SubscriptionCancellationChange

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

403 Authentification réussie, mais accès non autorisé, ou validation CSRF échouée

Réponse 403 · application/problem+json

Problem

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

404 Ressource introuvable ou n’appartenant pas au compte appelant

Réponse 404 · application/problem+json

Problem

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

409 Conflit d’état de la ressource ou d’idempotence

Réponse 409 · application/problem+json

Problem

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

422 Échec de la validation de la requête

Réponse 422 · application/problem+json

Problem

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

502 Un fournisseur en amont a échoué

Réponse 502 · application/problem+json

Problem

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

503 Le catalogue de facturation ou le fournisseur n’est pas configuré, ou est temporairement indisponible

Réponse 503 · application/problem+json

Problem

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

Lister les enregistrements locaux des factures Stripe

Authentification : cookieSession

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

Serveur : http://localhost:5000/v2

Paramètres

cursor · query · facultatif

Schéma
Schéma
{
  "type": "string",
  "maxLength": 512
}

limit · query · facultatif

Schéma
Schéma
{
  "type": "integer",
  "minimum": 1,
  "maximum": 100,
  "default": 50
}

Réponses

200 Factures

Réponse 200 · application/json

Invoice · Page

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

Lister les enregistrements locaux des paiements de recharge et des remboursements du compte

Authentification : cookieSession

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

Serveur : http://localhost:5000/v2

Paramètres

cursor · query · facultatif

Schéma
Schéma
{
  "type": "string",
  "maxLength": 512
}

limit · query · facultatif

Schéma
Schéma
{
  "type": "integer",
  "minimum": 1,
  "maximum": 100,
  "default": 50
}

Réponses

200 Historique des paiements ponctuels, sans secrets du fournisseur

Réponse 200 · application/json

BillingPaymentPage

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

Crédits

GET/api-access/balance

Lire le solde actuel du compte avec une clé API

Lisez le solde actuel de crédits, partagé par toutes les clés API de votre compte. Les réservations actives peuvent réduire le solde disponible. Cette lecture ne coûte aucun crédit et n’accepte ni paramètre d’URL ni corps de requête. Les réponses sont privées et ne sont pas mises en cache ; les limites de débit des lectures de compte s’appliquent.

Authentification : dataApiKey

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

Serveur : http://localhost:5000/v2

Réponses

200 Solde pouvant être négatif et crédits disponibles non négatifs

Réponse 200 · application/json

ApiAccessBalance

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

422 Échec de la validation de la requête

Réponse 422 · application/problem+json

Problem

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

429 Trop de lectures du compte ; réessayez après la fenêtre de limitation

503 Une dépendance ou un catalogue requis est temporairement indisponible

Réponse 503 · application/problem+json

Problem

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

Lire les tarifs réels du compte pour les sources autorisées par la clé API

Lisez les tarifs de votre compte pour les sources autorisées par la clé API. Un prix null signifie que la source est indisponible. request_count compte les requêtes, pas les éléments renvoyés ; les tarifs de téléchargement sont exprimés par TB (10^12 octets). Les estimations ne réservent ni crédits ni capacité. Cette lecture ne coûte aucun crédit. Les réponses sont privées et ne sont pas mises en cache ; les limites de débit des lectures de compte s’appliquent.

Authentification : dataApiKey

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

Serveur : http://localhost:5000/v2

Paramètres

source · query · facultatif

Une source autorisée par cette clé. Omettez ce paramètre pour lire toutes les sources autorisées.

Schéma

ApiAccessSource

Schéma
{
  "$ref": "#/components/schemas/ApiAccessSource"
}

request_count · query · facultatif

Nombre entier d’appels, écrit en base dix ; n’estime pas la taille d’un téléchargement.

Schéma
Schéma
{
  "type": "integer",
  "minimum": 1,
  "maximum": 100000,
  "default": 1
}

Réponses

200 Offre du compte et tarifs par source

Réponse 200 · application/json

ApiAccessPricing

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

403 Authentification réussie, mais accès non autorisé, ou validation CSRF échouée

Réponse 403 · application/problem+json

Problem

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

422 Échec de la validation de la requête

Réponse 422 · application/problem+json

Problem

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

429 Trop de lectures du compte ; réessayez après la fenêtre de limitation

503 Une dépendance ou un catalogue requis est temporairement indisponible

Réponse 503 · application/problem+json

Problem

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

Lire les limites de l’offre et le nombre actuel de tâches en attente avec une clé API

Lisez les limites de requêtes simultanées, de taille de batch et de tâches en attente, ainsi que le nombre actuel de tâches en attente. Ces valeurs aident à planifier les requêtes, mais ne réservent aucune capacité. Cette lecture ne coûte aucun crédit et n’accepte ni paramètre d’URL ni corps de requête. Les réponses sont privées et ne sont pas mises en cache ; les limites de débit des lectures de compte s’appliquent.

Authentification : dataApiKey

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

Serveur : http://localhost:5000/v2

Réponses

200 Plafonds de l’offre et nombre actuel de tâches en attente

Réponse 200 · application/json

ApiAccessLimits

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

422 Échec de la validation de la requête

Réponse 422 · application/problem+json

Problem

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

429 Trop de lectures du compte ; réessayez après la fenêtre de limitation

503 Une dépendance ou un catalogue requis est temporairement indisponible

Réponse 503 · application/problem+json

Problem

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

Lire la consommation du compte pour les sources autorisées par la clé API

Lecture gratuite, authentifiée uniquement par X-API-Key. Inclut toutes les clés du compte, mais uniquement les sources autorisées pour la clé appelante. Ne renvoie ni texte de requête, ni clés secrètes, ni données de paiement, ni autres comptes. Période par défaut : sept jours ; maximum : 31 jours. Les dates doivent être des horodatages UTC Z. La borne from est incluse et to est exclue ; les deux sont arrondies à la minute inférieure. Avec from seul, to vaut from + 7 jours. Sans ces paramètres, to correspond au début de la minute suivante. Les agrégats sont mis à jour progressivement : même updating=false ne garantit pas l’intégration de tous les événements récents. Limite de lecture : 60 requêtes par minute et par IP cliente.

Authentification : dataApiKey

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

Serveur : http://localhost:5000/v2

Paramètres

source · query · facultatif

Nom exact d’une source du catalogue autorisée par la clé appelante. Omettez ce paramètre pour inclure toutes les sources autorisées.

Schéma
Schéma
{
  "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 · facultatif

Schéma
Schéma
{
  "type": "string",
  "format": "date-time"
}

to · query · facultatif

Schéma
Schéma
{
  "type": "string",
  "format": "date-time"
}

Réponses

200 Nombre de requêtes et crédits facturés dans le périmètre autorisé, avec indication de l’actualisation des données

Réponse 200 · application/json

ApiKeyUsage

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

403 Authentification réussie, mais accès non autorisé, ou validation CSRF échouée

Réponse 403 · application/problem+json

Problem

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

422 Échec de la validation de la requête

Réponse 422 · application/problem+json

Problem

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

429 Trop de lectures de la consommation ; réessayez après la fenêtre de limitation

503 Une dépendance ou un catalogue requis est temporairement indisponible

Réponse 503 · application/problem+json

Problem

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

Lire les crédits actuellement disponibles et réservés

Authentification : cookieSession

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

Serveur : http://localhost:5000/v2

Réponses

200 Solde de crédits

Réponse 200 · application/json

CreditBalance

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

Lire les règles d’attribution et de facturation des crédits applicables au compte

Authentification : cookieSession

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

Serveur : http://localhost:5000/v2

Réponses

200 Règles applicables aux crédits

Réponse 200 · application/json

CreditPolicy

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

Lister les écritures du registre de crédits

Authentification : cookieSession

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

Serveur : http://localhost:5000/v2

Paramètres

cursor · query · facultatif

Schéma
Schéma
{
  "type": "string",
  "maxLength": 512
}

limit · query · facultatif

Schéma
Schéma
{
  "type": "integer",
  "minimum": 1,
  "maximum": 100,
  "default": 50
}

type · query · facultatif

Schéma

CreditEntryType

Schéma
{
  "$ref": "#/components/schemas/CreditEntryType"
}

Réponses

200 Écritures du registre

Réponse 200 · application/json

CreditTransaction · Page

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

Crédits d’essai

GET/trial-credit-request

Lire l’éligibilité aux crédits d’essai et la demande unique du compte

Authentification : cookieSession

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

Serveur : http://localhost:5000/v2

Réponses

200 Éligibilité actuelle, montant configuré et état de la demande

En-têtes : Cache-Control

Réponse 200 · application/json

TrialCreditState

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

401 Authentification requise ou invalide

En-têtes : Cache-Control, X-Request-Id

Réponse 401 · application/problem+json

Problem

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

500 Une erreur interne inattendue est survenue

En-têtes : Cache-Control, X-Request-Id

Réponse 500 · application/problem+json

Problem

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

503 Une dépendance ou un enregistrement de configuration initiale requis est temporairement indisponible

En-têtes : Cache-Control, X-Request-Id

Réponse 503 · application/problem+json

Problem

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

Soumettre l’unique demande de crédits d’essai autorisée sur la durée de vie du compte

Le montant des crédits d’essai et le cas d’usage sont enregistrés lors de la soumission de la demande.

Authentification : cookieSession + csrfToken

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

Serveur : http://localhost:5000/v2

Paramètres

Idempotency-Key · header · obligatoire

Schéma
Schéma
{
  "type": "string",
  "minLength": 1,
  "maxLength": 255
}

Corps de la requête · facultatif

Schéma · application/json
Schéma
{
  "type": "object",
  "additionalProperties": false
}

Réponses

201 Demande de crédits d’essai créée et automatiquement approuvée pour les comptes vérifiés éligibles, quel que soit le fournisseur de messagerie

En-têtes : Cache-Control

Réponse 201 · application/json

TrialCreditState

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

401 Authentification requise ou invalide

En-têtes : Cache-Control, X-Request-Id

Réponse 401 · application/problem+json

Problem

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

403 Authentification réussie, mais accès non autorisé, ou validation CSRF échouée

En-têtes : Cache-Control, X-Request-Id

Réponse 403 · application/problem+json

Problem

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

409 Conflit d’état de la ressource ou d’idempotence

En-têtes : Cache-Control, X-Request-Id

Réponse 409 · application/problem+json

Problem

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

422 Échec de la validation de la requête

En-têtes : Cache-Control, X-Request-Id

Réponse 422 · application/problem+json

Problem

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

500 Une erreur interne inattendue est survenue

En-têtes : Cache-Control, X-Request-Id

Réponse 500 · application/problem+json

Problem

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

503 Une dépendance ou un enregistrement de configuration initiale requis est temporairement indisponible

En-têtes : Cache-Control, X-Request-Id

Réponse 503 · application/problem+json

Problem

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

Livraison

GET/delivery/webhooks

Lister les URL enregistrées pour les callbacks de fin de traitement

Authentification : cookieSession

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

Serveur : http://localhost:5000/v2

Réponses

200 URL de callback

Réponse 200 · application/json

DeliveryWebhook

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

Enregistrer une URL de callback de fin de traitement

Authentification : cookieSession + csrfToken

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

Serveur : http://localhost:5000/v2

Corps de la requête · obligatoire

Schéma · application/json

CreateDeliveryWebhookRequest

Schéma
{
  "$ref": "#/components/schemas/CreateDeliveryWebhookRequest"
}

Réponses

201 Ressource créée

Réponse 201 · application/json

DeliveryWebhook

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

422 Échec de la validation de la requête

Réponse 422 · application/problem+json

Problem

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

Supprimer une URL de callback de fin de traitement

Authentification : cookieSession + csrfToken

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

Serveur : http://localhost:5000/v2

Paramètres

webhookId · path · obligatoire

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

Réponses

204 Ressource supprimée

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

404 Ressource introuvable ou n’appartenant pas au compte appelant

Réponse 404 · application/problem+json

Problem

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

Envoyer un exemple de notification de téléchargement terminé

Authentification : cookieSession + csrfToken

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

Serveur : http://localhost:5000/v2

Paramètres

webhookId · path · obligatoire

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

Réponses

200 Envoi de test tenté

Réponse 200 · application/json

DeliveryWebhook

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

404 Ressource introuvable ou n’appartenant pas au compte appelant

Réponse 404 · application/problem+json

Problem

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

Tâches

Pour des exemples de soumission, de suivi et de récupération des résultats, consultez Temps réel et asynchrone · Requêtes Batch.

GET/jobs

Lister les tâches de l’API de données pour l’espace de travail actuel

Historique actif et archivé, paginé par curseur. La période par défaut couvre les sept derniers jours ; chaque plage de dates UTC est limitée à 31 jours. La borne from est incluse et to est exclue, avec une précision à la minute. Les résumés sont mis à jour de manière asynchrone et peuvent avoir du retard sur l’ingestion.

Authentification : cookieSession

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

Serveur : http://localhost:5000/v2

Paramètres

cursor · query · facultatif

Schéma
Schéma
{
  "type": "string",
  "minLength": 1,
  "maxLength": 512
}

limit · query · facultatif

Schéma
Schéma
{
  "type": "integer",
  "minimum": 1,
  "maximum": 50
}

source · query · facultatif

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

status · query · facultatif

Schéma
Schéma
{
  "type": "string",
  "enum": [
    "completed",
    "failed",
    "pending",
    "processing"
  ]
}

mode · query · facultatif

Schéma
Schéma
{
  "type": "string",
  "enum": [
    "async",
    "batch",
    "realtime"
  ]
}

from · query · facultatif

Schéma
Schéma
{
  "type": "string",
  "format": "date-time"
}

to · query · facultatif

Schéma
Schéma
{
  "type": "string",
  "format": "date-time"
}

Réponses

200 Page de résultats contenant les tâches

Réponse 200 · application/json

ConsoleJob · Pagination

Réponse 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 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

422 Échec de la validation de la requête

Réponse 422 · application/problem+json

Problem

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

Lire une tâche de l’API de données

Lisez job.status pour suivre la progression et job.error en cas d’échec. JSON est utilisé par défaut ; choisissez Accept: text/plain pour du texte lisible. X-Respond-With est ignoré ici. Respectez Retry-After lorsqu’il est fourni avant de vérifier à nouveau.

Authentification : cookieSession ou dataApiKey

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

Serveur : http://localhost:5000/v2

Paramètres

Accept · header · facultatif

application/json renvoie la réponse structurée d’origine ; text/plain renvoie les mêmes champs sous forme de texte brut indenté. Les plages de types de médias et les pondérations q standard sont prises en charge. Sans Accept, ou avec un joker global, JSON est utilisé. X-Respond-With est ignoré sur les points d’accès de soumission et d’état des tâches. Les erreurs restent en JSON structuré. Les deux types de réponse utilisent UTF-8 ; le paramètre explicite charset=utf-8 est pris en charge.

Schéma
Schéma
{
  "type": "string"
}

jobId · path · obligatoire

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

Réponses

200 Détails de la tâche

Réponse 200 · application/json

ConsoleJob

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

404 Ressource introuvable ou n’appartenant pas au compte appelant

Réponse 404 · application/problem+json

Problem

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

406 Ni application/json ni text/plain ne sont acceptables ; la réponse est en JSON

Réponse 406 · application/json

QueryRepresentationError

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

Télécharger le résultat d’une tâche asynchrone terminée

Par défaut, l’accès est authentifié puis redirigé vers une URL R2 privée à durée de vie limitée ; le client reçoit le JSON d’origine directement depuis R2. Accept: text/plain renvoie HTTP 200 avec les champs d’origine sous forme de texte brut indenté. X-Respond-With: markdown sélectionne le contenu Markdown : application/json le place dans content avec les métadonnées d’origine, en remplacement de results ; text/plain renvoie les métadonnées suivies du Markdown. Sans Accept, ou avec un joker global, JSON est utilisé. Le formatage ne soumet aucune nouvelle requête et ne consomme aucun crédit de requête. Les résultats stockés expirent 24 heures après la fin du traitement. Les erreurs restent en JSON structuré.

Authentification : cookieSession ou dataApiKey

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

Serveur : http://localhost:5000/v2

Paramètres

X-Respond-With · header · facultatif

Définissez la valeur sur markdown pour renvoyer le contenu du résultat en Markdown. Omettez cet en-tête pour conserver les champs d’origine. Accept sélectionne indépendamment JSON ou le texte brut. Seules les requêtes realtime et la lecture des résultats de tâches terminées prennent cet en-tête en charge. Il ne modifie pas les soumissions de tâches, leur état, les API de compte, les callbacks, les fichiers Bulk, les téléchargements binaires ni les réponses du protocole MCP.

Schéma
Schéma
{
  "type": "string",
  "enum": [
    "markdown"
  ]
}

Accept · header · facultatif

Sélectionnez application/json ou text/plain indépendamment de X-Respond-With. Sans X-Respond-With, text/plain renvoie les champs d’origine indentés ; JSON conserve les champs de réponse d’origine et la lecture des résultats terminés redirige vers le stockage. Avec markdown, JSON renvoie content et les métadonnées, tandis que le texte brut contient les métadonnées suivies du Markdown. Les plages de types de médias et les pondérations q standard sont prises en charge. Sans Accept, ou avec un joker global, JSON est utilisé. Les deux types de réponse utilisent UTF-8 ; le paramètre explicite charset=utf-8 est pris en charge.

Schéma
Schéma
{
  "type": "string"
}

jobId · path · obligatoire

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

Réponses

200 Champs d’origine en texte brut ou contenu Markdown renvoyés directement ; JSON d’origine récupéré depuis R2 après la redirection par défaut

Réponse 200 · application/json

MarkdownQueryResult

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

302 Redirection vers le JSON d’origine dans le stockage R2 privé lorsque JSON est sélectionné sans X-Respond-With

En-têtes : Location

400 Valeur X-Respond-With non prise en charge ; la réponse est en JSON

Réponse 400 · application/json

QueryRepresentationError

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

404 Ressource introuvable ou n’appartenant pas au compte appelant

Réponse 404 · application/problem+json

Problem

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

406 Ni application/json ni text/plain ne sont acceptables ; la réponse est en JSON

Réponse 406 · application/json

QueryRepresentationError

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

409 Conflit d’état de la ressource ou d’idempotence

Réponse 409 · application/problem+json

Problem

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

410 Résultat expiré

Réponse 410 · application/problem+json

Problem

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

422 La tâche a échoué. Le champ detail de la réponse contient le motif enregistré, s’il est disponible.

Réponse 422 · application/problem+json

Problem

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

503 Une dépendance ou un catalogue requis est temporairement indisponible

Réponse 503 · application/problem+json

Problem

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

API de traitement Bulk

Les points d’accès Bulk disposent d’une référence dédiée, avec leurs paramètres, exemples de requête et schémas de réponse. Ouvrir la référence de l’API Bulk

Playground

POST/playground/run

Exécuter une requête du playground pour l’espace de travail actuel

Authentification : cookieSession + csrfToken

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

Serveur : http://localhost:5000/v2

Corps de la requête · obligatoire

Schéma · application/json
Schéma
{
  "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
    }
  }
}

Réponses

200 Réponse de l’API de données récupérée pour le playground

Réponse 200 · application/json
Réponse 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 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

422 Échec de la validation de la requête

Réponse 422 · application/problem+json

Problem

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

Télécharger un fichier de résultat du playground dans le navigateur actuel

Authentification : cookieSession

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

Serveur : http://localhost:5000/v2

Paramètres

jobId · path · obligatoire

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

Réponses

200 Fichier temporaire à télécharger dans le navigateur

En-têtes : Content-Disposition, Content-Length

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

401 Authentification requise ou invalide

Réponse 401 · application/problem+json

Problem

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

404 Ressource introuvable ou n’appartenant pas au compte appelant

Réponse 404 · application/problem+json

Problem

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

409 Conflit d’état de la ressource ou d’idempotence

Réponse 409 · application/problem+json

Problem

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

410 Le fichier temporaire a expiré

Réponse 410 · application/problem+json

Problem

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

503 Une dépendance ou un catalogue requis est temporairement indisponible

Réponse 503 · application/problem+json

Problem

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

Définitions des schémas

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