Explorar documentação
Referência da API
Referência API
Procure por contas, chaves, faturamento e trabalhos. Cada ponto final lista seus próprios requisitos de autenticação e acesso.
Leia sua conta com uma chave API
A Gerência API base URL É. https://api.flashdata.dev/v2. Esta leitura gratuita devolve a chave atual e conta IDs e a propriedade. Defina FLASHDATA_API_KEY antes de executar o 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 em sucesso. Verifique a linha de autenticação de cada endpoint: dataApiKey usa X-API-Key; cookieSession usa uma sessão de navegador assinada. Esquema de resposta de identidade
Baixe a especificação do cliente OpenAPI. Cobre consultas, trabalhos, contas, chaves API e faturamento.
Os parâmetros de consulta e o código de solicitação estão documentados no Google e.. YouTube Referências API.
Esquemas de autenticação
| Esquema | Requisição |
|---|---|
dataApiKey |
FlashData API chave. O acesso ao trabalho está restrito aos escopos de origem da chave. |
cookieSession |
Sessão opaca na Web. O navegador não pode ler este cookie. |
csrfToken |
apiKey |
agentRegistrationProof | Persista em uma base criptograficamente aleatória 32-byte64url prova e pedido exato antes de enviar; recupere-se apenas com a mesma prova e corpo. Não é um símbolo OAuth. |
agentSetupCredential | Credencial temporário para status e criação de vinculação apenas. Não é uma chave API. |
agentHandoffProof | Prova usada para recuperar a chave do proprietário e reconhecer a instalação. Nunca enviou para uma consulta de dados. |
agentIdentityKey | Chave comum FlashData API em Autorização, apenas na identidade do agente. Consultas de dados usam X-API-Key em vez disso. |
Sistema
GET/health
Saúde do serviço
Autenticação: Público
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respostas
200 Saudável
Resposta 200 · application/json
{
"$ref": "#/components/schemas/Health"
}GET/status
Leia o resumo do status do componente público
Autenticação: Público
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respostas
200 Resumo do status público
Cabeçalhos: Cache-Control
Resposta 200 · application/json
{
"$ref": "#/components/schemas/PublicStatus"
}Auth
GET/oauth/requests/{requestId}
Leia um pedido de autorização do aplicativo e ligue-o à sessão atual
Sessão completa necessária. O pedido expira em 10 minutos. A resposta é "sem loja".
Autenticação: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
requestId · path · requerido
Esquema
{
"type": "string",
"pattern": "^fdo_[A-Za-z0-9_-]{43}$"
}Respostas
200 Solicitamos permissão para o aplicativo
Resposta 200 · application/json
{
"$ref": "#/components/schemas/OAuthConsent"
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Autenticação, mas não permitida, ou validação CSRF falhou
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Pedido expirado, usado ou vinculado a outra sessão
Resposta 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/oauth/requests/{requestId}
Aprovar ou negar um pedido de autorização do aplicativo
Sessão completa, CSRF e origem permitida necessária. Consome o pedido uma vez. A resposta é "sem loja".
Autenticação: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
requestId · path · requerido
Esquema
{
"type": "string",
"pattern": "^fdo_[A-Za-z0-9_-]{43}$"
}Pedir corpo · requerido
Esquema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"decision"
],
"properties": {
"decision": {
"type": "string",
"enum": [
"approve",
"deny"
]
}
}
}Respostas
200 Chamada de cliente registrada com código ou negação, estado e emissor.
Resposta 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"redirectUrl"
],
"properties": {
"redirectUrl": {
"type": "string",
"format": "uri"
}
}
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Autenticação, mas não permitida, ou validação CSRF falhou
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Pedido de autorização não disponível; inicie uma nova conexão
Resposta 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 A validação do pedido falhou
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/register
Crie uma conta FlashData pendente
As versões de Termos e Privacidade enviadas devem corresponder ao pacote legal publicado atualmente.
Autenticação: Público
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Pedir corpo · requerido
Esquema · application/json
{
"$ref": "#/components/schemas/RegisterRequest"
}Respostas
201 Conta criada, verificação de e-mail necessária
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 201 · application/json
{
"$ref": "#/components/schemas/RegisterResponse"
}409 Estado de recursos ou conflito de indemnidade
Resposta 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 A validação do pedido falhou
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Taxa, concorrência, lote, ou limite de trabalho pendente excedido
Cabeçalhos: Retry-After
Resposta 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Um erro interno inesperado ocorreu
Resposta 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Uma dependência necessária ou catálogo está temporariamente indisponível
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/login
Criar uma sessão Web opaca
Define o Biscoito seguro, Http Only `__Host-fd_session`. Contas pendentes. Receba uma sessão restrita do email_verification para o painel de verificação. Contas verificadas elegíveis recebem seus créditos de teste de uma vez, se não forem concedidas. Uma conta ativa. recebe uma sessão completa a menos que sua identidade migrada ainda requer um A aceitação legal atual, nesse caso, recebe uma restrição Sessão legal_acceptance. Uma conta com um pedido de exclusão agendado. Recebe uma sessão restrita do deletion_recovery. Contas cuja eliminação é processing/failed/completed, e contas suspensas, receber 403.
Autenticação: Público
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Pedir corpo · requerido
Esquema · application/json
{
"$ref": "#/components/schemas/LoginRequest"
}Respostas
200 Autenticado
Cabeçalhos: Set-Cookie, Cache-Control, X-Request-Id
Resposta 200 · application/json
{
"$ref": "#/components/schemas/LoginResponse"
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Problem.code é email_not_verified, account_suspended, account_deletion_processing, account_deletion_failed, ou account_deleted
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 A validação do pedido falhou
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}423 Conta temporariamente bloqueada
Cabeçalhos: Retry-After
Resposta 423 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Taxa, concorrência, lote, ou limite de trabalho pendente excedido
Cabeçalhos: Retry-After
Resposta 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/logout
Revogar a sessão atual
Autenticação: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respostas
204 Sessão revogada e cookie limpo
Cabeçalhos: Set-Cookie, Cache-Control, X-Request-Id
401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Autenticação, mas não permitida, ou validação CSRF falhou
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/auth/me
Leia a conta atual e o usuário
Autenticação: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respostas
200 Conta corrente
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 200 · application/json
{
"$ref": "#/components/schemas/Account"
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/auth/csrf
Coloque o símbolo CSRF ligado à sessão atual.
Autenticação: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respostas
200 CSRF token
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"csrfToken"
],
"properties": {
"csrfToken": {
"type": "string",
"minLength": 32,
"readOnly": true
}
}
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/email-verifications
Peça ou envie uma mensagem de verificação por e-mail
Para cada e-mail sintáticamente válido, retorna a mesma resposta independentemente de a conta estar faltando, pendente, ativa, suspensa ou excluída. Contas pendentes elegíveis recebem um link girado uma vez após o reenviar o resfriamento.
Autenticação: Público
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Pedir corpo · requerido
Esquema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 320
}
}
}Respostas
202 Pedido aceito. A resposta não revela se uma conta existe.
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 202 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"accepted"
],
"properties": {
"accepted": {
"type": "boolean",
"const": true
}
}
}422 A validação da autenticação anônima falhou
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 O limite de autenticação anônimo excedeu
Cabeçalhos: Cache-Control, Retry-After, X-Request-Id
Resposta 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Um erro de autenticação anônimo inesperado ocorreu
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Uma dependência de autenticação anônima está temporariamente indisponível
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/email-verifications/confirm
Verifique um e-mail e ative a conta
Atômicamente consome o símbolo de uma vez e ativa a Conta e o Usuário. As regras de conta e de crédito existentes se aplicam. Sem uma sessão de inscrição, o usuário entra explicitamente. Um pedido de origem permitido carregando a sessão de inscrição correspondente e seu X-CSRF-Token pode receber um cookie de sessão girado para a mesma conta verificada; um token de verificação sozinho nunca assina em um usuário.
Autenticação: Público
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Pedir corpo · requerido
Esquema · application/json
{
"$ref": "#/components/schemas/TokenRequest"
}Respostas
200 Conta ativada
Cabeçalhos: Set-Cookie, Cache-Control, X-Request-Id
Resposta 200 · application/json
{
"allOf": [
{
"$ref": "#/components/schemas/Account"
},
{
"type": "object",
"properties": {
"status": {
"const": "active"
},
"emailVerified": {
"const": true
}
}
}
]
}410 Token de uma vez é inválido, expirado, invalidado, já usado, ou perdeu uma corrida de confirmação concorrente. Problem.code é `token_unavailable`.
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 A validação da autenticação anônima falhou
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 O limite de autenticação anônimo excedeu
Cabeçalhos: Cache-Control, Retry-After, X-Request-Id
Resposta 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Um erro de autenticação anônimo inesperado ocorreu
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Uma dependência de autenticação anônima está temporariamente indisponível
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/email-verifications/session
Continue a sessão de inscrição original após a verificação por e-mail
Requer uma origem permitida e o símbolo CSRF ligado a uma sessão de verificação de e-mail autenticada ao vivo. Retorna até que a conta da sessão seja verificada, incluindo verificação em outro navegador. Atomaticamente revoga a sessão de inscrição e emite uma nova sessão completa ou legal de aceitação. Não aceita uma conta ID, e-mail, senha ou ficha de verificação, ignorar a aceitação legal, ou conceder créditos.
Autenticação: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Pedir corpo · requerido
Esquema · application/json
{
"type": "object",
"additionalProperties": false
}Respostas
200 Sessão de Inscrição girada
Cabeçalhos: Set-Cookie, Cache-Control
Resposta 200 · application/json
{
"$ref": "#/components/schemas/LoginResponse"
}202 Verificação de e-mail está pendente, nenhuma nova sessão
Cabeçalhos: Cache-Control
Resposta 202 · application/json
{
"type": "object",
"required": [
"pending"
],
"additionalProperties": false,
"properties": {
"pending": {
"type": "boolean",
"const": true
}
}
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Autenticação, mas não permitida, ou validação CSRF falhou
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 A validação do pedido falhou
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Um erro interno inesperado ocorreu
Resposta 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/password-resets
Requisito uma senha para repor o e-mail
Sempre retorna a mesma resposta 202 para um e-mail sintáticamente válido, independentemente da existência da conta ou do estado de vida. Apenas as identidades ativas ou bloqueadas elegíveis recebem correspondência.
Autenticação: Público
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Pedir corpo · requerido
Esquema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 320
}
}
}Respostas
202 Pedido aceito. A resposta não revela se uma conta existe.
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 202 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"accepted"
],
"properties": {
"accepted": {
"type": "boolean",
"const": true
}
}
}422 A validação da autenticação anônima falhou
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 O limite de autenticação anônimo excedeu
Cabeçalhos: Cache-Control, Retry-After, X-Request-Id
Resposta 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Um erro de autenticação anônimo inesperado ocorreu
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Uma dependência de autenticação anônima está temporariamente indisponível
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/password-resets/confirm
Defina uma nova senha e revogue as sessões existentes
Atomaticamente consome o token de senha, armazena uma nova credencial Argon2id, revoga todas as sessões existentes, e invalida outras senhas. Ele não registra o usuário ou cria uma sessão.
Autenticação: Público
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Pedir corpo · requerido
Esquema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"token",
"password"
],
"properties": {
"token": {
"type": "string",
"minLength": 32,
"maxLength": 256,
"writeOnly": true
},
"password": {
"$ref": "#/components/schemas/Password"
}
}
}Respostas
204 Senha atualizada; sessões existentes revogadas
Cabeçalhos: Cache-Control, X-Request-Id
410 Token de uma vez é inválido, expirado, invalidado, já usado, ou perdeu uma corrida de confirmação concorrente. Problem.code é `token_unavailable`.
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 A validação da autenticação anônima falhou
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 O limite de autenticação anônimo excedeu
Cabeçalhos: Cache-Control, Retry-After, X-Request-Id
Resposta 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Um erro de autenticação anônimo inesperado ocorreu
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Uma dependência de autenticação anônima está temporariamente indisponível
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/auth/sessions
Listar sessões ativas para o usuário atual
Autenticação: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respostas
200 Sessões
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Session"
}
}
}
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/auth/sessions
Revogar todas as sessões, exceto a atual
Autenticação: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respostas
204 Outras sessões revogadas
Cabeçalhos: Cache-Control, X-Request-Id
401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Autenticação, mas não permitida, ou validação CSRF falhou
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/auth/sessions/{sessionId}
Revogar uma sessão
Autenticação: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
sessionId · path · requerido
Esquema
{
"type": "string",
"pattern": "^ses_"
}Respostas
204 Sessão revogada. Se fosse a sessão atual, o cookie estaria limpo.
Cabeçalhos: Set-Cookie, Cache-Control, X-Request-Id
401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Autenticação, mas não permitida, ou validação CSRF falhou
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 O recurso não foi encontrado ou não pertenceu ao chamador.
Resposta 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Estado de recursos ou conflito de indemnidade
Resposta 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 A validação do pedido falhou
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Uma dependência necessária ou catálogo está temporariamente indisponível
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/auth/re-authenticate
Verifique a senha atual para uma operação sensível
Grava uma prova recente de curta duração na sessão atual do servidor.
Autenticação: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Pedir corpo · requerido
Esquema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"password"
],
"properties": {
"password": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"writeOnly": true
}
}
}Respostas
200 Sessão tem autenticação recente
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 200 · application/json
{
"$ref": "#/components/schemas/Reauthentication"
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Autenticação, mas não permitida, ou validação CSRF falhou
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Taxa, concorrência, lote, ou limite de trabalho pendente excedido
Cabeçalhos: Retry-After
Resposta 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}PATCH/auth/password
Mude a senha e rode a sessão atual
Autenticação: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Pedir corpo · requerido
Esquema · 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
}
}
}Respostas
204 Senha alterada; sessão atual girada e outras sessões revogadas quando solicitadas
Cabeçalhos: Set-Cookie, Cache-Control, X-Request-Id
401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Autenticação, mas não permitida, ou validação CSRF falhou
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 A validação do pedido falhou
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Conta
GET/oauth/connections
Liste os aplicativos conectados da conta corrente
Sessão completa necessária. Vazio quando a conta não tem aplicativos conectados. A resposta é "sem loja".
Autenticação: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respostas
200 Connected apps
Resposta 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OAuthConnection"
}
}
}
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Autenticação, mas não permitida, ou validação CSRF falhou
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/oauth/connections/{grantId}
Revogar um aplicativo conectado e sua chave dedicada API
Sessão completa, CSRF e origem permitida necessária. A posse da conta é executada. A resposta é "sem loja".
Autenticação: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
grantId · path · requerido
Esquema
{
"type": "string",
"pattern": "^oag_[A-Za-z0-9_-]{8,}$"
}Respostas
204 Autorização revogada
401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Autenticação, mas não permitida, ou validação CSRF falhou
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 O recurso não foi encontrado ou não pertenceu ao chamador.
Resposta 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/account
Leia as configurações da conta
Autenticação: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respostas
200 Conta
Resposta 200 · application/json
{
"$ref": "#/components/schemas/Account"
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}PATCH/account
Atualizar configurações de perfil
Autenticação: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Pedir corpo · requerido
Esquema · application/json
{
"$ref": "#/components/schemas/UpdateAccountRequest"
}Respostas
200 Conta atualizada
Resposta 200 · application/json
{
"$ref": "#/components/schemas/Account"
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Autenticação, mas não permitida, ou validação CSRF falhou
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 A validação do pedido falhou
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/account
Agende a eliminação da conta e revogue todas as sessões existentes e API Keys
Contas de administrador devem ter seu papel de plataforma revogado através do fluxo de trabalho do operador auditado antes que a exclusão possa ser agendada. Um pedido exclusivo de eliminação ativa é o limite natural de indemnidade. Agendas autenticadas simultâneas retornam o mesmo pedido. Após a revogação da sessão, uma resposta perdida é recuperada por entrar no modo deletion_recovery e ler GET /account/deletion; sessões revogadas nunca são aceitas para replay.
Autenticação: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Pedir corpo · requerido
Esquema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"password",
"confirmation"
],
"properties": {
"password": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"writeOnly": true
},
"confirmation": {
"type": "string",
"const": "DELETE"
}
}
}Respostas
202 Eliminação programada. Sessão ativa e chaves revogadas
Resposta 202 · application/json
{
"$ref": "#/components/schemas/AccountDeletionRequest"
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Autenticação, mas não permitida, ou validação CSRF falhou
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Estado de recursos ou conflito de indemnidade
Resposta 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 A validação do pedido falhou
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/account/deletion
Leia o pedido de exclusão da conta atual
Autenticação: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respostas
200 Pedido de exclusão atual
Resposta 200 · application/json
{
"$ref": "#/components/schemas/AccountDeletionRequest"
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 O recurso não foi encontrado ou não pertenceu ao chamador.
Resposta 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/account/deletion
Cancele uma eliminação programada durante o período de carência
Usa uma comparação programada. Uma corrida de processador retorna 409; após o sucesso, a sessão de recuperação é rotacionada e não pode repetir a antiga transição.
Autenticação: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respostas
204 A exclusão foi cancelada, a conta reativada e a sessão de recuperação girada de acordo com o portão de aceitação legal.
Cabeçalhos: Set-Cookie, Cache-Control, X-Request-Id
401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Autenticação, mas não permitida, ou validação CSRF falhou
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 O recurso não foi encontrado ou não pertenceu ao chamador.
Resposta 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Estado de recursos ou conflito de indemnidade
Resposta 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/account/legal-acceptances
Accept, as versões de Privacidade e Termos atualmente publicadas
Adiciona uma aceitação legal imutável, limpa o portão de migração, e gira a sessão. Versões desatualizadas são rejeitadas.
Autenticação: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Pedir corpo · requerido
Esquema · application/json
{
"$ref": "#/components/schemas/LegalAcceptanceRequest"
}Respostas
200 Aceitação legal gravada e sessão girada para o modo completo
Cabeçalhos: Set-Cookie, Cache-Control, X-Request-Id
Resposta 200 · application/json
{
"$ref": "#/components/schemas/LoginResponse"
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Autenticação, mas não permitida, ou validação CSRF falhou
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 O recurso não foi encontrado ou não pertenceu ao chamador.
Resposta 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 A validação do pedido falhou
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}A bordo
GET/onboarding
Leia o progresso resumido
Autenticação: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respostas
200 Abordagem atual do estado
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 200 · application/json
{
"$ref": "#/components/schemas/OnboardingProgress"
}401 Autenticação necessária ou inválida
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Um erro interno inesperado ocorreu
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Uma dependência necessária ou registro de bordo está temporariamente indisponível.
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}PATCH/onboarding
Avance a bordo sem permitir que o progresso se mova para trás
Autenticação: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Pedir corpo · requerido
Esquema · application/json
{
"$ref": "#/components/schemas/UpdateOnboardingRequest"
}Respostas
200 Atualizado no estado de embarque
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 200 · application/json
{
"$ref": "#/components/schemas/OnboardingProgress"
}401 Autenticação necessária ou inválida
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Autenticação, mas não permitida, ou validação CSRF falhou
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Estado de recursos ou conflito de indemnidade
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 A validação do pedido falhou
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Um erro interno inesperado ocorreu
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Uma dependência necessária ou registro de bordo está temporariamente indisponível.
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Visão geral
GET/overview
Leia o painel de contas agregado
Autenticação: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respostas
200 Visão geral da conta
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 200 · application/json
{
"$ref": "#/components/schemas/ConsoleOverview"
}401 Autenticação necessária ou inválida
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Um erro interno inesperado ocorreu
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Uma dependência necessária ou registro de bordo está temporariamente indisponível.
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}API Keys
GET/api-access/identity
Verifique a atual propriedade da chave API e prontidão recorrente
Leia a chave API somente para cabeçalho. Retorna account/key IDs público e propriedade autoritária. Sem pedido de corpo. Não altera a resposta de metadados /api-access existente. Compartilha o limite de leitura da conta 120/minute. Falha fechada por indisponibilidade, não deduza a propriedade do prefixo, plano ou estado local. Nenhum parâmetro de consulta é aceito. Respostas não são de loja.
Autenticação: dataApiKey
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respostas
200 Verifique a atual propriedade da chave API e prontidão recorrente
Resposta 200 · application/json
{
"$ref": "#/components/schemas/APIKeyIdentity"
}400 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-keys
Lista API metadados chave
Autenticação: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respostas
200 API Keys sem segredos
Resposta 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiKey"
}
}
}
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/api-keys
Crie uma chave API e revele seu segredo uma vez.
Autenticação: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
Idempotency-Key · header · requerido
Esquema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Pedir corpo · requerido
Esquema · application/json
{
"$ref": "#/components/schemas/CreateApiKeyRequest"
}Respostas
201 Criado; o mesmo replay idempotente pode retornar a mesma resposta criptografada por cinco minutos.
Resposta 201 · application/json
{
"$ref": "#/components/schemas/ApiKeyCreated"
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Autenticação, mas não permitida, ou validação CSRF falhou
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Estado de recursos ou conflito de indemnidade
Resposta 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 A validação do pedido falhou
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Uma dependência necessária ou catálogo está temporariamente indisponível
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/api-keys/{keyId}
Revogar uma chave API
Autenticação: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
keyId · path · requerido
Esquema
{
"type": "string",
"pattern": "^key_"
}Respostas
204 Revogado
401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Autenticação, mas não permitida, ou validação CSRF falhou
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 O recurso não foi encontrado ou não pertenceu ao chamador.
Resposta 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Uma dependência necessária ou catálogo está temporariamente indisponível
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/api-keys/{keyId}/rotate
Criar uma chave de substituição e agendar a revogação da velha chave
Cria uma nova chave e mantém a velha chave ativa até revokeOldAt. Por padrão, a sobreposição dura 24 horas ou até que a velha chave expire, o que for mais cedo. Um revokeOldAt personalizado deve estar no futuro, dentro de sete dias, e o mais tardar até a velha chave expirar.
Autenticação: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
keyId · path · requerido
Esquema
{
"type": "string",
"pattern": "^key_"
}Idempotency-Key · header · requerido
Esquema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Pedir corpo · Opcional
Esquema · 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."
}
}
}Respostas
201 Substituição criada, o segredo retornado uma vez
Resposta 201 · application/json
{
"$ref": "#/components/schemas/ApiKeyCreated"
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Autenticação, mas não permitida, ou validação CSRF falhou
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 O recurso não foi encontrado ou não pertenceu ao chamador.
Resposta 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Estado de recursos ou conflito de indemnidade
Resposta 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 A validação do pedido falhou
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Uma dependência necessária ou catálogo está temporariamente indisponível
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-access
Leia as fontes autorizadas da chave API e a origem dos resultados.
Autenticação X-API-Key só para cabeçalhos. Retornos só concedidos ao público Nomes de origem e a origem de armazenamento de resultados assinados configurados (null se Não está disponível). Nenhuma conta ID, chave ID, credenciais secretas ou de armazenamento são devolvidas. MCP local revida este ponto antes de cada descoberta de ferramentas e chamada, Incluindo resultados guardados. Nenhum parâmetro de consulta ou pedido de corpo são aceitos. Todas as rotas /api-access compartilham pedidos 120 por minuto por IP cliente e retorno. Cache-Controle privado, sem loja. O último rastreamento usado ainda ocorre.
Autenticação: dataApiKey
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respostas
200 Fontes públicas autorizadas e origem dos resultados
Resposta 200 · application/json
{
"$ref": "#/components/schemas/ApiAccess"
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 A validação do pedido falhou
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Muitas contas lêem, tente de novo depois da janela de limite de taxa.
503 Uma dependência necessária ou catálogo está temporariamente indisponível
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Agente Conexões
GET/agent-connections/capabilities
Descubra o protocolo 2 que está disponível
Nenhum parâmetro de consulta é aceito. Respostas não são de loja. Rotas de agentes são somente gerenciais e de recursos, implantações podem retornar 404 quando desabilitadas. X-API-Key é proibido em rotas de agentes.
Autenticação: Público
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respostas
200 Descubra o protocolo 2 que está disponível
Resposta 200 · application/json
{
"$ref": "#/components/schemas/AgentCapabilities"
}400 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/registrations
Crie ou recupere um temporário. API- Conexão chave
Persista na prova de registro e entrada exata antes de POST. A mesma prova e corpo recuperam o mesmo teste, mudar de entrada produz conflito. Teste temporário: crédito 1, horas 72, 1 request/second, tamanho do lote 1. Limites de escopo de fonte continuam autorizados no servidor. Nenhum parâmetro de consulta é aceito. Respostas não são de loja. Rotas de agentes são somente gerenciais e de recursos, implantações podem retornar 404 quando desabilitadas. X-API-Key é proibido em rotas de agentes.
Autenticação: agentRegistrationProof
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Pedir corpo · requerido
Esquema · application/json
{
"$ref": "#/components/schemas/AgentRegistrationRequest"
}Respostas
201 Crie ou recupere um temporário. API- Conexão chave
Resposta 201 · application/json
{
"$ref": "#/components/schemas/AgentRegistration"
}400 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/owned
Listar conexões próprias do navegador
Nenhum parâmetro de consulta é aceito. Respostas não são de loja. Rotas de agentes são somente gerenciais e de recursos, implantações podem retornar 404 quando desabilitadas. X-API-Key é proibido em rotas de agentes. Operação de navegador. Sessão completa verificada necessária, o chamador não deve substituir uma chave API ou prova.
Autenticação: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respostas
200 Listar conexões próprias do navegador
Resposta 200 · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"connections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentConnection"
}
}
},
"required": [
"connections"
]
}400 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/{connectionId}
Leia o status da conexão temporária
Nenhum parâmetro de consulta é aceito. Respostas não são de loja. Rotas de agentes são somente gerenciais e de recursos, implantações podem retornar 404 quando desabilitadas. X-API-Key é proibido em rotas de agentes.
Autenticação: agentSetupCredential
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
connectionId · path · requerido
Esquema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Respostas
200 Leia o status da conexão temporária
Resposta 200 · application/json
{
"$ref": "#/components/schemas/AgentConnectionResponse"
}400 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/agent-connections/{connectionId}
Revogar uma conexão própria
Nenhum parâmetro de consulta é aceito. Respostas não são de loja. Rotas de agentes são somente gerenciais e de recursos, implantações podem retornar 404 quando desabilitadas. X-API-Key é proibido em rotas de agentes. Operação de navegador. Sessão completa verificada necessária, o chamador não deve substituir uma chave API ou prova.
Autenticação: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
connectionId · path · requerido
Esquema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Origin · header · requerido
Esquema
{
"type": "string"
}X-CSRF-Token · header · requerido
Esquema
{
"type": "string"
}Respostas
204 Revogar uma conexão própria
400 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/{connectionId}/identity
Verifique os dados atuais API chave para uma conexão
Nenhum parâmetro de consulta é aceito. Respostas não são de loja. Rotas de agentes são somente gerenciais e de recursos, implantações podem retornar 404 quando desabilitadas. X-API-Key é proibido em rotas de agentes.
Autenticação: agentIdentityKey
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
connectionId · path · requerido
Esquema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Respostas
200 Verifique os dados atuais API chave para uma conexão
Resposta 200 · application/json
{
"$ref": "#/components/schemas/AgentConnectionResponse"
}400 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/{connectionId}/onboarding
Leia o estado recuperável a bordo
Nenhum parâmetro de consulta é aceito. Respostas não são de loja. Rotas de agentes são somente gerenciais e de recursos, implantações podem retornar 404 quando desabilitadas. X-API-Key é proibido em rotas de agentes.
Autenticação: agentHandoffProof
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
connectionId · path · requerido
Esquema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Respostas
200 Leia o estado recuperável a bordo
Resposta 200 · application/json
{
"$ref": "#/components/schemas/AgentOnboardingStatus"
}400 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/{connectionId}/claims
Criar uma vinculação de aprovação do navegador
Abra claimPath em uma origem confiável FlashData e mostre o código separadamente. Nunca coloque credenciais ou o código de confirmação no URL. Nenhum parâmetro de consulta é aceito. Respostas não são de loja. Rotas de agentes são somente gerenciais e de recursos, implantações podem retornar 404 quando desabilitadas. X-API-Key é proibido em rotas de agentes.
Autenticação: agentSetupCredential
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
connectionId · path · requerido
Esquema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Pedir corpo · requerido
Esquema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {},
"required": []
}Respostas
201 Criar uma vinculação de aprovação do navegador
Resposta 201 · application/json
{
"$ref": "#/components/schemas/AgentClaim"
}400 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/claims/{claimId}/confirm
Confirme o código de vinculação em uma sessão de navegador verificada.
Nenhum parâmetro de consulta é aceito. Respostas não são de loja. Rotas de agentes são somente gerenciais e de recursos, implantações podem retornar 404 quando desabilitadas. X-API-Key é proibido em rotas de agentes. Operação de navegador. Sessão completa verificada necessária, o chamador não deve substituir uma chave API ou prova.
Autenticação: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
claimId · path · requerido
Esquema
{
"type": "string",
"pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}Origin · header · requerido
Esquema
{
"type": "string"
}X-CSRF-Token · header · requerido
Esquema
{
"type": "string"
}Pedir corpo · requerido
Esquema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"pattern": "^\\d{8}$"
}
},
"required": [
"code"
]
}Respostas
200 Confirme o código de vinculação em uma sessão de navegador verificada.
Resposta 200 · application/json
{
"$ref": "#/components/schemas/AgentBrowserClaim"
}400 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/agent-connections/claims/{claimId}
Leia uma vinculação confirmada na sessão do navegador
Nenhum parâmetro de consulta é aceito. Respostas não são de loja. Rotas de agentes são somente gerenciais e de recursos, implantações podem retornar 404 quando desabilitadas. X-API-Key é proibido em rotas de agentes. Operação de navegador. Sessão completa verificada necessária, o chamador não deve substituir uma chave API ou prova.
Autenticação: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
claimId · path · requerido
Esquema
{
"type": "string",
"pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}Respostas
200 Leia uma vinculação confirmada na sessão do navegador
Resposta 200 · application/json
{
"$ref": "#/components/schemas/AgentClaimView"
}400 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/claims/{claimId}/approve
Aprovar escopos reduzidos e financiamento do balanço da conta
Nenhum parâmetro de consulta é aceito. Respostas não são de loja. Rotas de agentes são somente gerenciais e de recursos, implantações podem retornar 404 quando desabilitadas. X-API-Key é proibido em rotas de agentes. Operação de navegador. Sessão completa verificada necessária, o chamador não deve substituir uma chave API ou prova.
Autenticação: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
claimId · path · requerido
Esquema
{
"type": "string",
"pattern": "^acl_[A-Za-z0-9_-]{8,100}$"
}Origin · header · requerido
Esquema
{
"type": "string"
}X-CSRF-Token · header · requerido
Esquema
{
"type": "string"
}Pedir corpo · requerido
Esquema · application/json
{
"$ref": "#/components/schemas/AgentApproval"
}Respostas
200 Aprovar escopos reduzidos e financiamento do balanço da conta
Resposta 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 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/{connectionId}/handoff
Recupere a chave API do proprietário aprovado
A chave do candidato expira em 24 horas até a instalação ACK. Persista atomicamente, recarregue em um novo processo e verifique a identidade antes do ACK. Uma entrega repetida recupera o mesmo candidato, a entrega confirmada devolve um recibo sem credenciais. Nenhum parâmetro de consulta é aceito. Respostas não são de loja. Rotas de agentes são somente gerenciais e de recursos, implantações podem retornar 404 quando desabilitadas. X-API-Key é proibido em rotas de agentes.
Autenticação: agentHandoffProof
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
connectionId · path · requerido
Esquema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Pedir corpo · requerido
Esquema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {},
"required": []
}Respostas
200 Recupere a chave API do proprietário aprovado
Resposta 200 · application/json
{
"$ref": "#/components/schemas/AgentHandoff"
}400 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/agent-connections/{connectionId}/handoff/ack
Confirmar instalação do proprietário-chave verificada
O ouvinte já deve ter salvado o candidato e verificado de forma independente em um novo processo. Marcas de ACK instaladas, removem a validade da chave do candidato e deletam material de credencial recuperável. O ACK repetido é indemponente. Nenhum parâmetro de consulta é aceito. Respostas não são de loja. Rotas de agentes são somente gerenciais e de recursos, implantações podem retornar 404 quando desabilitadas. X-API-Key é proibido em rotas de agentes.
Autenticação: agentHandoffProof
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
connectionId · path · requerido
Esquema
{
"type": "string",
"pattern": "^acn_[A-Za-z0-9_-]{8,100}$"
}Pedir corpo · requerido
Esquema · application/json
{
"type": "object",
"additionalProperties": false,
"properties": {
"apiKey": {
"type": "string"
}
},
"required": [
"apiKey"
]
}Respostas
200 Confirmar instalação do proprietário-chave verificada
Resposta 200 · application/json
{
"$ref": "#/components/schemas/AgentHandoff"
}400 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 400 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}401 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 429 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Pedido rejeitado, inspecione o código do problema. Nunca tente novamente uma mutação cegamente.
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Catálogo
GET/catalog/sources
Liste as capacidades de fonte pública sem preços específicos da conta
Autenticação: Público
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respostas
200 Catálogo de fontes públicas
Cabeçalhos: Cache-Control
Resposta 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataSource"
}
}
}
}GET/plans
Listar planos públicos USD e preços
Autenticação: Público
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respostas
200 Catálogo de planos públicos
Cabeçalhos: Cache-Control
Resposta 200 · application/json
{
"$ref": "#/components/schemas/PlanCatalog"
}GET/legal/current
Leia os termos e versões de privacidade necessários para a inscrição.
Autenticação: Público
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respostas
200 Catálogo legal atual
Cabeçalhos: Cache-Control
Resposta 200 · application/json
{
"$ref": "#/components/schemas/PublicLegalVersions"
}Billing
GET/billing/subscription
Leia a assinatura efetiva da Stripe
Autenticação: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respostas
200 Assinatura ou direito PAYG
Resposta 200 · application/json
{
"$ref": "#/components/schemas/Subscription"
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/checkout-sessions
Crie uma sessão de checkout hospedada em Stripe
Assinaturas e pacotes de crédito publicados usam priceId. Um top up personalizado usa amountMinor em vez disso (USD centavos, $10 para $999,999.99); o servidor calcula créditos com o valor fixo de crédito e cria um preço privado de uma vez Stripe. Produto, preço do fornecedor, moeda, sucesso URL e cancelar URL nunca são aceitos do navegador. Os créditos só são concedidos depois de um evento pago pelo valor cotado.
Autenticação: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
Idempotency-Key · header · requerido
Esquema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Pedir corpo · requerido
Esquema · 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"
}
}
}
]
}Respostas
201 Stripe Checkout Session
Resposta 201 · application/json
{
"$ref": "#/components/schemas/HostedSession"
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Autenticação, mas não permitida, ou validação CSRF falhou
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Estado de recursos ou conflito de indemnidade
Resposta 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 A validação do pedido falhou
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Um provedor de upstream falhou
Resposta 502 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 O catálogo de faturamento ou provedor não está configurado ou está temporariamente indisponível.
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/subscription-changes
Atualize a assinatura da Stripe para um preço mais alto publicado.
O servidor verifica que o preço FlashData está ativo, disponível no modo de vida atual, denominado USD, recorrente, o mesmo intervalo, e estritamente mais caro do que o preço de assinatura atual. Produto, preço do fornecedor, moeda e opções de proração nunca são aceitos do navegador. O direito e os créditos locais só mudam depois que um evento de provedor verificado é projetado.
Autenticação: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
Idempotency-Key · header · requerido
Esquema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Pedir corpo · requerido
Esquema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"priceId"
],
"properties": {
"priceId": {
"type": "string",
"pattern": "^prc_"
}
}
}Respostas
201 Mudança de assinatura submetida à Stripe
Resposta 201 · application/json
{
"$ref": "#/components/schemas/SubscriptionChange"
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Autenticação, mas não permitida, ou validação CSRF falhou
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 O recurso não foi encontrado ou não pertenceu ao chamador.
Resposta 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Estado de recursos ou conflito de indemnidade
Resposta 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 A validação do pedido falhou
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Um provedor de upstream falhou
Resposta 502 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 O catálogo de faturamento ou provedor não está configurado ou está temporariamente indisponível.
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/portal-sessions
Criar uma sessão do Portal do Cliente Stripe
Autenticação: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
Idempotency-Key · header · requerido
Esquema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Respostas
201 Stripe Customer Portal Sessão
Resposta 201 · application/json
{
"$ref": "#/components/schemas/HostedSession"
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Autenticação, mas não permitida, ou validação CSRF falhou
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 O recurso não foi encontrado ou não pertenceu ao chamador.
Resposta 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Estado de recursos ou conflito de indemnidade
Resposta 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Um provedor de upstream falhou
Resposta 502 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 O catálogo de faturamento ou provedor não está configurado ou está temporariamente indisponível.
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/billing/subscription-cancellation
Agendar ou anular cancelamento da assinatura paga atual
Configurando cancelAtPeriodEnd para true cancelamento de horários no período atual de faturamento final; false mantém a assinatura. Atualização de direitos depois de um evento de assinatura da Stripe. Este ponto final nunca cancela imediatamente ou emite um reembolso.
Autenticação: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
Idempotency-Key · header · requerido
Esquema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Pedir corpo · requerido
Esquema · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"cancelAtPeriodEnd"
],
"properties": {
"cancelAtPeriodEnd": {
"type": "boolean"
}
}
}Respostas
202 Atualização de cancelamento submetida à Stripe
Resposta 202 · application/json
SubscriptionCancellationChange
{
"$ref": "#/components/schemas/SubscriptionCancellationChange"
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Autenticação, mas não permitida, ou validação CSRF falhou
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 O recurso não foi encontrado ou não pertenceu ao chamador.
Resposta 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Estado de recursos ou conflito de indemnidade
Resposta 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 A validação do pedido falhou
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}502 Um provedor de upstream falhou
Resposta 502 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 O catálogo de faturamento ou provedor não está configurado ou está temporariamente indisponível.
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/billing/invoices
Projeções de faturas da lista
Autenticação: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
cursor · query · Opcional
Esquema
{
"type": "string",
"maxLength": 512
}limit · query · Opcional
Esquema
{
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}Respostas
200 Faturas
401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/billing/payments
Lista conta-objeção de cobertura e reembolso de projeções de pagamento
Autenticação: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
cursor · query · Opcional
Esquema
{
"type": "string",
"maxLength": 512
}limit · query · Opcional
Esquema
{
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}Respostas
200 Histórico de pagamento único sem segredos de provedores
Resposta 200 · application/json
{
"$ref": "#/components/schemas/BillingPaymentPage"
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Créditos
GET/api-access/balance
Leia o saldo da conta ao vivo usando uma chave API.
Leia o saldo de crédito atual compartilhado por todas as chaves API em sua conta. Reservas ativas podem reduzir o equilíbrio disponível. Este pedido não custa créditos e não leva parâmetros de consulta ou corpo. Respostas são privadas e não são armazenadas, limites de taxa de conta-leitura se aplicam.
Autenticação: dataApiKey
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respostas
200 Saldo assinado e créditos não negativos disponíveis
Resposta 200 · application/json
{
"$ref": "#/components/schemas/ApiAccessBalance"
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 A validação do pedido falhou
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Muitas contas lêem, tente de novo depois da janela de limite de taxa.
503 Uma dependência necessária ou catálogo está temporariamente indisponível
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-access/pricing
Leia os preços reais da conta para fontes autorizadas pela chave API.
Leia as taxas de fonte permitidas pela chave API. A null O preço significa que a fonte não está disponível. request_count Conta com consultas, não itens devolvidos; taxas de download são por TB (10^12 bytes). Estimativas não reservam créditos ou capacidade. Este pedido não custa créditos. Respostas são privadas e não são armazenadas, limites de taxa de conta-leitura se aplicam.
Autenticação: dataApiKey
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
source · query · Opcional
Uma fonte concedida a esta chave, omitir ler todas as fontes concedidas.
Esquema
{
"$ref": "#/components/schemas/ApiAccessSource"
}request_count · query · Opcional
Número inteiro de chamadas decimais; não estima o tamanho do download.
Esquema
{
"type": "integer",
"minimum": 1,
"maximum": 100000,
"default": 1
}Respostas
200 Plano de contas e preços específicos da fonte
Resposta 200 · application/json
{
"$ref": "#/components/schemas/ApiAccessPricing"
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Autenticação, mas não permitida, ou validação CSRF falhou
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 A validação do pedido falhou
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Muitas contas lêem, tente de novo depois da janela de limite de taxa.
503 Uma dependência necessária ou catálogo está temporariamente indisponível
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/api-access/limits
Leia os limites do plano de conta e trabalhos pendentes atuais usando uma chave API
Leia sua concordância, tamanho de lote e limites de trabalho pendentes, mais a contagem atual pendente. Esses valores ajudam a planejar pedidos, mas não reservam capacidade. Este pedido não custa créditos e não leva parâmetros de consulta ou corpo. Respostas são privadas e não são armazenadas, limites de taxa de conta-leitura se aplicam.
Autenticação: dataApiKey
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respostas
200 Planejar tetos e contagem pendente
Resposta 200 · application/json
{
"$ref": "#/components/schemas/ApiAccessLimits"
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 A validação do pedido falhou
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Muitas contas lêem, tente de novo depois da janela de limite de taxa.
503 Uma dependência necessária ou catálogo está temporariamente indisponível
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/usage
Leia o uso da conta para fontes autorizadas pela chave API.
Leitura gratuita, autenticada apenas por X-API-Key. Inclui todas as chaves da conta, mas... Apenas fontes concedidas para a chave de chamada. Não retorna o texto da consulta, as chaves, detalhes de pagamento ou outras contas. O padrão é de sete dias, no máximo 31. Datas devem usar o temporizador UTC Z. De é inclusivo e exclusivo; Ambos são arredondados para minutos. Com de sozinho, para os padrões de + 7 dias. Com nenhum dos dois, é o começo do próximo minuto. Agregados são eventualmente Consistente, até mesmo atualização=false não garante que todos os eventos recentes sejam ingeridos. Limite de leitura: pedidos de 60 por minuto por IP cliente.
Autenticação: dataApiKey
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
source · query · Opcional
Uma fonte de catálogo exata concedida à chave de chamada, omitida significa todas as fontes concedidas.
Esquema
{
"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
Esquema
{
"type": "string",
"format": "date-time"
}to · query · Opcional
Esquema
{
"type": "string",
"format": "date-time"
}Respostas
200 Requisito com escopo conta e créditos cobrados, com informações de frescura
Resposta 200 · application/json
{
"$ref": "#/components/schemas/ApiKeyUsage"
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Autenticação, mas não permitida, ou validação CSRF falhou
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 A validação do pedido falhou
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}429 Muitas leituras de uso, tente novamente após a janela de limite de taxa.
503 Uma dependência necessária ou catálogo está temporariamente indisponível
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/credits/balance
Leia os créditos disponíveis e reservados
Autenticação: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respostas
200 Balanço de crédito
Resposta 200 · application/json
{
"$ref": "#/components/schemas/CreditBalance"
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/credits/policy
Leia a política de crédito e cobrança efetiva da conta.
Autenticação: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respostas
200 Política de crédito eficaz
Resposta 200 · application/json
{
"$ref": "#/components/schemas/CreditPolicy"
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/credits/transactions
Listar registros de créditos
Autenticação: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
cursor · query · Opcional
Esquema
{
"type": "string",
"maxLength": 512
}limit · query · Opcional
Esquema
{
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
}type · query · Opcional
Esquema
{
"$ref": "#/components/schemas/CreditEntryType"
}Respostas
200 Registros de livros
Resposta 200 · application/json
{
"allOf": [
{
"$ref": "#/components/schemas/Page"
},
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreditTransaction"
}
}
}
}
]
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Créditos de teste
GET/trial-credit-request
Leia a elegibilidade do crédito de teste e o pedido de vida da conta.
Autenticação: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respostas
200 Elegibilidade atual, concessão configurada, e estado de solicitação
Cabeçalhos: Cache-Control
Resposta 200 · application/json
{
"$ref": "#/components/schemas/TrialCreditState"
}401 Autenticação necessária ou inválida
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Um erro interno inesperado ocorreu
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Uma dependência necessária ou registro de bordo está temporariamente indisponível.
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/trial-credit-request
Envie o pedido de crédito de uma vida na conta
O valor do teste e o caso de uso são salvos quando você apresenta o pedido.
Autenticação: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
Idempotency-Key · header · requerido
Esquema
{
"type": "string",
"minLength": 1,
"maxLength": 255
}Pedir corpo · Opcional
Esquema · application/json
{
"type": "object",
"additionalProperties": false
}Respostas
201 Pedido de crédito de teste criado e automaticamente aprovado para contas verificadas elegíveis, independentemente do provedor de e-mail
Cabeçalhos: Cache-Control
Resposta 201 · application/json
{
"$ref": "#/components/schemas/TrialCreditState"
}401 Autenticação necessária ou inválida
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}403 Autenticação, mas não permitida, ou validação CSRF falhou
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 403 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Estado de recursos ou conflito de indemnidade
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 A validação do pedido falhou
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}500 Um erro interno inesperado ocorreu
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 500 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Uma dependência necessária ou registro de bordo está temporariamente indisponível.
Cabeçalhos: Cache-Control, X-Request-Id
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Entrega
GET/delivery/webhooks
Lista salva chamada de conclusão URLs
Autenticação: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Respostas
200 Chamada URLs
Resposta 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"data"
],
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeliveryWebhook"
}
}
}
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/delivery/webhooks
Salve uma chamada completa URL
Autenticação: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Pedir corpo · requerido
Esquema · application/json
{
"$ref": "#/components/schemas/CreateDeliveryWebhookRequest"
}Respostas
201 Criada
Resposta 201 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"webhook"
],
"properties": {
"webhook": {
"$ref": "#/components/schemas/DeliveryWebhook"
}
}
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 A validação do pedido falhou
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}DELETE/delivery/webhooks/{webhookId}
Remova uma chamada completa URL
Autenticação: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
webhookId · path · requerido
Esquema
{
"type": "string",
"pattern": "^cbk_[A-Za-z0-9_-]{8,}$"
}Respostas
204 Removido
401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 O recurso não foi encontrado ou não pertenceu ao chamador.
Resposta 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}POST/delivery/webhooks/{webhookId}/test
Envie uma amostra de carga completa
Autenticação: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
webhookId · path · requerido
Esquema
{
"type": "string",
"pattern": "^cbk_[A-Za-z0-9_-]{8,}$"
}Respostas
200 Tentativa de teste
Resposta 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"statusCode",
"webhook"
],
"properties": {
"statusCode": {
"type": "integer",
"minimum": 0
},
"webhook": {
"$ref": "#/components/schemas/DeliveryWebhook"
}
}
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 O recurso não foi encontrado ou não pertenceu ao chamador.
Resposta 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}trabalhos
Para apresentação, status e exemplos de resultados, veja Realtime e async · Pedidos Batch.
GET/jobs
Listar trabalhos API para o espaço de trabalho atual
História ativa e arquivada de cursor. O padrão dos últimos sete dias, cada intervalo de data UTC é limitado a dias 31. De é inclusivo e para é exclusivo, em precisão minuto. Os resumos são mantidos assíncronos e podem atrasar a ingestão.
Autenticação: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
cursor · query · Opcional
Esquema
{
"type": "string",
"minLength": 1,
"maxLength": 512
}limit · query · Opcional
Esquema
{
"type": "integer",
"minimum": 1,
"maximum": 50
}source · query · Opcional
Esquema
{
"type": "string",
"pattern": "^(google|youtube|google_[a-z]+|youtube_[a-z_]+)$"
}status · query · Opcional
Esquema
{
"type": "string",
"enum": [
"completed",
"failed",
"pending",
"processing"
]
}mode · query · Opcional
Esquema
{
"type": "string",
"enum": [
"async",
"batch",
"realtime"
]
}from · query · Opcional
Esquema
{
"type": "string",
"format": "date-time"
}to · query · Opcional
Esquema
{
"type": "string",
"format": "date-time"
}Respostas
200 Página de trabalho
Resposta 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 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 A validação do pedido falhou
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/jobs/{jobId}
Leia um trabalho do Data API
Leia job.status para verificar o progresso e job.error se o processamento falhou. JSON é o padrão; use Accept: text/plain para texto legível. X-Respond-With é ignorado aqui. Siga Retry-After quando for fornecido antes de verificar novamente.
Autenticação: cookieSession ou dataApiKey
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
Accept · header · Opcional
application/json retorna a resposta estruturada original, text/plain retorna os mesmos campos do texto simples indentado. Faixas de mídia padrão e pesos q são suportados, Accept faltando ou um padrão de caracteres especiais global para JSON. X-Respond-With é ignorado na submissão e status de trabalho. Erros permanecem estruturados JSON. Ambos os tipos de resposta usam UTF-8; um parâmetro explícito charset=utf-8 é suportado.
Esquema
{
"type": "string"
}jobId · path · requerido
Esquema
{
"type": "string",
"pattern": "^job_[A-Za-z0-9_-]+$"
}Respostas
200 Trabalho, detalhe
Resposta 200 · application/json
{
"type": "object",
"additionalProperties": false,
"required": [
"job"
],
"properties": {
"job": {
"$ref": "#/components/schemas/ConsoleJob"
}
}
}Resposta 200 · text/plain
{
"type": "string"
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 O recurso não foi encontrado ou não pertenceu ao chamador.
Resposta 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}406 Nem application/json nem text/plain é aceitável; a resposta é JSON
Resposta 406 · application/json
{
"$ref": "#/components/schemas/QueryRepresentationError"
}GET/jobs/{jobId}/results
Faça o download de um resultado finalizado
Por padrão, autentica o acesso e redireciona para um R2 privado de curta duração URL; clientes recebem o JSON original diretamente do R2. Accept: text/plain independentemente retorna HTTP 200 com os campos de resultados originais como texto simples indentado. X-Respond-With: markdown seleciona o conteúdo Markdown: application/json envolve o conteúdo ao lado dos metadados originais, substituindo os resultados; text/plain retorna metadados seguidos pelo Markdown. Falta Accept ou um padrão mundial de Wildcard para JSON. Formatação não submete outra consulta ou cobrar créditos de consulta. Resultados armazenados expiram 24 horas após a conclusão. Erros permanecem estruturados JSON.
Autenticação: cookieSession ou dataApiKey
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
X-Respond-With · header · Opcional
Marque para retornar o conteúdo do resultado como Markdown. Omita reter os campos de resultados originais. Accept seleciona JSON ou texto simples. Apenas consultas em tempo real e resultados de trabalho concluídos mostram que este cabeçalho é compatível. Não muda as submissões de trabalho, status, APIs de conta, callbacks, arquivos Bulk, downloads binários, ou respostas de protocolo MCP.
Esquema
{
"type": "string",
"enum": [
"markdown"
]
}Accept · header · Opcional
Selecione application/json ou text/plain independentemente de X-Respond-With. Sem X-Respond-With, text/plain retorna os campos originais com indentação; JSON retém os campos de resposta originais (resultados completos são redirecionados para o armazenamento). Com o markdown, JSON retorna conteúdo mais metadados e texto simples retorna metadados seguidos por Markdown. Faixas de mídia padrão e pesos q são suportados, Accept faltando ou um padrão de caracteres especiais global para JSON. Ambos os tipos de resposta usam UTF-8; um parâmetro explícito charset=utf-8 é suportado.
Esquema
{
"type": "string"
}jobId · path · requerido
Esquema
{
"type": "string",
"pattern": "^job_[A-Za-z0-9_-]+$"
}Respostas
200 Os campos originais de texto simples ou Markdown retornaram diretamente; JSON original de R2 após seguir o redirecionamento padrão
Resposta 200 · application/json
{
"anyOf": [
{
"$ref": "#/components/schemas/MarkdownQueryResult"
},
{
"type": "object",
"additionalProperties": true
}
]
}Resposta 200 · text/plain
{
"type": "string"
}302 Redirecionar para JSON original em armazenamento privado R2 quando JSON é selecionado sem X-Respond-With
Cabeçalhos: Location
400 X-Respond-With sem suporte; resposta é JSON
Resposta 400 · application/json
{
"$ref": "#/components/schemas/QueryRepresentationError"
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 O recurso não foi encontrado ou não pertenceu ao chamador.
Resposta 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}406 Nem application/json nem text/plain é aceitável; a resposta é JSON
Resposta 406 · application/json
{
"$ref": "#/components/schemas/QueryRepresentationError"
}409 Estado de recursos ou conflito de indemnidade
Resposta 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 Resultado expirado
Resposta 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 A tarefa falhou. Quando disponível, o motivo da falha que foi guardado aparece no campo detail da resposta.
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Uma dependência necessária ou catálogo está temporariamente indisponível
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}API de processamento Bulk
Os terminais Bulk têm uma referência dedicada com parâmetros, pedidos de exemplos e esquemas de resposta. Abra o Bulk processando API
GET /v2/bulk-jobs· Listar trabalhos YouTubePOST /v2/bulk-jobs· Crie um trabalho Bulk e faça um upload de arquivos URLGET /v2/bulk-jobs/{bulkId}· Leia o progresso do trabalho em massa e a contagem agregadaPATCH /v2/bulk-jobs/{bulkId}· Mude as configurações para vídeos que ainda não começaramDELETE /v2/bulk-jobs/{bulkId}· Cancele um trabalho BulkPOST /v2/bulk-jobs/{bulkId}/start· Comece a digitalizar um arquivo YouTube ID carregadoPOST /v2/bulk-jobs/{bulkId}/pause· Pause um trabalho BulkPOST /v2/bulk-jobs/{bulkId}/resume· Retomar um trabalho manual ou automaticamente pausadoGET /v2/bulk-jobs/{bulkId}/results· Baixe o manifesto completoGET /v2/bulk-jobs/{bulkId}/results/{partNumber}· Baixe uma parte do resultado do NDJSON comprimido com Gzip
Playground
POST/playground/run
Execute uma consulta no playground como espaço de trabalho atual
Autenticação: cookieSession + csrfToken
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Pedir corpo · requerido
Esquema · 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
}
}
}Respostas
200 Data API resposta capturada para o playground
Resposta 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 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}422 A validação do pedido falhou
Resposta 422 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}GET/playground/jobs/{jobId}/download
Baixe um artefato de Playground completo no navegador atual
Autenticação: cookieSession
Servidor: https://api.flashdata.dev/v2
Servidor: http://localhost:5000/v2
Parâmetros
jobId · path · requerido
Esquema
{
"type": "string",
"pattern": "^job_[A-Za-z0-9_-]+$"
}Respostas
200 Armazém temporário de download do navegador
Cabeçalhos: Content-Disposition, Content-Length
Resposta 200 · application/octet-stream
{
"type": "string",
"format": "binary"
}401 Autenticação necessária ou inválida
Resposta 401 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}404 O recurso não foi encontrado ou não pertenceu ao chamador.
Resposta 404 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}409 Estado de recursos ou conflito de indemnidade
Resposta 409 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}410 O artefato temporário expirou
Resposta 410 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}503 Uma dependência necessária ou catálogo está temporariamente indisponível
Resposta 503 · application/problem+json
{
"$ref": "#/components/schemas/Problem"
}Esquema definições
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."
}
}
}