Explorar documentação
Referência da API
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.
| Resposta | Accept | X-Respond-With | Use para |
|---|---|---|---|
| JSON | application/json | Omita | Processando campos em código · padrão |
| JSON + Markdown | application/json | markdown | Contexto de agente com metadados estruturados |
| Texto simples | text/plain | Omita | Lendo campos originais em um terminal |
| Texto + Markdown | text/plain | markdown | Lendo 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.
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"}'{
"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"
}Leia o conteúdo como uma string Markdown. Substitui os resultados, fonte, status e uso permanecem disponíveis como campos JSON.
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' \
--header 'X-Respond-With: markdown' \
--data '{"source":"google_search","query":"vector databases"}'{
"source": "google_search",
"status": "done",
"usage": {
"credits": 0.01
},
"created_at": "2026-10-22T12:00:00.000Z",
"content": "# Google search\n\n## Organic\n\n### 1. Example page\n\n**Link:** <https://example.com/article>\n\n**Snippet:** A short source snippet\\.\n"
}Leia a resposta como texto. Ele contém os campos originais em um layout indentado, não um documento JSON.
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: text/plain' \
--data '{"source":"google_search","query":"vector databases"}'Source: "google_search"
Status: "done"
Results:
1:
Organic:
1:
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"
Leia a resposta como texto: metadados primeiro, seguido pelo conteúdo Markdown.
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: text/plain' \
--header 'X-Respond-With: markdown' \
--data '{"source":"google_search","query":"vector databases"}'Source: "google_search"
Status: "done"
Usage: {"credits":0.01}
Created at: "2026-10-22T12:00:00.000Z"
Markdown Content:
# Google search
## Organic
### 1. Example page
**Link:** <https://example.com/article>
**Snippet:** A short source snippet\.
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 final | JSON / texto simples | Markdown conteúdo |
|---|---|---|
| POST /v1/queries/realtime | Apoiado | Apoiado |
| GET /v2/jobs/{id}/results | Apoiado | Apoiado |
| POST /v1/queries | Recibo de submissão | Ignorado - selecione-o ao ler os resultados |
| POST /v1/queries/batch | Recibo de submissão | Ignorado - selecione-o ao ler os resultados |
| GET /v2/jobs/{id} | Situação do trabalho | Ignorado, 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 solicitado | Resposta do resultado |
|---|---|
| JSON original | 302 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 Markdown | 200 com o corpo formatado diretamente na resposta. |
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ódigo | Consertar |
|---|---|
| 400 · unsupported_representation | Use X-Respond-With: marque ou omita o cabeçalho. Valores como Json ou texto não são suportados. |
| 406 · not_acceptable | Accept: 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.
Accept: text/plain; charset=utf-8, application/json;q=0.8