Explorar documentación
Referencia de la API
Administración API referencia
Busque puntos finales para cuentas, claves, facturación y trabajos. Cada punto final enumera sus propios requisitos de autenticación y acceso.
Lea su cuenta con una tecla API
La base de gestión API URL es https://api.flashdata.dev/v2. Esta lectura gratuita devuelve la clave actual y cuenta IDs y propiedad. Establecer FLASHDATA_API_KEY antes de ejecutar el comando.
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'Espere HTTP 200 sobre el éxito. Compruebe la línea de autenticación de cada punto final: dataApiKey utiliza X-API-Key; cookieSession utiliza una sesión de navegador registrada. Plan de respuesta a la identidad
Descargar la especificación del cliente OpenAPICubre consultas, trabajos, cuentas, claves API y facturación.
Los parámetros de consulta y el código de solicitud se documentan en el Google y YouTube Referencias API.
Planes de autenticación
| Plan | Requisitos |
|---|---|
dataApiKey |
FlashData API Key. El acceso al trabajo está restringido a los alcances de la fuente de la clave. |
cookieSession |
Opaque Web session. El navegador no puede leer esta cookie. |
csrfToken |
apiKey |
agentRegistrationProof | Persiste una prueba de base de 64url criptográficamente aleatoria 32-byte y petición exacta BEFORE envio; recuperar sólo con la misma prueba y cuerpo. No una ficha OAuth. |
agentSetupCredential | Credencial de configuración temporal para la creación de estado y de reclamación solamente. No es una clave API de datos. |
agentHandoffProof | Prueba utilizada para recuperar la llave del propietario y reconocer la instalación. Nunca enviado a una consulta de datos. |
agentIdentityKey | La clave Ordinary FlashData API en Authorization Bearer, sólo en identidad de agente. Las consultas de datos utilizan X-API-Key en su lugar. |
Sistema
GET/health
Salud de los servicios
Autenticación: Público
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respuestas
200 Salud
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/Health"
}GET/status
Leer el resumen del estado del componente público
Autenticación: Público
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respuestas
200 Resumen de la situación pública
Cabeceras: Cache-Control
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/PublicStatus"
}Auth
GET/oauth/requests/{requestId}
Leer una solicitud de autorización de aplicación y vincularla a la sesión actual
Se requiere sesión completa. La solicitud expira después de diez minutos. La respuesta no es tienda.
Autenticación: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
requestId · path · obligatorio
Schema
{
"type": "string",
"pattern": "^fdo_[A-Za-z0-9_-]{43}$"
}Respuestas
200 Solicitud de permisos de aplicación
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/OAuthConsent"
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Authenticated but not permitted, or CSRF validation failed
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Solicitud vencida, utilizada o vinculada a otro período de sesiones
Respuesta de 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/oauth/requests/{requestId}
Aprobar o negar una solicitud de autorización de la aplicación
Sesión completa, CSRF y Origen permitido requerido. Consume la solicitud una vez. Respuesta no es tienda.
Autenticación: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
requestId · path · obligatorio
Schema
{
"type": "string",
"pattern": "^fdo_[A-Za-z0-9_-]{43}$"
}Cuerpo de solicitud · obligatorio
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"decision"
],
"properties": {
"decision": {
"type": "string",
"enum": [
"approve",
"deny"
]
}
}
}Respuestas
200 Llamada de cliente registrada con código o negación, estado y emisor
Respuesta de 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"redirectUrl"
],
"properties": {
"redirectUrl": {
"type": "string",
"format": "uri"
}
}
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Authenticated but not permitted, or CSRF validation failed
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Solicitud de autorización no disponible; iniciar una nueva conexión
Respuesta de 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud de validación falló
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/register
Crear una cuenta FlashData pendiente
Las versiones de Términos y Privacidad presentadas deben coincidir con el paquete legal publicado actual.
Autenticación: Público
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Cuerpo de solicitud · obligatorio
Schema · application/json
{
"$ref": "#/components/schemas/RegisterRequest"
}Respuestas
201 Cuenta creada; verificación de correo electrónico requerida
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 201 · application/json
{
"$ref": "#/components/schemas/RegisterResponse"
}409 Conflicto de estado de recursos o idempotencia
Respuesta de 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud de validación falló
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Tasa, concurrencia, lote o límite de trabajo pendiente excedido
Cabeceras: Retry-After
Respuesta de 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Se produjo un error interno inesperado
Respuesta de 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Una dependencia o un catálogo requerido no está disponible temporalmente
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/login
Crear una sesión web opaca
Establece la cookie Secure, HttpOnly `__Host-fd_session`. recibir una sesión email_verification restringida para el panel de verificación. Las cuentas verificadas Eligibles reciben sus créditos de prueba una vez en el inicio de sesión si no se otorgan ya. Una cuenta activa recibe una sesión completa a menos que su identidad migrada aún requiera actual aceptación jurídica, en cuyo caso recibe una restricción legal_acceptance Sesión. Una cuenta con una solicitud de eliminación programada recibe una sesión deletion_recovery restringida. Cuentas cuya eliminación está procesando/failed/completed, y las cuentas suspendidas, reciben 403.
Autenticación: Público
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Cuerpo de solicitud · obligatorio
Schema · application/json
{
"$ref": "#/components/schemas/LoginRequest"
}Respuestas
200 Authenticated
Cabeceras: Set-Cookie, Cache-Control, X-Request-Id
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/LoginResponse"
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Se prohíbe el acceso; Problem.code es email_not_verified, account_suspended, account_deletion_processing, account_deletion_failed, o account_deleted
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud de validación falló
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}423 Cuenta bloqueada temporalmente
Cabeceras: Retry-After
Respuesta de 423 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Tasa, concurrencia, lote o límite de trabajo pendiente excedido
Cabeceras: Retry-After
Respuesta de 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/logout
Revoque el período de sesiones en curso
Autenticación: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respuestas
204 Sesión revocada y desactivada la cookie
Cabeceras: Set-Cookie, Cache-Control, X-Request-Id
401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Authenticated but not permitted, or CSRF validation failed
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/auth/me
Lea la cuenta actual y el usuario
Autenticación: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respuestas
200 Cuenta actual
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/Account"
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/auth/csrf
Obtener el token CSRF atado a la sesión actual
Autenticación: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respuestas
200 CSRF token
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"csrfToken"
],
"properties": {
"csrfToken": {
"type": "string",
"minLength": 32,
"readOnly": true
}
}
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/email-verifications
Solicitar o reenviar un mensaje de verificación de correo electrónico
Para cada correo electrónico sintácticamente válido, devuelve la misma respuesta independientemente de si la cuenta está desaparecida, pendiente, activa, suspendida o eliminada. Las cuentas pendientes elegibles reciben un enlace rotativo de una sola vez después de la refrigeración del reenvío.
Autenticación: Público
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Cuerpo de solicitud · obligatorio
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 320
}
}
}Respuestas
202 Solicitud aceptada. La respuesta no revela si existe una cuenta.
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 202 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"accepted"
],
"properties": {
"accepted": {
"type": "boolean",
"const": true
}
}
}422 Anónimo autenticación solicitud validación falló
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Tasa de autenticación anónimo superada
Cabeceras: Cache-Control, Retry-After, X-Request-Id
Respuesta de 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Se produjo un error de autenticación anónimo inesperado
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Una dependencia de autenticación anónima no está disponible temporalmente
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/email-verifications/confirm
Verifique un correo electrónico y active la cuenta
Consumirá el token de una sola vez y activará la Cuenta y el Usuario. Se aplican reglas de cuenta existente y crédito de prueba. Sin registro Sesión el usuario inicia sesión explícitamente. Una solicitud de origen permitido que lleve la sesión de registro de coincidencias y su X-CSRF-Token puede recibir una cookie de sesión rotada para la misma cuenta verificada; una ficha de verificación por sí sola nunca firma en un usuario.
Autenticación: Público
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Cuerpo de solicitud · obligatorio
Schema · application/json
{
"$ref": "#/components/schemas/TokenRequest"
}Respuestas
200 Cuenta activada
Cabeceras: Set-Cookie, Cache-Control, X-Request-Id
Respuesta de 200 · application/json
{
"allOf": [
{
"$ref": "#/components/schemas/Account"
},
{
"type": "object",
"properties": {
"status": {
"const": "active"
},
"emailVerified": {
"const": true
}
}
}
]
}410 Un solo símbolo es inválido, expirado, invalidado, ya utilizado, o perdido una carrera de confirmación concurrente. Problem.code es `token_unavailable`.
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Anónimo autenticación solicitud validación falló
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Tasa de autenticación anónimo superada
Cabeceras: Cache-Control, Retry-After, X-Request-Id
Respuesta de 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Se produjo un error de autenticación anónimo inesperado
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Una dependencia de autenticación anónima no está disponible temporalmente
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/email-verifications/session
Continuar la sesión de registro original después de la verificación de correo electrónico
Requiere un Origen permitido y el token CSRF ligado a una sesión de verificación de correo electrónico autenticada con contraseña en vivo. Devoluciones pendientes hasta que se verifique la cuenta propia de la sesión, incluyendo la verificación en otro navegador. Rechaza la sesión de registro y emite una sesión de aceptación plena o legal. No acepta una cuenta ID, correo electrónico, contraseña o verificación token, acepta legal.
Autenticación: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Cuerpo de solicitud · obligatorio
Schema · application/json
{
"type": "object",
"additionalProperties": false
}Respuestas
200 Sesión de inscripción rotativa
Cabeceras: Set-Cookie, Cache-Control
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/LoginResponse"
}202 La verificación por correo electrónico está pendiente; no hay nueva sesión
Cabeceras: Cache-Control
Respuesta de 202 · application/json
{
"type": "object",
"required": [
"pending"
],
"additionalProperties": false,
"properties": {
"pending": {
"type": "boolean",
"const": true
}
}
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Authenticated but not permitted, or CSRF validation failed
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud de validación falló
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Se produjo un error interno inesperado
Respuesta de 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/password-resets
Solicitar un correo electrónico de reset de contraseña
Siempre devuelve la misma respuesta 202 para un correo electrónico sintacticamente válido sin importar la existencia de cuenta o estado de ciclo de vida. Sólo las identidades activas o bloqueadas elegibles reciben correo.
Autenticación: Público
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Cuerpo de solicitud · obligatorio
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 320
}
}
}Respuestas
202 Solicitud aceptada. La respuesta no revela si existe una cuenta.
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 202 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"accepted"
],
"properties": {
"accepted": {
"type": "boolean",
"const": true
}
}
}422 Anónimo autenticación solicitud validación falló
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Tasa de autenticación anónimo superada
Cabeceras: Cache-Control, Retry-After, X-Request-Id
Respuesta de 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Se produjo un error de autenticación anónimo inesperado
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Una dependencia de autenticación anónima no está disponible temporalmente
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/password-resets/confirm
Establecer una nueva contraseña y revocar las sesiones existentes
Consume atómicamente el token de la contraseña, almacena una nueva credencial Argon2id, revoca cada sesión existente, e invalida otros tokens de la contraseña. No registra al usuario en o crea una sesión.
Autenticación: Público
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Cuerpo de solicitud · obligatorio
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"token",
"password"
],
"properties": {
"token": {
"type": "string",
"minLength": 32,
"maxLength": 256,
"writeOnly": true
},
"password": {
"$ref": "#/components/schemas/Password"
}
}
}Respuestas
204 Actualización de la contraseña; revocación de las sesiones existentes
Cabeceras: Cache-Control, X-Request-Id
410 Un solo símbolo es inválido, expirado, invalidado, ya utilizado, o perdido una carrera de confirmación concurrente. Problem.code es `token_unavailable`.
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Anónimo autenticación solicitud validación falló
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Tasa de autenticación anónimo superada
Cabeceras: Cache-Control, Retry-After, X-Request-Id
Respuesta de 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Se produjo un error de autenticación anónimo inesperado
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Una dependencia de autenticación anónima no está disponible temporalmente
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/auth/sessions
Lista de sesiones activas para el usuario actual
Autenticación: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respuestas
200 Períodos de sesiones
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Session"
}
}
}
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/auth/sessions
Revoque todas las sesiones excepto la actual
Autenticación: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respuestas
204 Otros períodos de sesiones revocados
Cabeceras: Cache-Control, X-Request-Id
401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Authenticated but not permitted, or CSRF validation failed
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/auth/sessions/{sessionId}
Revoque un período de sesiones
Autenticación: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
sessionId · path · obligatorio
Schema
{
"type": "string",
"pattern": "^ses_"
}Respuestas
204 Sesion revocada. Si fue la sesión actual, la cookie está limpiada.
Cabeceras: Set-Cookie, Cache-Control, X-Request-Id
401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Authenticated but not permitted, or CSRF validation failed
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Recursos no encontrados o no propiedad del callador
Respuesta de 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Conflicto de estado de recursos o idempotencia
Respuesta de 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud de validación falló
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Una dependencia o un catálogo requerido no está disponible temporalmente
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/re-authenticate
Verificar la contraseña actual para una operación sensible
Se registra una prueba reciente y de valor corto en la sesión actual del servidor.
Autenticación: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Cuerpo de solicitud · obligatorio
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"password"
],
"properties": {
"password": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"writeOnly": true
}
}
}Respuestas
200 Sesión de autenticación reciente
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/Reauthentication"
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Authenticated but not permitted, or CSRF validation failed
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Tasa, concurrencia, lote o límite de trabajo pendiente excedido
Cabeceras: Retry-After
Respuesta de 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}PATCH/auth/password
Cambiar la contraseña y rotar la sesión actual
Autenticación: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Cuerpo de solicitud · obligatorio
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"currentPassword",
"newPassword"
],
"properties": {
"currentPassword": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"writeOnly": true
},
"newPassword": {
"$ref": "#/components/schemas/Password"
},
"revokeOtherSessions": {
"type": "boolean",
"default": true
}
}
}Respuestas
204 Cambio de contraseña; sesión actual rotada y otras sesiones revocadas cuando se solicita
Cabeceras: Set-Cookie, Cache-Control, X-Request-Id
401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Authenticated but not permitted, or CSRF validation failed
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud de validación falló
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Cuenta
GET/oauth/connections
Listar las aplicaciones conectadas de la cuenta actual
Se requiere sesión completa. Vacíe cuando la cuenta no tiene aplicaciones conectadas. La respuesta no es una tienda.
Autenticación: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respuestas
200 Aplicaciones conectadas
Respuesta de 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuthConnection"
}
}
}
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Authenticated but not permitted, or CSRF validation failed
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/oauth/connections/{grantId}
Revoque una aplicación conectada y su clave API dedicada
Sesión completa, CSRF y el Origen permitido requerido. La propiedad de la cuenta se ejecuta. La respuesta no es tienda.
Autenticación: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
grantId · path · obligatorio
Schema
{
"type": "string",
"pattern": "^oag_[A-Za-z0-9_-]{8,}$"
}Respuestas
204 Autorización revocada
401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Authenticated but not permitted, or CSRF validation failed
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Recursos no encontrados o no propiedad del callador
Respuesta de 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/account
Ajustes de la cuenta
Autenticación: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respuestas
200 Cuenta
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/Account"
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}PATCH/account
Configuración de perfil de actualización
Autenticación: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Cuerpo de solicitud · obligatorio
Schema · application/json
{
"$ref": "#/components/schemas/UpdateAccountRequest"
}Respuestas
200 Cuenta actualizada
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/Account"
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Authenticated but not permitted, or CSRF validation failed
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud de validación falló
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/account
Borrar y revocar todas las sesiones existentes y las teclas API
Las cuentas de administrador deben tener su papel de plataforma revocado a través del flujo de trabajo auditado del operador antes de que se pueda programar la eliminación. Una solicitud única de eliminación activa es el límite de idempotencia natural. Los horarios autenticados recurrentes devuelven la misma solicitud. Después de la revocación de sesión, se recupera una respuesta perdida entrando en deletion_recovery modo y lectura GET /account/deletion; Sesiones revocadas nunca se aceptan para la repetición.
Autenticación: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Cuerpo de solicitud · obligatorio
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"password",
"confirmation"
],
"properties": {
"password": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"writeOnly": true
},
"confirmation": {
"type": "string",
"const": "DELETE"
}
}
}Respuestas
202 Supresión programada; sesiones activas y claves revocadas
Respuesta de 202 · application/json
{
"$ref": "#/components/schemas/AccountDeletionRequest"
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Authenticated but not permitted, or CSRF validation failed
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Conflicto de estado de recursos o idempotencia
Respuesta de 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud de validación falló
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/account/deletion
Lea la solicitud de eliminación de la cuenta actual
Autenticación: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respuestas
200 Solicitud de supresión actual
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/AccountDeletionRequest"
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Recursos no encontrados o no propiedad del callador
Respuesta de 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/account/deletion
Cancelar una eliminación programada durante el período de gracia
Usa un comparador y conjunto programado a conmutación. Una carrera de procesador devuelve 409; después del éxito la sesión de recuperación se gira y no puede volver a reproducir la antigua transición.
Autenticación: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respuestas
204 Supresión anulada, reactivada de la cuenta y rotatoria de la sesión de recuperación según la puerta de aceptación legal
Cabeceras: Set-Cookie, Cache-Control, X-Request-Id
401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Authenticated but not permitted, or CSRF validation failed
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Recursos no encontrados o no propiedad del callador
Respuesta de 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Conflicto de estado de recursos o idempotencia
Respuesta de 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/account/legal-acceptances
Accept la versión actual de Términos y Privacidad
Apende una aceptación legal inmutable, despeja la puerta de migración y rota la sesión. Se rechazan las versiones enviadas en formato Stale.
Autenticación: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Cuerpo de solicitud · obligatorio
Schema · application/json
{
"$ref": "#/components/schemas/LegalAcceptanceRequest"
}Respuestas
200 La aceptación jurídica registrada y el período de sesiones rotaron al modo completo
Cabeceras: Set-Cookie, Cache-Control, X-Request-Id
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/LoginResponse"
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Authenticated but not permitted, or CSRF validation failed
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Recursos no encontrados o no propiedad del callador
Respuesta de 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud de validación falló
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}A bordo
GET/onboarding
Lea el progreso resumible a bordo
Autenticación: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respuestas
200 Estado actual a bordo
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/OnboardingProgress"
}401 Autenticación requerida o inválida
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Se produjo un error interno inesperado
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Una dependencia requerida o un registro de embarque no está disponible temporalmente
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}PATCH/onboarding
Avance a bordo sin permitir que el progreso se mueva hacia atrás
Autenticación: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Cuerpo de solicitud · obligatorio
Schema · application/json
{
"$ref": "#/components/schemas/UpdateOnboardingRequest"
}Respuestas
200 Actualizado en el estado de embarque
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/OnboardingProgress"
}401 Autenticación requerida o inválida
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Authenticated but not permitted, or CSRF validation failed
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Conflicto de estado de recursos o idempotencia
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud de validación falló
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Se produjo un error interno inesperado
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Una dependencia requerida o un registro de embarque no está disponible temporalmente
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Descripción general
GET/overview
Lea el agregado de panel de cuenta
Autenticación: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respuestas
200 Sinopsis de la cuenta
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/ConsoleOverview"
}401 Autenticación requerida o inválida
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Se produjo un error interno inesperado
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Una dependencia requerida o un registro de embarque no está disponible temporalmente
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Claves API
GET/api-access/identity
Verificar la propiedad clave API actual y la disponibilidad recurrente
Sólo cabecera gratis APIRetorno de la cuenta pública/key IDs y la propiedad autorizada. No hay órgano de solicitud. No altera el existente /api-access respuesta de metadatos. 120/minute Límite de lectura de cuentas. Fail cerró sobre la indisponibilidad; no inferir la propiedad de prefijo clave, plan o estado local. No se aceptan parámetros de consulta.
Autenticación: dataApiKey
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respuestas
200 Verificar la propiedad clave API actual y la disponibilidad recurrente
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/APIKeyIdentity"
}400 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-keys
Lista de metadatos clave API
Autenticación: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respuestas
200 API Llaves sin secretos
Respuesta de 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiKey"
}
}
}
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/api-keys
Crear una tecla API y revelar su secreto una vez
Autenticación: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
Idempotency-Key · header · obligatorio
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Cuerpo de solicitud · obligatorio
Schema · application/json
{
"$ref": "#/components/schemas/CreateApiKeyRequest"
}Respuestas
201 Creado; la misma repetición idempotente puede devolver la misma respuesta cifrada durante cinco minutos
Respuesta de 201 · application/json
{
"$ref": "#/components/schemas/ApiKeyCreated"
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Authenticated but not permitted, or CSRF validation failed
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Conflicto de estado de recursos o idempotencia
Respuesta de 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud de validación falló
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Una dependencia o un catálogo requerido no está disponible temporalmente
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/api-keys/{keyId}
Revoque una tecla API
Autenticación: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
keyId · path · obligatorio
Schema
{
"type": "string",
"pattern": "^key_"
}Respuestas
204 Revocado
401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Authenticated but not permitted, or CSRF validation failed
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Recursos no encontrados o no propiedad del callador
Respuesta de 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Una dependencia o un catálogo requerido no está disponible temporalmente
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/api-keys/{keyId}/rotate
Crear una llave de reemplazo y programar revocación de llave vieja
Crea una nueva llave y mantiene activa la antigua llave hasta revokeOldAt. Por defecto, la solapadura dura las horas 24 o hasta que la antigua llave caduca, lo que sea antes. Un revokeOldAt personalizado debe estar en el futuro, dentro de siete días, y no más tarde que la antigua caducidad de la llave.
Autenticación: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
keyId · path · obligatorio
Schema
{
"type": "string",
"pattern": "^key_"
}Idempotency-Key · header · obligatorio
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Cuerpo de solicitud · opcional
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"revokeOldAt": {
"type": "string",
"format": "date-time",
"description": "Optional old-key revocation time; defaults to 24 hours and cannot exceed seven days or the old key expiry."
}
}
}Respuestas
201 Sustitución creada; secreto devuelto una vez
Respuesta de 201 · application/json
{
"$ref": "#/components/schemas/ApiKeyCreated"
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Authenticated but not permitted, or CSRF validation failed
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Recursos no encontrados o no propiedad del callador
Respuesta de 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Conflicto de estado de recursos o idempotencia
Respuesta de 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud de validación falló
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Una dependencia o un catálogo requerido no está disponible temporalmente
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-access
Lea las fuentes autorizadas de API y el origen de los resultados
autenticación X-API-Key gratuita y sencilla. nombres de fuentes y el origen de almacenamiento configurado de resultados firmados (null si No hay cuenta ID, clave ID, se devuelven credenciales secretas o de almacenamiento. MCP local revalida este punto final antes de cada descubrimiento de herramientas y llamada, incluyendo el resultado de caché lee. No se aceptan parámetros de consulta o el cuerpo de solicitud. Todas las rutas /api-access comparten solicitudes 120 por minuto por cliente IP y retorno Cache-Control privado, sin tienda. El rastreo normal de última generación todavía ocurre.
Autenticación: dataApiKey
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respuestas
200 Fuentes públicas autorizadas y origen de resultados
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/ApiAccess"
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud de validación falló
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Demasiados relatos leídos; reingreso después de la ventana de límite de tarifas
503 Una dependencia o un catálogo requerido no está disponible temporalmente
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Conexiones del agente
GET/agent-connections/capabilities
Descubre el protocolo 2 disponible
No se aceptan parámetros de consulta. Las respuestas no son tienda. Las rutas de los agentes son sólo de gestión y de función; las implementaciones pueden devolver 404 cuando está deshabilitado. X-API-Key está prohibido en las rutas de los agentes.
Autenticación: Público
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respuestas
200 Descubre el protocolo 2 disponible
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/AgentCapabilities"
}400 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/registrations
Crear o recuperar una conexión API-key temporal
Persiste la prueba de registro y la entrada exacta antes POST. La misma prueba y el cuerpo recuperan el mismo juicio; el cambio de rendimiento de los insumos conflictos. 1 Crédito, 72 horas, 1 solicitud/second, tamaño del lote 1. Los límites de alcance de la fuente siguen siendo autorizados en el servidor. No se aceptan parámetros de consulta. Las respuestas no son tienda. Las rutas de los agentes son sólo de gestión y se obtienen funciones; las implementaciones pueden devolver 404 cuando está desactivado. X-API-Key está prohibido en las rutas de agente.
Autenticación: agentRegistrationProof
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Cuerpo de solicitud · obligatorio
Schema · application/json
{
"$ref": "#/components/schemas/AgentRegistrationRequest"
}Respuestas
201 Crear o recuperar una conexión API-key temporal
Respuesta de 201 · application/json
{
"$ref": "#/components/schemas/AgentRegistration"
}400 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/owned
Lista de conexiones propiedad del navegador
No se aceptan parámetros de consulta. Las respuestas no son tienda. Las rutas de los agentes son sólo de gestión y de función; los implementos pueden devolver 404 cuando está deshabilitado. X-API-Key está prohibido en las rutas de los agentes. Operación propiedad del navegador. Se requiere sesión verificada completa; el callador no debe sustituir una clave o prueba API.
Autenticación: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respuestas
200 Lista de conexiones propiedad del navegador
Respuesta de 200 · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"connections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentConnection"
}
}
},
"required": [
"connections"
]
}400 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/{connectionId}
Lea el estado de conexión temporal
No se aceptan parámetros de consulta. Las respuestas no son tienda. Las rutas de los agentes son sólo de gestión y de función; las implementaciones pueden devolver 404 cuando está deshabilitado. X-API-Key está prohibido en las rutas de los agentes.
Autenticación: agentSetupCredential
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
connectionId · path · obligatorio
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Respuestas
200 Lea el estado de conexión temporal
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/AgentConnectionResponse"
}400 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/agent-connections/{connectionId}
Rechazar una conexión de propiedad
No se aceptan parámetros de consulta. Las respuestas no son tienda. Las rutas de los agentes son sólo de gestión y de función; los implementos pueden devolver 404 cuando está deshabilitado. X-API-Key está prohibido en las rutas de los agentes. Operación propiedad del navegador. Se requiere sesión verificada completa; el callador no debe sustituir una clave o prueba API.
Autenticación: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
connectionId · path · obligatorio
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Origin · header · obligatorio
Schema
{
"type": "string"
}X-CSRF-Token · header · obligatorio
Schema
{
"type": "string"
}Respuestas
204 Rechazar una conexión de propiedad
400 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/{connectionId}/identity
Verificar los datos actuales API clave para una conexión
No se aceptan parámetros de consulta. Las respuestas no son tienda. Las rutas de los agentes son sólo de gestión y de función; las implementaciones pueden devolver 404 cuando está deshabilitado. X-API-Key está prohibido en las rutas de los agentes.
Autenticación: agentIdentityKey
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
connectionId · path · obligatorio
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Respuestas
200 Verificar los datos actuales API clave para una conexión
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/AgentConnectionResponse"
}400 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/{connectionId}/onboarding
Leer estado de embarque recuperable
No se aceptan parámetros de consulta. Las respuestas no son tienda. Las rutas de los agentes son sólo de gestión y de función; las implementaciones pueden devolver 404 cuando está deshabilitado. X-API-Key está prohibido en las rutas de los agentes.
Autenticación: agentHandoffProof
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
connectionId · path · obligatorio
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Respuestas
200 Leer estado de embarque recuperable
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/AgentOnboardingStatus"
}400 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/{connectionId}/claims
Crear una reclamación de aprobación del navegador
Abierto claimPath sobre una confianza FlashData origen web y mostrar el código por separado. Nunca coloque credenciales o el código de confirmación en el URL. No se aceptan parámetros de consulta. Las respuestas no son tienda. Las rutas de los agentes son sólo de gestión y de función; los despliegues pueden regresar 404 cuando está desactivado. X-API-Key está prohibido en las rutas de agente.
Autenticación: agentSetupCredential
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
connectionId · path · obligatorio
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Cuerpo de solicitud · obligatorio
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {},
"required": []
}Respuestas
201 Crear una reclamación de aprobación del navegador
Respuesta de 201 · application/json
{
"$ref": "#/components/schemas/AgentClaim"
}400 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/claims/{claimId}/confirm
Confirme el código de reclamación en una sesión de navegador verificada
No se aceptan parámetros de consulta. Las respuestas no son tienda. Las rutas de los agentes son sólo de gestión y de función; los implementos pueden devolver 404 cuando está deshabilitado. X-API-Key está prohibido en las rutas de los agentes. Operación propiedad del navegador. Se requiere sesión verificada completa; el callador no debe sustituir una clave o prueba API.
Autenticación: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
claimId · path · obligatorio
Schema
{
"type": "string",
"pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}Origin · header · obligatorio
Schema
{
"type": "string"
}X-CSRF-Token · header · obligatorio
Schema
{
"type": "string"
}Cuerpo de solicitud · obligatorio
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"pattern": "^\\d{8}$"
}
},
"required": [
"code"
]
}Respuestas
200 Confirme el código de reclamación en una sesión de navegador verificada
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/AgentBrowserClaim"
}400 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/claims/{claimId}
Lea una reclamación confirmada en su sesión del navegador
No se aceptan parámetros de consulta. Las respuestas no son tienda. Las rutas de los agentes son sólo de gestión y de función; los implementos pueden devolver 404 cuando está deshabilitado. X-API-Key está prohibido en las rutas de los agentes. Operación propiedad del navegador. Se requiere sesión verificada completa; el callador no debe sustituir una clave o prueba API.
Autenticación: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
claimId · path · obligatorio
Schema
{
"type": "string",
"pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}Respuestas
200 Lea una reclamación confirmada en su sesión del navegador
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/AgentClaimView"
}400 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/claims/{claimId}/approve
Aprobar la reducción de los alcances y la financiación de los saldos de las cuentas
No se aceptan parámetros de consulta. Las respuestas no son tienda. Las rutas de los agentes son sólo de gestión y de función; los implementos pueden devolver 404 cuando está deshabilitado. X-API-Key está prohibido en las rutas de los agentes. Operación propiedad del navegador. Se requiere sesión verificada completa; el callador no debe sustituir una clave o prueba API.
Autenticación: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
claimId · path · obligatorio
Schema
{
"type": "string",
"pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}Origin · header · obligatorio
Schema
{
"type": "string"
}X-CSRF-Token · header · obligatorio
Schema
{
"type": "string"
}Cuerpo de solicitud · obligatorio
Schema · application/json
{
"$ref": "#/components/schemas/AgentApproval"
}Respuestas
200 Aprobar la reducción de los alcances y la financiación de los saldos de las cuentas
Respuesta de 200 · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"connection": {
"$ref": "#/components/schemas/AgentConnection"
},
"handoff": {
"type": "object",
"additionalProperties": false,
"properties": {
"status": {
"type": "string"
},
"expiresAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"status",
"expiresAt"
]
}
},
"required": [
"connection",
"handoff"
]
}400 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/{connectionId}/handoff
Recuperar el propietario aprobado API
Candidato clave expira en 24 horas hasta la instalación ACK. Persist atomically, reload in a fresh process and verify identity before ACK. Una entrega repetida recupera al mismo candidato; la entrega confirmada devuelve un recibo sin credenciales. No se aceptan parámetros de consulta. Las respuestas no son tienda. Las rutas de los agentes son sólo de gestión y de función. 404 cuando está desactivado. X-API-Key está prohibido en las rutas de agente.
Autenticación: agentHandoffProof
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
connectionId · path · obligatorio
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Cuerpo de solicitud · obligatorio
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {},
"required": []
}Respuestas
200 Recuperar el propietario aprobado API
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/AgentHandoff"
}400 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/{connectionId}/handoff/ack
Reconocimiento de instalación verificada propietario-key
Caller ya debe haber salvado al candidato y verificarlo de forma independiente en un proceso nuevo. Marcas exitosas instaladas, elimina la caducidad de clave candidata y elimina el material creíble recuperable. Repetido ACK es idempotent. No se aceptan parámetros de consulta. Las respuestas son no-store. Las rutas del agente son sólo de gestión y de función-ganada; las implementaciones pueden devolver 404 cuando está desactivado. X-API-Key está prohibido en las rutas de agente.
Autenticación: agentHandoffProof
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
connectionId · path · obligatorio
Schema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Cuerpo de solicitud · obligatorio
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"apiKey": {
"type": "string"
}
},
"required": [
"apiKey"
]
}Respuestas
200 Reconocimiento de instalación verificada propietario-key
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/AgentHandoff"
}400 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Solicitud rechazada; inspeccionar el código Problema. Nunca vuelva a entrar una mutación ciegamente.
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Catálogo
GET/catalog/sources
Lista de capacidades de fuente pública sin precios específicos de cuenta
Autenticación: Público
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respuestas
200 Catálogo de fuentes públicas
Cabeceras: Cache-Control
Respuesta de 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSource"
}
}
}
}GET/plans
Lista de planes y precios públicos USD
Autenticación: Público
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respuestas
200 Catálogo del plan público
Cabeceras: Cache-Control
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/PlanCatalog"
}GET/legal/current
Lea las versiones actuales de Términos y Privacidad necesarias para su registro
Autenticación: Público
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respuestas
200 Catálogo actual de la versión legal
Cabeceras: Cache-Control
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/PublicLegalVersions"
}Facturación
GET/billing/subscription
Lea la suscripción efectiva de Stripe
Autenticación: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respuestas
200 Derechos de suscripción o PAYG
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/Subscription"
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/checkout-sessions
Crear una sesión de checkout organizada por Stripe
Las suscripciones y los paquetes de crédito publicados utilizan priceId. Usos de top-up personalizados amountMinor en lugar de esoUSD centavos, $10 a $999,999.99); el servidor calcula créditos al valor de crédito fijo y crea un precio privado de una sola vez Stripe. Producto, precio del proveedor, moneda, éxito URL y cancelar URL nunca se aceptan desde el navegador. Los créditos se conceden sólo después de un evento pagado verificado por la cantidad citada.
Autenticación: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
Idempotency-Key · header · obligatorio
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Cuerpo de solicitud · obligatorio
Schema · application/json
{
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"priceId"
],
"properties": {
"priceId": {
"type": "string",
"pattern": "^prc_"
},
"purchaseType": {
"type": "string",
"enum": [
"subscription",
"top_up"
],
"default": "subscription"
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"amountMinor",
"purchaseType"
],
"properties": {
"amountMinor": {
"type": "integer",
"minimum": 1000,
"maximum": 99999999,
"description": "Custom top-up amount in USD cents."
},
"purchaseType": {
"type": "string",
"const": "top_up"
}
}
}
]
}Respuestas
201 Sesión de control de Stripe
Respuesta de 201 · application/json
{
"$ref": "#/components/schemas/HostedSession"
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Authenticated but not permitted, or CSRF validation failed
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Conflicto de estado de recursos o idempotencia
Respuesta de 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud de validación falló
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Un proveedor de corriente falló
Respuesta de 502 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 El catálogo de facturación o proveedor no está configurado o no está disponible temporalmente
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/subscription-changes
Actualizar la suscripción actual Stripe a un precio publicado más alto
El servidor verifica que el precio FlashData es activo, disponible en el momento actual, USD-denominado, recurrente, el mismo intervalo, y estrictamente más caro que el precio de suscripción actual. Producto, precio de proveedor, divisa y opciones de protación nunca se aceptan desde el navegador. Los derechos locales y los créditos cambian sólo después de que se proyecta un evento de proveedor verificado.
Autenticación: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
Idempotency-Key · header · obligatorio
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Cuerpo de solicitud · obligatorio
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"priceId"
],
"properties": {
"priceId": {
"type": "string",
"pattern": "^prc_"
}
}
}Respuestas
201 Cambio de suscripción presentado a Stripe
Respuesta de 201 · application/json
{
"$ref": "#/components/schemas/SubscriptionChange"
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Authenticated but not permitted, or CSRF validation failed
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Recursos no encontrados o no propiedad del callador
Respuesta de 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Conflicto de estado de recursos o idempotencia
Respuesta de 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud de validación falló
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Un proveedor de corriente falló
Respuesta de 502 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 El catálogo de facturación o proveedor no está configurado o no está disponible temporalmente
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/portal-sessions
Crear un Portal de clientes de Stripe
Autenticación: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
Idempotency-Key · header · obligatorio
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Respuestas
201 Stripe Portal de atención al cliente
Respuesta de 201 · application/json
{
"$ref": "#/components/schemas/HostedSession"
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Authenticated but not permitted, or CSRF validation failed
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Recursos no encontrados o no propiedad del callador
Respuesta de 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Conflicto de estado de recursos o idempotencia
Respuesta de 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Un proveedor de corriente falló
Respuesta de 502 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 El catálogo de facturación o proveedor no está configurado o no está disponible temporalmente
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/subscription-cancellation
Programación o cancelación de la suscripción actual pagada
Ajuste cancelAtPeriodEnd a los verdaderos horarios cancelación en el final del período de facturación actual; false mantiene la suscripción. Actualización de los derechos después de un evento de suscripción de Stripe verificado. Este punto final nunca cancela de inmediato o emite un reembolso.
Autenticación: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
Idempotency-Key · header · obligatorio
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Cuerpo de solicitud · obligatorio
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"cancelAtPeriodEnd"
],
"properties": {
"cancelAtPeriodEnd": {
"type": "boolean"
}
}
}Respuestas
202 Actualización de cancelación enviada a Stripe
Respuesta de 202 · application/json
SubscriptionCancellationChange
{
"$ref": "#/components/schemas/SubscriptionCancellationChange"
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Authenticated but not permitted, or CSRF validation failed
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Recursos no encontrados o no propiedad del callador
Respuesta de 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Conflicto de estado de recursos o idempotencia
Respuesta de 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud de validación falló
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Un proveedor de corriente falló
Respuesta de 502 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 El catálogo de facturación o proveedor no está configurado o no está disponible temporalmente
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/billing/invoices
Lista Proyecciones de facturas Stripe
Autenticación: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
cursor · query · opcional
Schema
{
"type": "string",
"maxLength": 512
}limit · query · opcional
Schema
{
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}Respuestas
200 Facturas
401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/billing/payments
Lista de las proyecciones de pago de cuenta y reembolso
Autenticación: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
cursor · query · opcional
Schema
{
"type": "string",
"maxLength": 512
}limit · query · opcional
Schema
{
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}Respuestas
200 Historial de pago de una sola vez sin secretos de proveedor
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/BillingPaymentPage"
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Créditos
GET/api-access/balance
Lea el saldo de cuenta en vivo utilizando una tecla API
Lea el saldo de crédito actual compartido por todas las teclas API en su cuenta. Las reservas activas pueden reducir el saldo disponible. Esta solicitud no cuesta créditos y no tiene parámetros de consulta o cuerpo. Las respuestas son privadas y no están cachés; se aplican límites de tarifas de cuenta.
Autenticación: dataApiKey
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respuestas
200 Saldo firmado y Créditos no negativos disponibles
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/ApiAccessBalance"
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud de validación falló
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Demasiados relatos leídos; reingreso después de la ventana de límite de tarifas
503 Una dependencia o un catálogo requerido no está disponible temporalmente
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-access/pricing
Lea los precios de cuenta reales de las fuentes autorizadas por la tecla API
Lea las tarifas de su cuenta para las fuentes permitidas por la tecla API. Un precio nulo significa que la fuente no está disponible. request_count cuenta consultas, no artículos devueltos; las tarifas de descarga son por TB (10^12 bytes). Las estimaciones no reservan créditos ni capacidad. Esta solicitud no cuesta créditos.
Autenticación: dataApiKey
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
source · query · opcional
Una fuente otorgada a esta clave; omitir leer todas las fuentes otorgadas.
Schema
{
"$ref": "#/components/schemas/ApiAccessSource"
}request_count · query · opcional
Número de números enteros decimales; no estima el tamaño de descarga.
Schema
{
"type": "integer",
"minimum": 1,
"maximum": 100000,
"default": 1
}Respuestas
200 Plan de cuentas y precios específicos para fuentes
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/ApiAccessPricing"
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Authenticated but not permitted, or CSRF validation failed
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud de validación falló
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Demasiados relatos leídos; reingreso después de la ventana de límite de tarifas
503 Una dependencia o un catálogo requerido no está disponible temporalmente
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-access/limits
Lea los límites del plan de cuenta y los trabajos pendientes actuales utilizando una clave API
Lea sus límites de concurrencia, tamaño de lote y trabajo pendiente, más el conteo actual pendiente. Estos valores ayudan a planificar solicitudes pero no tienen capacidad de reserva. Esta solicitud no cuesta créditos y no tiene parámetros de consulta o cuerpo. Las respuestas son privadas y no están cachés; se aplican límites de tarifas de cuenta.
Autenticación: dataApiKey
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respuestas
200 Plan de techos y cuenta pendiente actual
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/ApiAccessLimits"
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud de validación falló
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Demasiados relatos leídos; reingreso después de la ventana de límite de tarifas
503 Una dependencia o un catálogo requerido no está disponible temporalmente
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/usage
Lea el uso de la cuenta para las fuentes autorizadas por la tecla API
Leído gratis, autenticado sólo por X-API-Key. Incluye todas las claves de la cuenta pero sólo las fuentes otorgadas a la llave de llamada. No devuelve el texto de consulta, claves, Detalles de pago u otras cuentas. Predeterminados a siete días; máximo 31 días. Las fechas deben usar los horarios UTC Z. De es incluyente y exclusivo; ambos están redondeados a minutos. Con de solo, a predeterminados de + 7 días. Con ninguno, es el comienzo del próximo minuto. consistente; incluso actualizar=falso no garantiza que todos los eventos recientes sean ingeridos. Límite de lectura: solicitudes 60 por minuto por cliente IP.
Autenticación: dataApiKey
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
source · query · opcional
Una fuente de catálogo exacta otorgada a la llave de llamada; omitted significa todas las fuentes otorgadas.
Schema
{
"type": "string",
"enum": [
"google_search",
"google_images",
"google_news",
"google_shopping",
"google_videos",
"google_places",
"youtube_search",
"youtube_search_extended",
"youtube_metadata",
"youtube_transcript",
"youtube_captions",
"youtube_trainability",
"youtube_channel",
"youtube_suggestions",
"youtube_download"
]
}from · query · opcional
Schema
{
"type": "string",
"format": "date-time"
}to · query · opcional
Schema
{
"type": "string",
"format": "date-time"
}Respuestas
200 Cuentos de solicitud escociada y Créditos cargados, con información de frescura
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/ApiKeyUsage"
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Authenticated but not permitted, or CSRF validation failed
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud de validación falló
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Demasiados usos leídos; reingreso después de la ventana de límite de tarifas
503 Una dependencia o un catálogo requerido no está disponible temporalmente
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/credits/balance
Lea los créditos disponibles y reservados
Autenticación: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respuestas
200 Saldo acreedor
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/CreditBalance"
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/credits/policy
Lea la política de crédito de cuenta efectiva y de carga
Autenticación: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respuestas
200 Política de crédito eficaz
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/CreditPolicy"
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/credits/transactions
Lista de entradas de libros de crédito
Autenticación: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
cursor · query · opcional
Schema
{
"type": "string",
"maxLength": 512
}limit · query · opcional
Schema
{
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}type · query · opcional
Schema
{
"$ref": "#/components/schemas/CreditEntryType"
}Respuestas
200 Entradas de libros
Respuesta de 200 · application/json
{
"allOf": [
{
"$ref": "#/components/schemas/Page"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditTransaction"
}
}
}
}
]
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Créditos de primera instancia
GET/trial-credit-request
Lea elegibilidad de crédito de prueba y la solicitud de vida de la cuenta
Autenticación: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respuestas
200 Elegibilidad actual, concesión configurada y estado de solicitud
Cabeceras: Cache-Control
Respuesta de 200 · application/json
{
"$ref": "#/components/schemas/TrialCreditState"
}401 Autenticación requerida o inválida
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Se produjo un error interno inesperado
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Una dependencia requerida o un registro de embarque no está disponible temporalmente
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/trial-credit-request
Presentar la cuenta de una sola vida Solicitud de crédito de prueba
La cantidad de prueba y el caso de uso se guardan cuando usted envía la solicitud.
Autenticación: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
Idempotency-Key · header · obligatorio
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Cuerpo de solicitud · opcional
Schema · application/json
{
"type": "object",
"additionalProperties": false
}Respuestas
201 Solicitud de crédito de prueba creada y aprobada automáticamente para cuentas verificadas elegibles, independientemente del proveedor de correo electrónico
Cabeceras: Cache-Control
Respuesta de 201 · application/json
{
"$ref": "#/components/schemas/TrialCreditState"
}401 Autenticación requerida o inválida
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Authenticated but not permitted, or CSRF validation failed
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Conflicto de estado de recursos o idempotencia
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud de validación falló
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Se produjo un error interno inesperado
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Una dependencia requerida o un registro de embarque no está disponible temporalmente
Cabeceras: Cache-Control, X-Request-Id
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Entrega
GET/delivery/webhooks
Lista de recuperación guardada URLs
Autenticación: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respuestas
200 Callback URLs
Respuesta de 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeliveryWebhook"
}
}
}
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/delivery/webhooks
Guardar un callback de terminación URL
Autenticación: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Cuerpo de solicitud · obligatorio
Schema · application/json
{
"$ref": "#/components/schemas/CreateDeliveryWebhookRequest"
}Respuestas
201 Creado
Respuesta de 201 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"webhook"
],
"properties": {
"webhook": {
"$ref": "#/components/schemas/DeliveryWebhook"
}
}
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud de validación falló
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/delivery/webhooks/{webhookId}
Retirar un callback de terminación URL
Autenticación: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
webhookId · path · obligatorio
Schema
{
"type": "string",
"pattern": "^cbk_[A-Za-z0-9_-]{8,}$"
}Respuestas
204 Retirado
401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Recursos no encontrados o no propiedad del callador
Respuesta de 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/delivery/webhooks/{webhookId}/test
Enviar una muestra descarga-completo carga útil
Autenticación: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
webhookId · path · obligatorio
Schema
{
"type": "string",
"pattern": "^cbk_[A-Za-z0-9_-]{8,}$"
}Respuestas
200 Pruebas de intento
Respuesta de 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"statusCode",
"webhook"
],
"properties": {
"statusCode": {
"type": "integer",
"minimum": 0
},
"webhook": {
"$ref": "#/components/schemas/DeliveryWebhook"
}
}
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Recursos no encontrados o no propiedad del callador
Respuesta de 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Trabajos
Para los ejemplos de presentación, estado y resultados, véase Tiempo real y modo asíncrono · Solicitudes de Batch.
GET/jobs
Lista de datos API puestos de trabajo para el espacio de trabajo actual
Historia activa y archivada de cursor. Defaults a los últimos siete días; cada rango de fecha de UTC se limita a los días 31. Desde es inclusivo y hasta es de precisión exclusiva, a minuto. Los resúmenes se mantienen asincrónicamente y pueden lagar la ingestión.
Autenticación: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
cursor · query · opcional
Schema
{
"type": "string",
"minLength": 1,
"maxLength": 512
}limit · query · opcional
Schema
{
"type": "integer",
"minimum": 1,
"maximum": 50
}source · query · opcional
Schema
{
"type": "string",
"pattern": "^(google|youtube|google_[a-z]+|youtube_[a-z_]+)$"
}status · query · opcional
Schema
{
"type": "string",
"enum": [
"completed",
"failed",
"pending",
"processing"
]
}mode · query · opcional
Schema
{
"type": "string",
"enum": [
"async",
"batch",
"realtime"
]
}from · query · opcional
Schema
{
"type": "string",
"format": "date-time"
}to · query · opcional
Schema
{
"type": "string",
"format": "date-time"
}Respuestas
200 Página de trabajo
Respuesta de 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"pagination",
"summary"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConsoleJob"
}
},
"pagination": {
"$ref": "#/components/schemas/Pagination"
},
"summary": {
"type": [
"object",
"null"
],
"additionalProperties": false,
"required": [
"completed",
"credits",
"failed",
"total"
],
"properties": {
"completed": {
"type": "integer",
"minimum": 0
},
"credits": {
"type": "number",
"minimum": 0
},
"failed": {
"type": "integer",
"minimum": 0
},
"total": {
"type": "integer",
"minimum": 0
},
"updating": {
"type": "boolean"
}
}
}
}
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud de validación falló
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/jobs/{jobId}
Leer un trabajo de datos API
Lea job.status para comprobar el progreso y job.error si el procesamiento falló. JSON es el predeterminado; use Accept: text/plain para texto legible. X-Respond-With es ignorado aquí. Siga Retry-After cuando se proporciona antes de comprobar de nuevo.
Autenticación: cookieSession o dataApiKey
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
Accept · header · opcional
application/json devuelve la respuesta estructurada original; text/plain devuelve los mismos campos como texto plano con sangría. Se admiten rangos de tipos de medio estándar y pesos q. Si falta Accept o se utiliza un comodín global, se devuelve JSON. X-Respond-With se ignora en los endpoints de envío y estado de trabajos. Los errores siguen siendo JSON estructurado. Ambos tipos de respuesta usan UTF-8 y admiten el parámetro explícito charset=utf-8.
Schema
{
"type": "string"
}jobId · path · obligatorio
Schema
{
"type": "string",
"pattern": "^job_[A-Za-z0-9_-]+$"
}Respuestas
200 Detalles de trabajo
Respuesta de 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"job"
],
"properties": {
"job": {
"$ref": "#/components/schemas/ConsoleJob"
}
}
}Respuesta de 200 · text/plain
{
"type": "string"
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Recursos no encontrados o no propiedad del callador
Respuesta de 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}406 No se acepta ni application/json ni text/plain; la respuesta es JSON
Respuesta de 406 · application/json
{
"$ref": "#/components/schemas/QueryRepresentationError"
}GET/jobs/{jobId}/results
Descargar un resultado de asinc completado
Por defecto, autentica el acceso y redirige a un privado de corta duración R2 URL; los clientes reciben el original JSON directamente desde R2. Accept: text/plain devuelve de forma independiente HTTP 200 con los campos de resultado originales como texto plano de identificación. X-Respond-With: markdown selecciona el contenido Markdown: application/json lo envuelve en contenido junto con los metadatos originales, reemplazando los resultados; text/plain devuelve metadatos seguidos por Markdown. Desapareciendo Accept o un comodín global predeterminado a JSON. El formato no presenta otra consulta o cobra créditos de consulta. Los resultados almacenados expiran las horas 24 después de la terminación. Los errores permanecen estructurados JSON.
Autenticación: cookieSession o dataApiKey
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
X-Respond-With · header · opcional
Establecer para marcar el contenido de resultados de retorno como Markdown. Omit para conservar los campos de resultados originales. Accept selecciones independientemente JSON sólo consultas en tiempo real y resultado de trabajo completado lee soporte este encabezado. No cambia las presentaciones de trabajo, estado, cuenta APIs, callbacks, Bulk archivos, descargas binarias, o MCP respuestas de protocolo.
Schema
{
"type": "string",
"enum": [
"markdown"
]
}Accept · header · opcional
Elige application/json o text/plain independientemente de X-Respond-With. Sin X-Respond-With, text/plain devuelve los campos originales con sangría; JSON conserva los campos originales de la respuesta, y las lecturas de resultados completados redirigen al almacenamiento. Con markdown, JSON devuelve contenido y metadatos; el texto plano devuelve los metadatos seguidos de Markdown. Se admiten rangos de tipos de medio estándar y pesos q. Si falta Accept o se utiliza un comodín global, se devuelve JSON. Ambos tipos de respuesta usan UTF-8 y admiten el parámetro explícito charset=utf-8.
Schema
{
"type": "string"
}jobId · path · obligatorio
Schema
{
"type": "string",
"pattern": "^job_[A-Za-z0-9_-]+$"
}Respuestas
200 Campos originales de texto simple o Markdown devueltos directamente; JSON original de R2 después de seguir la dirección predeterminada
Respuesta de 200 · application/json
{
"anyOf": [
{
"$ref": "#/components/schemas/MarkdownQueryResult"
},
{
"type": "object",
"additionalProperties": true
}
]
}Respuesta de 200 · text/plain
{
"type": "string"
}302 Redirect a original JSON en privado R2 de almacenamiento cuando JSON es seleccionado sin X-Respond-With
Cabeceras: Location
400 Valor X-Respond-With no compatible; respuesta es JSON
Respuesta de 400 · application/json
{
"$ref": "#/components/schemas/QueryRepresentationError"
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Recursos no encontrados o no propiedad del callador
Respuesta de 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}406 No se acepta ni application/json ni text/plain; la respuesta es JSON
Respuesta de 406 · application/json
{
"$ref": "#/components/schemas/QueryRepresentationError"
}409 Conflicto de estado de recursos o idempotencia
Respuesta de 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Resultado vencido
Respuesta de 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 La tarea falló. Si se guardó el motivo del fallo, aparece en el campo detail de la respuesta.
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Una dependencia o un catálogo requerido no está disponible temporalmente
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}API de procesamiento Bulk
Los puntos finales Bulk tienen una referencia específica con parámetros, ejemplos de solicitud y esquemas de respuesta. Open Bulk procesamiento API
GET /v2/bulk-jobs· Trabajos YouTubePOST /v2/bulk-jobs· Crear un trabajo Bulk y conseguir un archivo subir URLGET /v2/bulk-jobs/{bulkId}· Lea el progreso del trabajo a granel y los conteos agregadosPATCH /v2/bulk-jobs/{bulkId}· Modificar la configuración de los vídeos que no han comenzadoDELETE /v2/bulk-jobs/{bulkId}· Cancelar un trabajo BulkPOST /v2/bulk-jobs/{bulkId}/start· Comience a escanear un archivo YouTube ID subidoPOST /v2/bulk-jobs/{bulkId}/pause· Pausa un trabajo BulkPOST /v2/bulk-jobs/{bulkId}/resume· Resumir un trabajo a granel manual o automáticamente pausadoGET /v2/bulk-jobs/{bulkId}/results· Descargar el manifiesto de vracs completadoGET /v2/bulk-jobs/{bulkId}/results/{partNumber}· Descargar una parte de resultado de NDJSON con Gzip
Playground
POST/playground/run
Ejecutar una consulta de patio como el espacio de trabajo actual
Autenticación: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Cuerpo de solicitud · obligatorio
Schema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"source",
"mode",
"query"
],
"properties": {
"source": {
"type": "string"
},
"mode": {
"type": "string",
"enum": [
"realtime",
"async",
"batch"
]
},
"query": {
"description": "Source request body. In batch mode, also accepts an object containing only queries, an array of 1 to 20 request bodies. Every entry must match the selected source and its input schema. Search and Suggestions require query; Channel requires handle; Metadata, Transcript, Captions, Trainability and Download require an 11-character video_id matching [A-Za-z0-9_-]. Download batch entries must supply params.storage for customer storage; console browser delivery is not supported in this envelope. Account batch and pending-job limits still apply.",
"type": "object",
"additionalProperties": true
}
}
}Respuestas
200 Actualizar datos respuesta API capturado para el parque infantil
Respuesta de 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"body",
"endpoint",
"mode",
"status"
],
"properties": {
"body": {},
"endpoint": {
"type": "string",
"enum": [
"/v1/queries",
"/v1/queries/batch",
"/v1/queries/realtime"
]
},
"mode": {
"type": "string",
"enum": [
"realtime",
"async",
"batch"
]
},
"status": {
"type": "integer",
"minimum": 100,
"maximum": 599
}
}
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Solicitud de validación falló
Respuesta de 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/playground/jobs/{jobId}/download
Descargar un artefacto Playground completado en el navegador actual
Autenticación: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parámetros
jobId · path · obligatorio
Schema
{
"type": "string",
"pattern": "^job_[A-Za-z0-9_-]+$"
}Respuestas
200 Fabricación temporal de descarga de navegador
Cabeceras: Content-Disposition, Content-Length
Respuesta de 200 · application/octet-stream
{
"type": "string",
"format": "binary"
}401 Autenticación requerida o inválida
Respuesta de 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 Recursos no encontrados o no propiedad del callador
Respuesta de 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Conflicto de estado de recursos o idempotencia
Respuesta de 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 El artefacto temporal ha expirado
Respuesta de 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Una dependencia o un catálogo requerido no está disponible temporalmente
Respuesta de 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Definiciones de esquemas
APIKeyIdentity
{
"type": "object",
"additionalProperties": false,
"properties": {
"apiKeyId": {
"type": "string"
},
"accountId": {
"type": "string"
},
"accountType": {
"type": "string",
"enum": [
"owned",
"temporary"
]
},
"ownership": {
"type": "string",
"enum": [
"owned",
"unowned"
]
},
"access": {
"type": "string",
"enum": [
"ready",
"blocked"
]
},
"installed": {
"type": "boolean"
},
"recurringAllowed": {
"type": "boolean"
},
"connectionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"expiresAt": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"verifiedAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"apiKeyId",
"accountId",
"accountType",
"ownership",
"access",
"installed",
"recurringAllowed",
"connectionId",
"scopes",
"expiresAt",
"verifiedAt"
],
"description": "Authoritative current-record ownership and readiness. Public IDs only. recurringAllowed requires a verified active owner and, for agent-issued keys, server-confirmed installation. It is a point-in-time check, not an authorization token or permission to reuse cached data after revocation."
}Account
{
"type": "object",
"description": "Deleted accounts are only returned through authorized Admin projections; their identity fields are redacted.",
"additionalProperties": false,
"required": [
"id",
"name",
"email",
"status",
"emailVerified",
"legalAcceptanceRequired",
"role",
"timezone",
"createdAt",
"updatedAt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^acct_"
},
"name": {
"type": "string"
},
"email": {
"type": [
"string",
"null"
],
"format": "email"
},
"status": {
"type": "string",
"enum": [
"pending_verification",
"active",
"suspended",
"deleting",
"deleted"
]
},
"emailVerified": {
"type": "boolean"
},
"legalAcceptanceRequired": {
"type": "boolean"
},
"role": {
"type": "string",
"enum": [
"user",
"admin"
]
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
}
}AccountDeletionRequest
{
"type": "object",
"description": "User-safe deletion summary. Durable processor cursor and per-step metadata are internal operational state and are intentionally omitted.",
"additionalProperties": false,
"required": [
"id",
"status",
"requestedAt",
"scheduledFor",
"cancellable",
"billingCancellationStatus",
"activeJobsAtRequest",
"retryable"
],
"properties": {
"id": {
"type": "string",
"pattern": "^del_"
},
"status": {
"type": "string",
"enum": [
"scheduled",
"cancelled",
"processing",
"completed",
"failed"
]
},
"requestedAt": {
"type": "string",
"format": "date-time"
},
"scheduledFor": {
"type": "string",
"format": "date-time"
},
"cancellable": {
"type": "boolean"
},
"cancelledAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"processingStartedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"completedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"failureCode": {
"type": [
"string",
"null"
],
"maxLength": 80
},
"billingCancellationStatus": {
"type": "string",
"enum": [
"not_required",
"pending",
"completed",
"failed"
]
},
"activeJobsAtRequest": {
"type": "integer",
"minimum": 0
},
"retryable": {
"type": "boolean",
"description": "True only when an Admin-audited processor retry is possible; it does not grant the user mutation access."
}
}
}AgentApproval
{
"type": "object",
"additionalProperties": false,
"properties": {
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"allowAccountBalance": {
"const": true
}
},
"required": [
"scopes",
"allowAccountBalance"
]
}AgentBrowserClaim
{
"type": "object",
"additionalProperties": false,
"properties": {
"connection": {
"$ref": "#/components/schemas/AgentConnection"
},
"claimId": {
"type": "string"
},
"expiresAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"connection",
"claimId",
"expiresAt"
]
}AgentCapabilities
{
"type": "object",
"additionalProperties": false,
"properties": {
"protocolVersion": {
"const": 2
},
"available": {
"type": "boolean"
},
"flow": {
"const": "temporary_account_api_key"
},
"dataOrigin": {
"type": "string"
},
"queryPath": {
"const": "/v1/queries/realtime"
},
"credentialType": {
"const": "api_key"
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentPermission"
}
},
"owner": {
"type": "object",
"additionalProperties": false,
"required": [
"scopes"
],
"properties": {
"scopes": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"trial": {
"type": "object",
"additionalProperties": false,
"properties": {
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"credits": {
"type": "number"
},
"lifetimeHours": {
"type": "integer",
"minimum": 0
},
"requestsPerSecond": {
"type": "integer",
"minimum": 0
},
"maxBatchSize": {
"type": "integer",
"minimum": 0
},
"requestCounts": {}
},
"required": [
"credits",
"lifetimeHours",
"requestsPerSecond",
"maxBatchSize",
"requestCounts"
]
},
"recurringRequires": {
"const": "owned_key_installed"
},
"replayProtection": {
"const": "client_local_only"
}
},
"required": [
"protocolVersion",
"available"
]
}AgentClaim
{
"type": "object",
"additionalProperties": false,
"properties": {
"claimId": {
"type": "string"
},
"claimPath": {
"type": "string"
},
"confirmationCode": {
"type": "string",
"pattern": "^\\d{8}$"
},
"expiresAt": {
"type": "string",
"format": "date-time"
},
"pollAfterSeconds": {
"type": "integer",
"minimum": 0
}
},
"required": [
"claimId",
"claimPath",
"confirmationCode",
"expiresAt",
"pollAfterSeconds"
]
}AgentClaimView
{
"type": "object",
"additionalProperties": false,
"required": [
"connection"
],
"properties": {
"connection": {
"$ref": "#/components/schemas/AgentConnection"
},
"handoff": {
"type": "object",
"additionalProperties": false,
"required": [
"status"
],
"properties": {
"status": {
"type": "string"
}
}
}
}
}AgentConnection
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"audience": {
"type": "string",
"enum": [
"coding",
"personal",
"unspecified"
]
},
"ownership": {
"type": "string",
"enum": [
"owned",
"unowned"
]
},
"lifecycle": {
"type": "string",
"enum": [
"valid",
"revoked",
"expired"
]
},
"access": {
"type": "string",
"enum": [
"ready",
"fenced",
"blocked"
]
},
"scopes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Actual scopes on the current API key. May be empty on an unowned claim-only connection; every data-source request is then forbidden."
},
"requestedScopes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Original owner-access request. Claim approval can only reduce this set. Legacy connections retain their original scopes."
},
"trialScopes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Saved subset eligible for the temporary key. Never expanded by catalog changes."
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentPermission"
}
},
"generation": {
"type": "integer",
"minimum": 0
},
"installed": {
"type": "boolean"
},
"trialExpiresAt": {
"type": "string",
"format": "date-time"
},
"fundingMode": {
"type": "string",
"enum": [
"trial",
"account_balance"
]
},
"trialCredits": {
"type": "number"
},
"trialRequestCounts": {}
},
"required": [
"id",
"name",
"audience",
"ownership",
"lifecycle",
"access",
"scopes",
"generation",
"installed",
"trialExpiresAt",
"fundingMode",
"trialCredits",
"trialRequestCounts"
]
}AgentConnectionResponse
{
"type": "object",
"additionalProperties": false,
"properties": {
"connection": {
"$ref": "#/components/schemas/AgentConnection"
}
},
"required": [
"connection"
]
}AgentHandoff
{
"type": "object",
"additionalProperties": false,
"properties": {
"status": {
"type": "string",
"enum": [
"delivered",
"confirmed"
]
},
"connection": {
"$ref": "#/components/schemas/AgentConnection"
},
"credentials": {
"$ref": "#/components/schemas/AgentCredentials"
},
"generation": {
"type": "integer",
"minimum": 0
}
},
"required": [
"status"
]
}AgentCredentials
{
"type": "object",
"additionalProperties": false,
"properties": {
"connectionId": {
"type": "string"
},
"apiKey": {
"type": "string"
},
"setupCredential": {
"type": "string"
},
"handoffProof": {
"type": "string"
},
"generation": {
"type": "integer",
"minimum": 0
}
},
"required": [
"connectionId",
"apiKey",
"generation"
],
"description": "Sensitive ordinary API-key credentials. Never log or put in browser URLs. Proofs are returned on temporary registration; handoff returns the owned candidate key."
}AgentOnboardingStatus
{
"type": "object",
"additionalProperties": false,
"properties": {
"status": {
"type": "string",
"enum": [
"awaiting_claim",
"claim_processing",
"handoff_ready",
"installed",
"handoff_expired",
"expired",
"revoked",
"blocked"
]
},
"connection": {
"$ref": "#/components/schemas/AgentConnection"
},
"expiresAt": {
"type": "string",
"format": "date-time"
},
"nextAction": {
"type": "string"
},
"pollAfterSeconds": {
"type": "integer",
"minimum": 0
}
},
"required": [
"status"
]
}AgentPermission
{
"type": "object",
"additionalProperties": false,
"required": [
"source",
"name",
"product",
"trialEligible",
"ownerAllowed",
"requiresStorageDestination"
],
"properties": {
"source": {
"type": "string",
"pattern": "^[a-z_]{1,80}$"
},
"name": {
"type": "string"
},
"product": {
"type": "string"
},
"trialEligible": {
"type": "boolean"
},
"ownerAllowed": {
"type": "boolean"
},
"requiresStorageDestination": {
"type": "boolean"
}
},
"description": "Catalog-derived agent permissions. Trial eligibility is an explicit opt-in independent of owner approval. Storage and variable-price sources require owner access."
}AgentRegistration
{
"type": "object",
"additionalProperties": false,
"properties": {
"connection": {
"$ref": "#/components/schemas/AgentConnection"
},
"credentials": {
"$ref": "#/components/schemas/AgentCredentials"
},
"dataOrigin": {
"type": "string"
},
"deniedScopes": {
"type": "array",
"items": {
"type": "string"
}
},
"limits": {
"type": "object",
"additionalProperties": true
},
"nextAction": {
"type": "string",
"enum": [
"query_or_claim",
"claim"
],
"description": "Claim before the first data request when no requested source is trial eligible."
}
},
"required": [
"connection",
"credentials",
"dataOrigin",
"deniedScopes",
"limits"
]
}AgentRegistrationRequest
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"audience": {
"type": "string",
"enum": [
"coding",
"personal"
]
},
"scopes": {
"type": "array",
"minItems": 1,
"maxItems": 30,
"uniqueItems": true,
"items": {
"type": "string",
"pattern": "^[a-z_]{1,80}$"
}
},
"client": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9_-]{0,63}$"
},
"transport": {
"type": "string",
"enum": [
"api",
"cli",
"mcp"
]
}
},
"required": [
"name",
"scopes"
]
}ApiAccess
{
"type": "object",
"additionalProperties": false,
"required": [
"sources",
"result_origin"
],
"properties": {
"sources": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/components/schemas/ApiAccessSource"
}
},
"result_origin": {
"type": [
"string",
"null"
],
"format": "uri",
"description": "Configured signed-result storage origin, without credentials, path, query or fragment. Not an access token or a media URL."
}
}
}ApiAccessBalance
{
"type": "object",
"additionalProperties": false,
"required": [
"scope",
"unit",
"balanceCredits",
"availableCredits",
"updatedAt",
"note"
],
"properties": {
"scope": {
"type": "string",
"const": "account"
},
"unit": {
"type": "string",
"const": "Credits"
},
"balanceCredits": {
"type": "number",
"description": "Signed live balance; in-flight reservations may already be reflected."
},
"availableCredits": {
"type": "number",
"minimum": 0,
"description": "max(balanceCredits, 0)."
},
"updatedAt": {
"type": [
"string",
"null"
]
},
"note": {
"type": "string"
}
}
}ApiAccessLimits
{
"type": "object",
"additionalProperties": false,
"required": [
"scope",
"plan",
"limits",
"current",
"note"
],
"properties": {
"scope": {
"type": "string",
"const": "account"
},
"plan": {
"$ref": "#/components/schemas/ApiAccessPlan"
},
"limits": {
"type": "object",
"additionalProperties": false,
"properties": {
"concurrency": {
"type": "integer",
"minimum": 0
},
"batchSize": {
"type": "integer",
"minimum": 0
},
"pendingJobs": {
"type": "integer",
"minimum": 0
}
}
},
"current": {
"type": "object",
"additionalProperties": false,
"required": [
"pendingJobs"
],
"properties": {
"pendingJobs": {
"type": "integer",
"minimum": 0
}
}
},
"note": {
"type": "string"
}
}
}ApiAccessPlan
{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"billingMode": {
"type": "string"
},
"status": {
"type": "string"
}
}
}ApiAccessPricing
{
"type": "object",
"additionalProperties": false,
"required": [
"unit",
"plan",
"requestCount",
"prices",
"note"
],
"properties": {
"unit": {
"type": "string",
"const": "Credits"
},
"plan": {
"$ref": "#/components/schemas/ApiAccessPlan"
},
"requestCount": {
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"prices": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"source",
"available",
"estimatedCredits"
],
"properties": {
"source": {
"$ref": "#/components/schemas/ApiAccessSource"
},
"available": {
"type": "boolean"
},
"creditsPerRequest": {
"type": [
"number",
"null"
],
"minimum": 0
},
"estimatedCredits": {
"type": [
"number",
"null"
],
"minimum": 0,
"description": "Null for downloads or missing pricing."
},
"billingUnit": {
"type": "string",
"const": "TB"
},
"bytesPerUnit": {
"type": "integer",
"const": 1000000000000
},
"creditsPerTb": {
"type": [
"number",
"null"
],
"minimum": 0
},
"note": {
"type": "string"
}
}
}
},
"note": {
"type": "string"
}
}
}ApiAccessSource
{
"type": "string",
"enum": [
"google_search",
"google_images",
"google_news",
"google_shopping",
"google_videos",
"google_places",
"youtube_search",
"youtube_search_extended",
"youtube_metadata",
"youtube_transcript",
"youtube_captions",
"youtube_trainability",
"youtube_channel",
"youtube_suggestions",
"youtube_download"
]
}ApiKey
{
"type": "object",
"description": "API key details. A key remains active until scheduledRevocationAt when revocation is scheduled.",
"additionalProperties": false,
"required": [
"id",
"name",
"prefix",
"last4",
"scopes",
"status",
"createdAt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^key_"
},
"name": {
"type": "string"
},
"prefix": {
"type": "string"
},
"last4": {
"type": "string",
"minLength": 4,
"maxLength": 4
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"type": "string",
"enum": [
"active",
"revoked",
"expired"
]
},
"lastUsedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"expiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"scheduledRevocationAt": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Planned revocation time for an overlapping retiring key; null for a primary or immediately revoked key."
},
"createdAt": {
"type": "string",
"format": "date-time"
}
}
}ApiKeyCreated
{
"type": "object",
"additionalProperties": false,
"required": [
"apiKey",
"secret"
],
"properties": {
"apiKey": {
"$ref": "#/components/schemas/ApiKey"
},
"secret": {
"type": "string",
"readOnly": true,
"pattern": "^fd_(?:(?:test|live)_)?[A-Za-z0-9_-]{43}$",
"description": "Plaintext secret returned only by this create/rotate transaction. Newly issued secrets use the `fd_` prefix. Previously issued `fd_test_` and `fd_live_` secrets still authenticate. An authenticated replay with the same Idempotency-Key and request body may receive the same KMS-encrypted response for five minutes; it is not recoverable afterward.",
"x-secret-reveal": "once"
}
}
}ApiKeyUsage
{
"type": "object",
"additionalProperties": false,
"required": [
"scope",
"unit",
"from",
"to",
"observedAt",
"totals",
"bySource",
"updating",
"note"
],
"properties": {
"scope": {
"type": "string",
"const": "account_authorized_sources"
},
"unit": {
"type": "string",
"const": "Credits"
},
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
},
"observedAt": {
"type": "string",
"format": "date-time"
},
"totals": {
"$ref": "#/components/schemas/UsageCounts"
},
"bySource": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"source",
"requests",
"completed",
"failed",
"credits"
],
"properties": {
"source": {
"type": "string"
},
"requests": {
"type": "integer",
"minimum": 0
},
"completed": {
"type": "integer",
"minimum": 0
},
"failed": {
"type": "integer",
"minimum": 0
},
"credits": {
"type": "number",
"minimum": 0
}
}
}
},
"updating": {
"type": "boolean"
},
"note": {
"type": "string"
}
}
}BillingPaymentPage
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"pagination"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillingPayment"
}
},
"pagination": {
"$ref": "#/components/schemas/Pagination"
}
}
}BillingPayment
{
"description": "Account-scoped top-up projection. Refund state is updated only from verified provider events; this API does not initiate refunds.",
"type": "object",
"additionalProperties": false,
"required": [
"id",
"purchaseType",
"status",
"currency",
"amount",
"refundedAmount",
"credits",
"reversedCredits",
"createdAt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^pay_"
},
"purchaseType": {
"type": "string",
"const": "top_up"
},
"status": {
"type": "string",
"enum": [
"pending",
"paid",
"partially_refunded",
"refunded",
"failed"
]
},
"currency": {
"type": "string",
"const": "USD"
},
"amount": {
"type": "integer",
"minimum": 0,
"description": "USD cents"
},
"refundedAmount": {
"type": "integer",
"minimum": 0,
"description": "USD cents"
},
"credits": {
"type": "number",
"minimum": 0,
"multipleOf": 0.001
},
"hostedInvoiceUrl": {
"type": [
"string",
"null"
],
"format": "uri",
"description": "Stripe-hosted HTTPS invoice URL, when Stripe created an invoice for this top-up."
},
"invoiceNumber": {
"type": [
"string",
"null"
],
"description": "Stripe invoice number, when available."
},
"reversedCredits": {
"type": "number",
"minimum": 0,
"multipleOf": 0.001,
"description": "Cumulative credits removed by append-only payment_reversal entries; never exceeds credits."
},
"paidAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"refundedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdAt": {
"type": "string",
"format": "date-time"
}
}
}BulkJobCreated
{
"type": "object",
"additionalProperties": false,
"required": [
"job",
"upload"
],
"properties": {
"job": {
"$ref": "#/components/schemas/BulkJob"
},
"upload": {
"type": "object",
"additionalProperties": false,
"required": [
"href",
"method",
"expiresAt",
"contentType"
],
"properties": {
"href": {
"type": "string",
"format": "uri"
},
"method": {
"type": "string",
"const": "PUT"
},
"expiresAt": {
"type": "string",
"format": "date-time"
},
"contentType": {
"type": "string",
"const": "text/plain; charset=utf-8"
}
}
}
}
}BulkJob
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"source",
"status",
"input",
"counts",
"delivery",
"pauseReason",
"error",
"createdAt",
"startedAt",
"completedAt",
"expiresAt",
"links"
],
"properties": {
"id": {
"type": "string",
"pattern": "^bulk_[A-Za-z0-9_-]{8,}$"
},
"source": {
"type": "string",
"enum": [
"youtube_metadata",
"youtube_transcript",
"youtube_captions",
"youtube_trainability",
"youtube_download"
]
},
"status": {
"type": "string",
"enum": [
"awaiting_upload",
"running",
"paused",
"finalizing",
"completed",
"failed",
"cancelled"
]
},
"input": {
"type": "object",
"additionalProperties": false,
"required": [
"bytes",
"complete",
"scannedBytes",
"scannedLines"
],
"properties": {
"bytes": {
"type": "integer",
"minimum": 0
},
"complete": {
"type": "boolean"
},
"scannedBytes": {
"type": "integer",
"minimum": 0
},
"scannedLines": {
"type": "integer",
"minimum": 0
}
}
},
"counts": {
"type": "object",
"additionalProperties": false,
"required": [
"accepted",
"completed",
"failed",
"invalid",
"results"
],
"properties": {
"accepted": {
"type": "integer",
"minimum": 0
},
"completed": {
"type": "integer",
"minimum": 0
},
"failed": {
"type": "integer",
"minimum": 0
},
"invalid": {
"type": "integer",
"minimum": 0
},
"results": {
"type": "integer",
"minimum": 0
}
}
},
"pauseReason": {
"type": [
"string",
"null"
]
},
"delivery": {
"type": "object",
"additionalProperties": false,
"required": [
"customerStorage",
"storageType",
"uploadedParts",
"retryCount"
],
"properties": {
"customerStorage": {
"type": "boolean"
},
"storageType": {
"type": [
"string",
"null"
],
"enum": [
"s3",
"s3_compatible",
"oss",
"gcs",
"azure",
"cos",
"bos",
"tos",
null
]
},
"uploadedParts": {
"type": "integer",
"minimum": 0
},
"retryCount": {
"type": "integer",
"minimum": 0
}
}
},
"error": {
"oneOf": [
{
"type": "null"
},
{
"type": "object",
"additionalProperties": false,
"required": [
"code",
"detail"
],
"properties": {
"code": {
"type": "string"
},
"detail": {
"type": [
"string",
"null"
]
}
}
}
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"startedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"completedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"expiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JobLink"
}
}
}
}BulkJobPage
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"pagination"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkJob"
}
},
"pagination": {
"$ref": "#/components/schemas/Pagination"
}
}
}BulkJobResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"job"
],
"properties": {
"job": {
"$ref": "#/components/schemas/BulkJob"
}
}
}ConsoleJob
{
"type": "object",
"additionalProperties": false,
"required": [
"createdAt",
"credits",
"durationMs",
"error",
"id",
"params",
"progress",
"result",
"source",
"status",
"updatedAt",
"videoId"
],
"properties": {
"createdAt": {
"type": "string",
"format": "date-time"
},
"credits": {
"type": "number",
"multipleOf": 0.001
},
"durationMs": {
"type": [
"number",
"null"
],
"minimum": 0
},
"error": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"params": {
"type": "object",
"additionalProperties": true
},
"progress": {
"type": "integer",
"minimum": 0
},
"result": {
"type": [
"object",
"null"
],
"additionalProperties": true
},
"source": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"completed",
"failed",
"pending",
"processing"
]
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"videoId": {
"type": [
"string",
"null"
]
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JobLink"
}
}
}
}ConsoleOverview
{
"type": "object",
"additionalProperties": false,
"required": [
"account",
"onboarding",
"subscription",
"balance",
"publicStatus",
"degradedSections",
"generatedAt"
],
"properties": {
"account": {
"$ref": "#/components/schemas/Account"
},
"onboarding": {
"$ref": "#/components/schemas/OnboardingProgress"
},
"subscription": {
"oneOf": [
{
"$ref": "#/components/schemas/Subscription"
},
{
"type": "null"
}
]
},
"balance": {
"oneOf": [
{
"$ref": "#/components/schemas/CreditBalance"
},
{
"type": "null"
}
]
},
"publicStatus": {
"oneOf": [
{
"$ref": "#/components/schemas/PublicStatus"
},
{
"type": "null"
}
]
},
"degradedSections": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"subscription",
"balance",
"public_status"
]
},
"description": "A listed section uses its unavailable representation; null and empty values must not be interpreted as zero or healthy."
},
"generatedAt": {
"type": "string",
"format": "date-time"
}
}
}CreateApiKeyRequest
{
"type": "object",
"additionalProperties": false,
"required": [
"name",
"scopes"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"scopes": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"google_search",
"google_images",
"google_news",
"google_shopping",
"google_videos",
"google_places",
"youtube_search",
"youtube_search_extended",
"youtube_metadata",
"youtube_transcript",
"youtube_captions",
"youtube_trainability",
"youtube_channel",
"youtube_suggestions",
"youtube_download"
]
}
},
"expiresAt": {
"type": "string",
"format": "date-time"
}
}
}CreateBulkJobRequest
{
"type": "object",
"additionalProperties": false,
"required": [
"source"
],
"properties": {
"source": {
"type": "string",
"enum": [
"youtube_metadata",
"youtube_transcript",
"youtube_captions",
"youtube_trainability",
"youtube_download"
]
},
"options": {
"type": "object",
"additionalProperties": true,
"description": "Reused for every ID. Metadata accepts include_formats and include_chapters. Transcript and captions accept language (one code or an array of 1–10 distinct codes) and auto (applies to all requested languages). Omit language to prefer en-orig, fall back to en, and return one track. With auto=true, each requested code tries its -orig track first, then the plain code. Explicit -orig codes and auto=false stay exact. languageCode identifies the selected track; requestedLanguageCode is included when it differs from the requested code. A language array returns tracks and per-language errors for each video with at least one retrieved track. If no track is retrieved, the video job fails and its reserved credits are refunded. Bulk exports use one JSONL record per video. Trainability accepts no source options. These four data sources optionally accept result_storage. Supported storage_type values are s3, s3_compatible, oss, gcs, azure, cos, bos, and tos. storage_url is the bucket name (Azure container name); object_prefix is optional. S3, S3-compatible, OSS, COS, BOS, and TOS use access_key and secret_key. S3-compatible and OSS also require a public HTTPS endpoint_url. COS, BOS, and TOS require region and use fixed provider endpoints. COS bucket names include the APPID. BOS S3-compatible HTTPS delivery supports bj, su, and hkg. GCS requires service_account with project_id, client_email, and private_key. Azure requires account_name and a container SAS sas_token with write permission. Default object_prefix is YYYYMMDD, frozen to the UTC bulk creation date. Files are written to <prefix>/<source>/<bulkId>/results/part-NNNNNNNN.jsonl.gz; manifest.json in the same bulk directory is written last. Each JSONL row includes its input index and completed, failed, or invalid status. Internal R2 results remain available through the result links for 24 hours. Download accepts the normal YouTube download parameters, requires customer storage, and does not permit browser_delivery. Download storage supports the same eight provider types and credential shapes listed above under the storage field. Download storage may include object_prefix; YYYYMMDD tokens resolve to the UTC upload date, while literal prefixes are unchanged."
},
"callback_url": {
"type": "string",
"format": "uri",
"maxLength": 2048,
"description": "Optional public HTTPS endpoint notified once after manifest publication."
}
}
}CreateDeliveryWebhookRequest
{
"type": "object",
"additionalProperties": false,
"required": [
"name",
"url"
],
"properties": {
"name": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
}
}
}CreditBalance
{
"type": "object",
"additionalProperties": false,
"required": [
"balanceCredits",
"reservedCredits",
"availableCredits",
"lifetimeGrantedCredits",
"lifetimeUsedCredits",
"lifetimeRefundedCredits",
"lifetimePaymentReversedCredits",
"updatedAt"
],
"properties": {
"balanceCredits": {
"type": "number",
"multipleOf": 0.001,
"description": "Signed settled balance after grants, usage, refunds and provider reversals."
},
"reservedCredits": {
"type": "number",
"minimum": 0,
"multipleOf": 0.001
},
"availableCredits": {
"type": "number",
"minimum": 0,
"multipleOf": 0.001,
"description": "max(balanceCredits, 0)."
},
"lifetimeGrantedCredits": {
"type": "number",
"minimum": 0,
"multipleOf": 0.001
},
"lifetimeUsedCredits": {
"type": "number",
"minimum": 0,
"multipleOf": 0.001
},
"lifetimeRefundedCredits": {
"type": "number",
"minimum": 0,
"multipleOf": 0.001,
"description": "Credits returned to the account after failed usage."
},
"lifetimePaymentReversedCredits": {
"type": "number",
"minimum": 0,
"multipleOf": 0.001,
"description": "Absolute Credits removed after verified provider refunds or chargebacks."
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
}
}CreditEntryType
{
"type": "string",
"enum": [
"subscription_grant",
"topup_grant",
"payment_reversal",
"admin_adjustment",
"trial_grant"
]
}CreditPolicy
{
"type": "object",
"additionalProperties": false,
"required": [
"unit",
"failedRequestsCharged",
"subscriptionGrantTiming",
"refundHandling"
],
"properties": {
"unit": {
"type": "string",
"const": "credit"
},
"failedRequestsCharged": {
"type": "boolean",
"const": false
},
"subscriptionGrantTiming": {
"type": "string",
"const": "invoice_paid"
},
"refundHandling": {
"type": "string",
"const": "append_only_reversal",
"description": "Failed requests are refunded; verified provider refunds remove the proportional Credits through immutable transactions."
}
}
}CreditTransaction
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"type",
"deltaCredits",
"balanceAfterCredits",
"createdAt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^ctx_"
},
"type": {
"$ref": "#/components/schemas/CreditEntryType"
},
"deltaCredits": {
"type": "number",
"multipleOf": 0.001
},
"balanceAfterCredits": {
"type": [
"number",
"null"
],
"multipleOf": 0.001,
"description": "Signed settled balance after this immutable transaction, when recorded."
},
"description": {
"type": "string"
},
"requestId": {
"type": [
"string",
"null"
]
},
"jobId": {
"type": [
"string",
"null"
]
},
"createdAt": {
"type": "string",
"format": "date-time"
}
}
}DataSource
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"name",
"category",
"product",
"modes",
"inputSchema",
"estimatedCredits",
"requiresStorageDestination"
],
"properties": {
"id": {
"type": "string",
"enum": [
"google_search",
"google_images",
"google_news",
"google_shopping",
"google_videos",
"google_places",
"youtube_search",
"youtube_search_extended",
"youtube_metadata",
"youtube_transcript",
"youtube_captions",
"youtube_trainability",
"youtube_channel",
"youtube_suggestions",
"youtube_download"
]
},
"name": {
"type": "string"
},
"category": {
"type": "string",
"enum": [
"google",
"youtube"
]
},
"product": {
"type": "string",
"enum": [
"google_search",
"youtube_data",
"youtube_download"
]
},
"modes": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"description": "Only modes backed by a real adapter or consumer in the current release",
"items": {
"type": "string",
"enum": [
"realtime",
"async",
"batch"
]
}
},
"inputSchema": {
"type": "object",
"additionalProperties": true,
"description": "JSON Schema used by the Playground and generated clients"
},
"estimatedCredits": {
"type": "number",
"minimum": 0,
"multipleOf": 0.001
},
"requiresStorageDestination": {
"type": "boolean",
"description": "Whether query submission must include per-request storage configuration."
}
}
}DeliveryWebhook
{
"type": "object",
"additionalProperties": false,
"required": [
"createdAt",
"id",
"lastTestStatus",
"lastTestedAt",
"name",
"status",
"updatedAt",
"url"
],
"properties": {
"createdAt": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "string",
"pattern": "^cbk_[A-Za-z0-9_-]{8,}$"
},
"lastTestStatus": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"lastTestedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"active",
"disabled"
]
},
"updatedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"url": {
"type": "string",
"format": "uri"
}
}
}Health
{
"type": "object",
"additionalProperties": false,
"required": [
"status",
"service",
"version",
"time"
],
"properties": {
"status": {
"type": "string",
"enum": [
"healthy",
"degraded"
]
},
"service": {
"type": "string"
},
"version": {
"type": "string"
},
"time": {
"type": "string",
"format": "date-time"
}
}
}HostedSession
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"url",
"expiresAt"
],
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri",
"description": "Provider-hosted HTTPS URL on a Stripe-controlled *.stripe.com host. Web clients must validate the origin and redirect from a server-only boundary."
},
"expiresAt": {
"type": "string",
"format": "date-time"
}
}
}Invoice
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"number",
"status",
"currency",
"total",
"amountPaid",
"refundedAmount",
"billingReason",
"createdAt",
"periodStart",
"periodEnd"
],
"properties": {
"id": {
"type": "string",
"pattern": "^inv_"
},
"number": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"draft",
"open",
"paid",
"void",
"uncollectible"
]
},
"currency": {
"type": "string",
"const": "USD"
},
"total": {
"type": "integer",
"description": "USD cents"
},
"amountPaid": {
"type": "integer",
"description": "USD cents"
},
"refundedAmount": {
"type": "integer",
"minimum": 0,
"description": "Cumulative USD cents observed from verified provider events."
},
"billingReason": {
"type": [
"string",
"null"
],
"enum": [
"subscription_create",
"subscription_cycle",
"subscription_update",
null
]
},
"hostedInvoiceUrl": {
"type": [
"string",
"null"
],
"format": "uri",
"description": "Stripe-hosted HTTPS invoice URL. Production Web clients accept only Stripe-controlled *.stripe.com origins."
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"paidAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"periodStart": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"periodEnd": {
"type": [
"string",
"null"
],
"format": "date-time"
}
}
}JobLink
{
"type": "object",
"additionalProperties": false,
"required": [
"rel",
"href",
"method"
],
"properties": {
"rel": {
"type": "string",
"enum": [
"self",
"results",
"content",
"download"
]
},
"href": {
"type": "string",
"format": "uri"
},
"method": {
"type": "string",
"const": "GET"
},
"expires_at": {
"type": "string",
"format": "date-time"
},
"filename": {
"type": "string"
},
"content_type": {
"type": "string"
},
"size_bytes": {
"type": "integer",
"minimum": 1
}
}
}LegalAcceptanceRequest
{
"type": "object",
"additionalProperties": false,
"required": [
"acceptedTerms",
"termsVersion",
"privacyVersion"
],
"properties": {
"acceptedTerms": {
"type": "boolean",
"const": true
},
"termsVersion": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"privacyVersion": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
}
}LoginRequest
{
"type": "object",
"additionalProperties": false,
"required": [
"email",
"password"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 320
},
"password": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"writeOnly": true
},
"rememberMe": {
"type": "boolean",
"default": false,
"description": "Ignored for email_verification, legal_acceptance and deletion_recovery Sessions, which always use a short fixed expiry."
}
}
}LoginResponse
{
"type": "object",
"additionalProperties": false,
"required": [
"account",
"csrfToken",
"sessionMode"
],
"properties": {
"account": {
"$ref": "#/components/schemas/Account"
},
"csrfToken": {
"type": "string",
"minLength": 32,
"readOnly": true
},
"sessionMode": {
"type": "string",
"enum": [
"full",
"email_verification",
"legal_acceptance",
"deletion_recovery"
]
}
}
}MarkdownQueryResult
{
"type": "object",
"required": [
"source",
"status",
"content"
],
"additionalProperties": true,
"description": "Markdown result content. content replaces the results array; other response fields such as id, source, status, usage and timestamps are preserved. No generated summary is added. Source URLs and transcript segment start/end times are retained.",
"properties": {
"source": {
"type": "string"
},
"status": {
"type": "string"
},
"content": {
"type": "string",
"description": "Deterministic Markdown derived from the retrieved source result."
},
"usage": {
"type": "object",
"additionalProperties": true
}
}
}OAuthConnection
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"clientName",
"scope",
"status",
"createdAt",
"expiresAt"
],
"properties": {
"id": {
"type": "string",
"pattern": "^oag_[A-Za-z0-9_-]{8,}$"
},
"clientName": {
"type": "string"
},
"scope": {
"type": "string",
"enum": [
"mcp:research"
]
},
"status": {
"type": "string",
"enum": [
"active",
"expired",
"revoked"
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"expiresAt": {
"type": "string",
"format": "date-time"
}
}
}OAuthConsent
{
"type": "object",
"additionalProperties": false,
"required": [
"clientName",
"scope",
"sources",
"redirectUri",
"expiresAt"
],
"properties": {
"clientName": {
"type": "string",
"maxLength": 80
},
"scope": {
"type": "string",
"enum": [
"mcp:research"
]
},
"sources": {
"type": "array",
"items": {
"type": "string",
"enum": [
"google_search",
"youtube_search",
"youtube_metadata",
"youtube_transcript"
]
}
},
"redirectUri": {
"type": "string",
"format": "uri"
},
"expiresAt": {
"type": "string",
"format": "date-time"
}
}
}OnboardingProgress
{
"type": "object",
"additionalProperties": false,
"required": [
"currentStep",
"apiKeyStepStatus",
"firstRequestStatus",
"version",
"updatedAt"
],
"properties": {
"currentStep": {
"type": "string",
"enum": [
"welcome",
"api_key",
"first_request",
"completed"
]
},
"useCase": {
"type": [
"string",
"null"
],
"enum": [
"google_search",
"youtube_data",
"download",
null
]
},
"apiKeyStepStatus": {
"type": "string",
"enum": [
"pending",
"created",
"skipped"
]
},
"firstRequestStatus": {
"type": "string",
"enum": [
"pending",
"succeeded",
"skipped"
]
},
"firstApiKeyId": {
"type": [
"string",
"null"
],
"pattern": "^key_"
},
"firstRequestId": {
"type": [
"string",
"null"
],
"pattern": "^req_"
},
"completedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"version": {
"type": "integer",
"minimum": 0
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
}
}Page
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"pagination"
],
"properties": {
"data": {
"type": "array",
"items": {}
},
"pagination": {
"$ref": "#/components/schemas/Pagination"
}
}
}Pagination
{
"type": "object",
"additionalProperties": false,
"required": [
"hasMore",
"limit"
],
"properties": {
"nextCursor": {
"type": [
"string",
"null"
]
},
"previousCursor": {
"type": [
"string",
"null"
]
},
"hasMore": {
"type": "boolean"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
}
}Password
{
"type": "string",
"minLength": 8,
"maxLength": 128,
"writeOnly": true
}PlanCatalog
{
"type": "object",
"additionalProperties": false,
"required": [
"data",
"currency",
"billingAvailability",
"creditValueUsd"
],
"properties": {
"trialOffer": {
"description": "Current one-time trial allowance expressed as alternative PAYG usage amounts. Eligibility and approval are required. The amounts share one balance and are not additive. Null when a reliable estimate is unavailable. This is not an account eligibility decision or a promise of immediate credit issuance.",
"oneOf": [
{
"$ref": "#/components/schemas/PublicTrialOffer"
},
{
"type": "null"
}
]
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Plan"
}
},
"currency": {
"type": "string",
"const": "USD"
},
"creditValueUsd": {
"type": "number",
"exclusiveMinimum": 0,
"description": "Fixed USD value of one credit, used to preview custom top-ups. The server computes the credited amount."
},
"billingAvailability": {
"type": "string",
"enum": [
"available",
"unconfigured",
"unavailable"
]
},
"billingMessage": {
"type": [
"string",
"null"
],
"description": "Stable, non-sensitive explanation suitable for the Pricing and Billing UI."
}
}
}Plan
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"slug",
"name",
"description",
"includedCredits",
"limits",
"prices",
"features",
"usagePrices"
],
"properties": {
"id": {
"type": "string",
"pattern": "^plan_"
},
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"includedCredits": {
"type": "number",
"minimum": 0,
"multipleOf": 0.001,
"description": "Credits included in each paid subscription cycle; zero for Pay As You Go."
},
"limits": {
"$ref": "#/components/schemas/PlanLimits"
},
"prices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlanPrice"
}
},
"features": {
"type": "array",
"items": {
"type": "string"
}
},
"usagePrices": {
"$ref": "#/components/schemas/PlanUsagePrices"
}
}
}PlanLimits
{
"type": "object",
"additionalProperties": false,
"required": [
"concurrency",
"maxBatchSize",
"maxPendingJobs"
],
"properties": {
"concurrency": {
"type": "integer",
"minimum": 1
},
"maxBatchSize": {
"type": "integer",
"minimum": 1
},
"maxPendingJobs": {
"type": "integer",
"minimum": 1
}
}
}PlanPrice
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"currency",
"unitAmount",
"credits",
"type",
"interval"
],
"properties": {
"id": {
"type": "string",
"pattern": "^prc_"
},
"currency": {
"type": "string",
"const": "USD"
},
"unitAmount": {
"type": "integer",
"minimum": 0,
"description": "USD cents"
},
"credits": {
"type": "number",
"minimum": 0,
"multipleOf": 0.001,
"description": "Credits granted by a successful one-time top-up; zero for recurring prices."
},
"type": {
"type": "string",
"enum": [
"recurring",
"one_time"
]
},
"interval": {
"type": [
"string",
"null"
],
"enum": [
"month",
"year",
null
]
}
}
}PlanUsagePrices
{
"type": "object",
"additionalProperties": false,
"required": [
"googlePer1kCents",
"youtubePer1kCents",
"downloadPerTbCents"
],
"properties": {
"googlePer1kCents": {
"type": "integer",
"minimum": 0,
"description": "Google request price per 1,000 successful requests, in USD cents."
},
"youtubePer1kCents": {
"type": "integer",
"minimum": 0,
"description": "Standard YouTube request price per 1,000 successful requests, in USD cents."
},
"downloadPerTbCents": {
"type": "integer",
"minimum": 0,
"description": "Download price per decimal TB (1,000,000,000,000 bytes), in USD cents."
}
}
}Problem
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"title",
"status",
"code",
"requestId"
],
"properties": {
"type": {
"type": "string",
"format": "uri-reference"
},
"title": {
"type": "string"
},
"status": {
"type": "integer",
"minimum": 400,
"maximum": 599
},
"code": {
"type": "string",
"pattern": "^[a-z0-9_]+$"
},
"detail": {
"type": "string"
},
"requestId": {
"type": "string",
"pattern": "^req_"
},
"fieldErrors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldError"
}
}
}
}FieldError
{
"type": "object",
"additionalProperties": false,
"required": [
"field",
"code",
"message"
],
"properties": {
"field": {
"type": "string"
},
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}PublicLegalVersions
{
"type": "object",
"additionalProperties": false,
"required": [
"availability",
"termsVersion",
"privacyVersion"
],
"properties": {
"availability": {
"type": "string",
"enum": [
"configured",
"unconfigured"
]
},
"termsVersion": {
"type": [
"string",
"null"
],
"minLength": 1,
"maxLength": 64
},
"privacyVersion": {
"type": [
"string",
"null"
],
"minLength": 1,
"maxLength": 64
}
}
}PublicStatus
{
"type": "object",
"additionalProperties": false,
"required": [
"status",
"updatedAt",
"components"
],
"properties": {
"status": {
"type": "string",
"enum": [
"healthy",
"degraded",
"outage"
]
},
"updatedAt": {
"type": "string",
"format": "date-time"
},
"components": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PublicStatusComponent"
}
}
}
}PublicStatusComponent
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"name",
"status"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"operational",
"degraded",
"outage"
]
}
}
}PublicTrialOffer
{
"type": "object",
"additionalProperties": false,
"required": [
"googleSearchRequests",
"youtubeDataRequests",
"downloadGigabytes"
],
"properties": {
"maxApiRequests": {
"type": "integer",
"minimum": 0,
"description": "Maximum free API calls when the entire trial grant is spent on the lowest-cost per-request API at current Pay as you go rates. Other APIs may allow fewer calls. Downloads are billed by delivered bytes and excluded from this count."
},
"googleSearchRequests": {
"type": "integer",
"minimum": 0,
"description": "Requests if the entire grant is spent on Google sources, using the highest current source rate."
},
"youtubeDataRequests": {
"type": "integer",
"minimum": 0,
"description": "Standard YouTube requests, excluding Extended Search, using the highest current source rate."
},
"downloadGigabytes": {
"type": "number",
"minimum": 0,
"description": "Approximate delivered media volume in decimal GB (1 GB = 1000000000 bytes). Zero when the grant cannot cover the initial download reservation. Completion also depends on per-job reservations and settlement."
}
}
}QueryRepresentationError
{
"type": "object",
"required": [
"error",
"code",
"message"
],
"properties": {
"error": {
"type": "boolean",
"const": true
},
"code": {
"type": "string",
"enum": [
"unsupported_representation",
"not_acceptable"
]
},
"message": {
"type": "string"
}
}
}Reauthentication
{
"type": "object",
"additionalProperties": false,
"required": [
"reauthenticatedUntil"
],
"properties": {
"reauthenticatedUntil": {
"type": "string",
"format": "date-time"
}
}
}RegisterRequest
{
"type": "object",
"additionalProperties": false,
"required": [
"email",
"password",
"acceptedTerms",
"termsVersion",
"privacyVersion"
],
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Optional display name. When omitted, defaults to the normalized email local part, truncated to 100 characters. Can be changed in the profile later."
},
"email": {
"type": "string",
"format": "email",
"maxLength": 320
},
"password": {
"$ref": "#/components/schemas/Password"
},
"acceptedTerms": {
"type": "boolean",
"const": true
},
"termsVersion": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "Exact version rendered by the signup page; stale versions are rejected."
},
"privacyVersion": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"description": "Exact version rendered by the signup page; stale versions are rejected."
}
}
}RegisterResponse
{
"type": "object",
"additionalProperties": false,
"description": "Generic receipt returned for both a new account and a recoverable pending account. It intentionally omits identity data to limit account enumeration.",
"required": [
"emailVerificationRequired"
],
"properties": {
"emailVerificationRequired": {
"type": "boolean",
"const": true
}
}
}Session
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"current",
"mode",
"createdAt",
"lastSeenAt",
"expiresAt",
"device"
],
"properties": {
"id": {
"type": "string",
"pattern": "^ses_"
},
"current": {
"type": "boolean"
},
"mode": {
"type": "string",
"enum": [
"full",
"email_verification",
"legal_acceptance",
"deletion_recovery"
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"lastSeenAt": {
"type": "string",
"format": "date-time"
},
"expiresAt": {
"type": "string",
"format": "date-time"
},
"device": {
"type": "string"
},
"approximateLocation": {
"type": "string"
},
"reauthenticatedUntil": {
"type": [
"string",
"null"
],
"format": "date-time"
}
}
}Subscription
{
"type": "object",
"description": "Effective entitlement projection. `status=payg` and `id=null` means no billing subscription record exists.",
"additionalProperties": false,
"required": [
"status",
"plan",
"cancelAtPeriodEnd",
"usageRates"
],
"properties": {
"id": {
"type": [
"string",
"null"
],
"pattern": "^sub_"
},
"status": {
"type": "string",
"enum": [
"payg",
"trialing",
"active",
"past_due",
"grace",
"cancelled"
]
},
"plan": {
"$ref": "#/components/schemas/Plan"
},
"usageRates": {
"type": "object",
"description": "Account-specific configured credit rates. Query rates come from the account entitlement, not the public plan catalog. One TB is 1,000,000,000,000 bytes; download charges are settled against actual bytes and rounded per result.",
"additionalProperties": false,
"required": [
"customized",
"queries",
"downloadCreditsPerTb"
],
"properties": {
"customized": {
"type": "boolean",
"description": "True when an administrator configured rates for this account."
},
"queries": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"source",
"name",
"creditsPerRequest"
],
"properties": {
"source": {
"type": "string"
},
"name": {
"type": "string"
},
"creditsPerRequest": {
"type": "number",
"minimum": 0
}
}
}
},
"downloadCreditsPerTb": {
"type": "number",
"minimum": 0
}
}
},
"currentPeriodStart": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"currentPeriodEnd": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"cancelAtPeriodEnd": {
"type": "boolean"
},
"graceEndsAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
}
}SubscriptionCancellationChange
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"cancelAtPeriodEnd",
"status"
],
"properties": {
"id": {
"type": "string",
"pattern": "^sub_"
},
"cancelAtPeriodEnd": {
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"submitted"
]
}
}
}SubscriptionChange
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"fromPriceId",
"toPriceId",
"effective",
"status"
],
"properties": {
"id": {
"type": "string",
"pattern": "^sub_",
"description": "FlashData subscription public ID. Entitlement still updates only after a verified provider event."
},
"fromPriceId": {
"type": "string",
"pattern": "^prc_"
},
"toPriceId": {
"type": "string",
"pattern": "^prc_"
},
"effective": {
"type": "string",
"enum": [
"immediate"
]
},
"status": {
"type": "string",
"enum": [
"submitted"
]
}
}
}TokenRequest
{
"type": "object",
"additionalProperties": false,
"required": [
"token"
],
"properties": {
"token": {
"type": "string",
"minLength": 32,
"maxLength": 256,
"writeOnly": true
}
}
}TrialCreditState
{
"type": "object",
"additionalProperties": false,
"required": [
"eligible",
"ineligibilityReason",
"grantCredits",
"settingsVersion",
"request"
],
"properties": {
"eligible": {
"type": "boolean"
},
"ineligibilityReason": {
"type": [
"string",
"null"
],
"enum": [
"account_inactive",
"email_unverified",
"onboarding_incomplete",
"not_payg",
"payment_history",
"already_granted",
"already_requested",
null
]
},
"grantCredits": {
"type": "integer",
"minimum": 1
},
"settingsVersion": {
"type": "integer",
"minimum": 0
},
"request": {
"oneOf": [
{
"$ref": "#/components/schemas/TrialCreditRequest"
},
{
"type": "null"
}
]
}
}
}TrialCreditRequest
{
"type": "object",
"additionalProperties": false,
"required": [
"id",
"status",
"requestedCredits",
"policyVersion",
"useCase",
"requestedAt",
"reviewedAt",
"reviewReason",
"version"
],
"properties": {
"id": {
"type": "string",
"pattern": "^tcr_[A-Za-z0-9_-]{8,}$"
},
"status": {
"$ref": "#/components/schemas/TrialCreditRequestStatus"
},
"requestedCredits": {
"type": "integer",
"minimum": 1
},
"policyVersion": {
"type": "integer",
"minimum": 0
},
"useCase": {
"type": [
"string",
"null"
],
"enum": [
"google_search",
"youtube_data",
"download",
null
]
},
"requestedAt": {
"type": "string",
"format": "date-time"
},
"reviewedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"reviewReason": {
"type": [
"string",
"null"
]
},
"version": {
"type": "integer",
"minimum": 0
}
}
}TrialCreditRequestStatus
{
"type": "string",
"enum": [
"pending",
"approved",
"rejected"
]
}UpdateAccountRequest
{
"type": "object",
"additionalProperties": false,
"minProperties": 1,
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 80
}
}
}UpdateBulkJobRequest
{
"type": "object",
"additionalProperties": false,
"minProperties": 1,
"properties": {
"options": {
"type": "object",
"additionalProperties": true,
"description": "Partial option update. Nested storage fields are merged so unchanged credentials do not need to be resent. Data result_storage fields are merged the same way. After all IDs have been scanned, a paused data bulk job accepts credential updates only: access_key and secret_key, GCS service_account, or Azure sas_token, depending on the storage type. The complete merged configuration is validated before it is stored."
},
"callback_url": {
"type": [
"string",
"null"
],
"format": "uri",
"maxLength": 2048,
"description": "Replacement completion callback, or null to remove the callback."
}
}
}UpdateOnboardingRequest
{
"type": "object",
"additionalProperties": false,
"required": [
"version",
"action"
],
"properties": {
"version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"action": {
"type": "string",
"enum": [
"select_use_case",
"confirm_api_key_saved",
"skip_api_key",
"confirm_first_request",
"skip_first_request"
]
},
"useCase": {
"type": "string",
"enum": [
"google_search",
"youtube_data",
"download"
]
}
},
"allOf": [
{
"if": {
"properties": {
"action": {
"const": "select_use_case"
}
}
},
"then": {
"required": [
"useCase"
],
"properties": {
"useCase": {}
}
},
"else": {
"not": {
"required": [
"useCase"
],
"properties": {
"useCase": {}
}
}
}
}
],
"description": "Server-owned resource state validates confirmation actions; clients never submit API Key or request IDs."
}UsageCounts
{
"type": "object",
"additionalProperties": false,
"required": [
"requests",
"completed",
"failed",
"credits"
],
"properties": {
"requests": {
"type": "integer",
"minimum": 0
},
"completed": {
"type": "integer",
"minimum": 0
},
"failed": {
"type": "integer",
"minimum": 0
},
"credits": {
"type": "number",
"minimum": 0,
"description": "Charged Credits in the current aggregate; pending work may not be finally settled."
}
}
}