Pular para o conteúdo
PT
Obter chave API
Explorar documentação

Referência da API

Ferramentas e esquemas MCP

Procure FlashData MCP argumentos de ferramenta, padrões, leituras de conta, estados de trabalho e recuperação de resultados.

Nesta página

Versão Markdown

OAuth, Codex, OpenClaw e API-chave de acesso opções de acesso

Escolha seu cliente MCP e conecte-se

Transporte e autenticação

O endpoint MCP hospedado usa o HTTP Streamable. As conexões API-chave enviam X-API-Key; acesso à ferramenta segue as permissões de fonte da chave e créditos disponíveis.

HTTP
URL: https://data.flashdata.dev/mcp
X-API-Key: <Sua chave API>

Guarde sua chave FlashData API real na configuração credencial do cliente. Não coloque isso em uma conversa ou discussão de ferramentas. Esta seção cobre conexões API-chave; o guia de acesso do agente cobre login OAuth e as configurações testadas Codex e OpenClaw. youtube_download suporta downloads de mídia assíncrona com a permissão apropriada API-chave.

Gerencie as chaves API

Ferramentas de pesquisa

Seu cliente descobre as ferramentas concedidas pela chave. Todas as seis ferramentas de dados Google e oito YouTube default to realtime and also aceita mode: async. submit_batch suporta ambos os grupos. youtube_download usa o download formal API, requer armazenamento do cliente, e suporta trabalhos assinc ou submit_batch. O modelo pode escolher e combinar ferramentas para a tarefa.

Google

google_search · google_images · google_news · google_shopping · google_videos · google_places

YouTube

youtube_search · youtube_search_extended · youtube_metadata · youtube_transcript · youtube_captions · youtube_trainability · youtube_channel · youtube_suggestions · youtube_download

google_search · argumentos JSON
{
  "query": "MCP protocol",
  "num": 3,
  "gl": "us",
  "hl": "en",
  "mode": "async"
}

Argumentos de ferramentas

Coloque campos de consulta, como consulta, num, linguagem e modo diretamente no objeto de argumentos da ferramenta, sem a embalagem de params do REST API. O nome de uma ferramenta de pesquisa seleciona sua fonte; apenas entradas em submit_batch precisam de fonte. Chaves API e callback_url não são argumentos de ferramentas. Os exemplos JSON abaixo são objetos de argumento para client.callTool ({ nome, argumentos}).

Usem booleanos JSON e números inteiros, não cordas. Campos desconhecidos são rejeitados. As ferramentas de consulta de dados 14 aceitam mode: realtime ou assync, predeterminando em tempo real. As entradas Batch não aceitam o modo.

FerramentaObrigatórioArgumentos opcionais e padrões
youtube_downloadvideo_id, storageO modo suporta somente assincronia (padrão). download_type: audio_video (padrão)/video/audio. video_quality: <=720 por padrão; best/worst Ou <=, 144/360/480/720/1080/1440/2160/4320. As mesmas comparações com 1–240. output_formatmp4 (padrão)/webm/mkv Para vídeo, m4a (padrão)/mp3/opus Para áudio. audio_language: default/original; audio_quality: best/320/256/192/128Apenas áudio. yt_dlp_format- Até o fim. 1024 Personagens, sobrepõe qualidade, FPS e seleção de linguagem. Omite video_quality/fps para áudio e audio_language para vídeo-somente. armazenamento é necessário e correspondências Download API params.storage. start_at/end_at: HH:MM:SS, até 12 horas; end_at deve seguir start_at. upload_metadata: booleano, padrão false. Todo download de lote precisa de armazenamento. Nenhum browser_delivery ou callback_url.
storagestorage_type, storage_urlstorage_url é o seu nome de balde (Azure:contêiner), não um diretório local. storage_type: s3/s3_compatible/oss/gcs/azure/cos/bos/tosOpcional object_prefix. S3, S3 compatível, OSS, COS, BOS e TOS usam access_key/secret_key com o region/endpoint_url. aplicável. GCS usa service_account (project_id, client_email, private_key); Azure usa account_name e um recipiente sas_token com permissão de escrita. O ponto final deve ser alcançado pelo trabalhador. Leia credenciais de sua configuração de armazenamento, não cole-as em bate-papo ou ecoe-as.
google_*queryConsulta: 1–2,000 Caracteres. Gl: país de duas letras; hl: 1–35 código de linguagem do personagem; location/tbs: 1–200 caracteres; num/page: inteiros 1–100; autocorreção: booleano. Opções omissas usam o comportamento do provedor de busca, sem garantia de país fixo, idioma ou contagem de resultados.
youtube_searchqueryConsulta: 1–2,000 Personagens. max_results: 1–20, padrão 20 Filtros: objeto filtrante, omitido ou nulo para nenhum filtro.
youtube_search_extendedqueryConsulta: 1–2,000 Personagens. max_results: 1–700, padrão 20; filtros: o mesmo que a busca padrão.
youtube_metadatavideo_idinclude_formats e include_chapters: booleanos, ambos true padrão.
youtube_transcriptvideo_idOmita a linguagem do que prefere en-orig, então en, devolvendo uma faixa. Com o auto=true, cada código prefere sua faixa -orig, em seguida, o código simples; explícito -orig e auto=false permanecer exato. Arrays tentem tudo 1–10 Linguagens solicitadas e faixas de retorno e erros em ordem. true para legendas automáticas.
youtube_captionsvideo_idOmita a linguagem do que prefere en-orig, então en, devolvendo uma faixa. Com o auto=true, cada código prefere sua faixa -orig, em seguida, o código simples; explícito -orig e auto=false permanecer exato. Arrays tentem tudo 1–10 Linguagens solicitadas e faixas de retorno e erros em ordem. false para legendas fornecidas pelo upload.
youtube_trainabilityvideo_idSem argumentos opcionais, exceto o modo. Relata a classificação de licença Creative Commons, não concede permissão de treinamento.
youtube_channelhandle1–100 caracteres video_limit 1–100, 20 padrão
youtube_suggestionsqueryConsulta: 1–2,000 caracteres; linguagem: padrão en; região: código de país de duas letras, padrão US.

video_id é um 11-caracter YouTube ID usando letras, números, sublinhados ou hífens; fornecer o ID em vez do vídeo URL. Cada código de linguagem é caracteres 1–35 usando letras, números ou hífens. Para legendas, auto=true seleciona legendas automáticas e false seleciona legendas fornecidas pelo upload, sem nenhuma falha automática entre elas. Para as linguagens, verifique erros mesmo quando o trabalho tiver sucesso.

YouTube filtros de busca

filters.type: video/channel/playlist/movie; upload_date: today/last_hour/this_week/this_month/this_year; duração: <4, 4-20 ou >20; sort_by: rating/relevance/view_count/upload_date. As bandeiras são booleanas, true requer essa característica: 360, 3d, 4k, creative_commons, hd, hdr, ao vivo, localização, comprado, legendas, vr180.

youtube_search · argumentos JSON
{
  "query": "renewable energy",
  "max_results": 5,
  "filters": {
    "type": "video",
    "duration": "<4",
    "subtitles": true
  }
}

Perspectivas de contas (gratuitas)

get_balance lê seu saldo de conta compartilhada, get_pricing estima custos de consulta, get_limits lê limites de planos e trabalhos pendentes atuais, get_usage resume os últimos dias de 7 por padrão, com uma janela máxima de 31-dia. O uso inclui todas as chaves da conta para fontes autorizadas pela chave de chamada e pode ser adiada.

get_balance e get_limits tomam {}. get_pricing aceita uma fonte opcional; omitem-na para todas as fontes de consulta MCP autorizadas pela sua chave. request_count é um inteiro de 1 para 100000, 1 padrão; cada página ou item em lote conta como um pedido separado. get_usage aceita uma fonte opcional; omitem-na para todas as fontes autorizadas. Inclui o uso do youtube_download. Baixar preços retorna creditsPerTb (1 TB = 10^12 bytes); downloads reservam créditos e liquidam por bytes enviados de fato. request_count não se aplica a downloads e estimatedCredits é null.

get_usage from/to Devem ser as datas UTC ISO, como 2026-09-21T00:000:00Z, opcionalmente com 1–3 Segundos dígitos fracionários, de inclusivo, para exclusivo, arredondados para minutos. A janela padrão é 7 dias e o máximo é 31 dias. Com apenas de, para é sete dias depois, com apenas para, de é sete dias antes. Leia a resposta from/to para a janela eficaz.

get_pricing · argumentos JSON
{
  "source": "google_search",
  "request_count": 3
}
get_usage · argumentos JSON
{
  "source": "youtube_metadata",
  "from": "2026-09-21T00:00:00Z",
  "to": "2026-09-22T00:00:00Z"
}

trabalhos e grandes resultados

Um pedido de assincronização devolve um ID de trabalho, passe-o como job_id para get_job para ler job.status. Trabalhos completados incluem a resposta de consulta original na saída. Para downloads, a saída é o manifesto de upload: output.results[0].file_url aponta para o armazenamento do cliente, com file_size, downloaded_bytes e md5. Arquivos privados requerem sua autenticação de armazenamento. JSON resultados são retidos para 24 horas, retenção de mídia e acesso seguir suas políticas de armazenamento submit_batch aceita pelo menos uma consulta Google ou YouTube (incluindo downloads), com fonte e argumentos simples em cada entrada. Cada entrada é faturada separadamente, e o lote do seu plano e limites pendentes se aplicam. Trabalhos de leitura não cobram de novo. Bulk baseado em arquivos não é uma ferramenta MCP.

Processando um arquivo ID? Use o Bulk HTTP API

youtube_transcript · argumentos JSON
{
  "video_id": "FUfGcZ092b0",
  "language": "en",
  "auto": true,
  "mode": "async"
}
submit_batch · argumentos JSON
{
  "queries": [
    {
      "source": "google_search",
      "query": "renewable energy",
      "num": 3
    },
    {
      "source": "youtube_metadata",
      "video_id": "FUfGcZ092b0",
      "include_formats": false
    }
  ]
}

Substitua o exemplo job_id, result_id e offset por valores de sua resposta. Leia o próximo bloco sem reenviar a consulta.

get_job · argumentos JSON
{
  "job_id": "job_REPLACE_WITH_RETURNED_ID"
}

Grandes respostas incluem um pedaço de texto JSON, result_id e next_offset. Chame get_result com a mesma chave e o result_id retornado. Offset é um inteiro não negativo, padrão 0; use o next_offset anterior para continuar. O limite é um inteiro de 1 para 16000, padrão 16000, medido em unidades de código UTF-16 ao invés de bytes ou linhas de resultado. Concatenar pedaços em ordem antes de analisar JSON; next_offset=null marca o fim. Os resultados são guardados para 10 minutos, com no máximo quatro grandes resultados por chave, e pode ser despejado mais cedo. Lendo pedaços não repete a consulta ou cobrar créditos.

get_result · argumentos JSON
{
  "result_id": "result_1800000000000_00000000-0000-0000-0000-000000000000",
  "offset": 16000,
  "limit": 16000
}

Billing e erros

Consultas usam o preço dos créditos do seu plano existente sem nenhum custo adicional MCP. Erros de ferramenta definir isError e manter o status de HTTP upstream e solicitar ID. Restaure créditos por saldo insuficiente e verifique as permissões de acesso.

Um tempo ou conexão perdida não significa que a consulta não foi executada. Para query_outcome_unknown, verifique o pedido History no console antes de decidir se submeter novamente. Não tente automaticamente submissões pagas, leituras de trabalhos existentes ou pedaços podem ser retentados. Respostas superiores são limitadas a 4 MiB, então limite o tamanho da busca, respostas grandes podem já ter sido carregadas.

Códigos de status HTTP · Retentar regras

Verifique com um cliente JavaScript

Este cliente usa o SDK oficial verificado 1.30.0 para conectar-se sobre o HTTP Streamable e ferramentas de lista sem executar uma consulta paga. Salve-o como mcp-check.mjs, defina FLASHDATA_API_KEY em seu ambiente, então execute o nó mcp-check.mjs.

npm
npm install @modelcontextprotocol/[email protected]
mcp-check.mjs
import { Client } from '@modelcontextprotocol/sdk/client/index.js';
import { StreamableHTTPClientTransport } from '@modelcontextprotocol/sdk/client/streamableHttp.js';

const key = process.env.FLASHDATA_API_KEY;
if (!key) throw new Error('Set FLASHDATA_API_KEY first.');
const client = new Client({ name: 'my-app', version: '1.0.0' });
try {
  await client.connect(new StreamableHTTPClientTransport(
    new URL('https://data.flashdata.dev/mcp'),
    { requestInit: { headers: { 'X-API-Key': key } } }
  ));
  console.log((await client.listTools()).tools.map(tool => tool.name));
} finally {
  await client.close();
}