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

Referência da API

Formatos de resposta

Escolha JSON estruturado para sua aplicação ou conteúdo Markdown para um agente de IA. Controle a resposta com dois cabeçalhos.

Nesta página

Escolha um formato

JSON com os campos de resultados originais é o padrão. Accept seleciona JSON ou texto simples; X-Respond-With: Markdown converte o conteúdo do resultado em Markdown. Seu corpo de pedido permanece JSON.

RespostaAcceptX-Respond-WithUse para
JSONapplication/jsonOmitaProcessando campos em código · padrão
JSON + Markdownapplication/jsonmarkdownContexto de agente com metadados estruturados
Texto simplestext/plainOmitaLendo campos originais em um terminal
Texto + Markdowntext/plainmarkdownLendo metadados e Markdown juntos

Requisição e resposta exemplos

Essas abas mostram o mesmo Google Search em cada formato. Use Bash e cURL 7.76+ com FLASHDATA_API_KEY configurado para uma chave que permite google_search. Executando um comando envia uma busca creditável.

Predefinição. Analisar os resultados, os campos dentro dependem da fonte.

Pedido: cURL / Bash
curl --fail-with-body --silent --show-error \
  'https://data.flashdata.dev/v1/queries/realtime' \
  --header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{"source":"google_search","query":"vector databases"}'
Resposta exemplo · valores ilustrativos
{
  "source": "google_search",
  "status": "done",
  "results": [
    {
      "organic": [
        {
          "title": "Example page",
          "link": "https://example.com/article",
          "snippet": "A short source snippet."
        }
      ]
    }
  ],
  "usage": {
    "credits": 0.01
  },
  "created_at": "2026-10-22T12:00:00.000Z"
}

Endpoints apoiados

As mesmas regras se aplicam às fontes de pesquisa Google Search e YouTube. Para YouTube Download, formatam o registro de entrega, não o vídeo ou os bytes de áudio. APIs de contas, manifestos Bulk e peças NDJSON, callbacks e respostas MCP usam seus próprios formatos.

Ponto finalJSON / texto simplesMarkdown conteúdo
POST /v1/queries/realtimeApoiadoApoiado
GET /v2/jobs/{id}/resultsApoiadoApoiado
POST /v1/queriesRecibo de submissãoIgnorado - selecione-o ao ler os resultados
POST /v1/queries/batchRecibo de submissãoIgnorado - selecione-o ao ler os resultados
GET /v2/jobs/{id}Situação do trabalhoIgnorado, sem conteúdo de resultados aqui

Formatar um resultado completo do trabalho

Defina os cabeçalhos ao ler o resultado, mesmo que os defina na submissão. Coloque JOB_ID em um trabalho completo que você pode acessar. Este GET lê resultados existentes sem enviar outra consulta.

Formato solicitadoResposta do resultado
JSON original302 com um armazenamento assinado URL em Location. Traga esse URL separadamente, sem X-API-Key. Os resultados armazenados podem ser comprimidos por GPS.
Texto simples ou opção Markdown200 com o corpo formatado diretamente na resposta.
Recuperar Markdown dentro JSON · cURL / Bash
curl --fail-with-body --silent --show-error \
  "https://api.flashdata.dev/v2/jobs/${JOB_ID:?Set JOB_ID}/results" \
  --header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
  --header 'Accept: application/json' \
  --header 'X-Respond-With: markdown'

Erros de formatação

Erros API permanecem JSON ou application/problem+json, mesmo quando você pede texto simples. Verifique o status do HTTP antes de analisar o formato de sucesso.

Status / códigoConsertar
400 · unsupported_representationUse X-Respond-With: marque ou omita o cabeçalho. Valores como Json ou texto não são suportados.
406 · not_acceptableAccept: application/json ou text/plain. text/markdown e application/xml não são suportados.

Accept cabeçalho detalhes

Omita Accept ou envie */* para obter JSON. Respostas usam UTF-8. Faixas de mídia e pesos q são suportados, um charset não suportado retorna 406 a menos que outro intervalo aceitável corresponda. Content-Type: application/json descreve o corpo de solicitação, não a resposta.

Prefira texto, permita JSON
Accept: text/plain; charset=utf-8, application/json;q=0.8