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

Referência da API

Realtime e async

Obter resultados na resposta, ou enviar um trabalho e recuperá-los mais tarde. Escolha como sua aplicação ou agente espera pelo trabalho.

Nesta página

Escolha um modo de solicitação

Google Search e YouTube Data suportam ambos os modos. YouTube Download requer assincronia, Batch ou Bulk; não suporta em tempo real. Os parâmetros de origem permanecem os mesmos ao mudar de tempo real para assincronia.

ModoUse quandoO que você recebe
RealtimeUm resultado de busca é necessário na interação atual.O corpo do resultado na mesma resposta HTTP.
AsyncO trabalho deve continuar após o processo desligar, ou você está baixando a mídia.Um trabalho ID imediatamente, buscar status e resultados separadamente.
Requisito ciclo de vida
Realtime POST data.flashdata.dev/v1/queries/realtime → resultados
Async POST data.flashdata.dev/v1/queries → trabalho ID
          GET api.flashdata.dev/v2/jobs/{id} → status
          GET  api.flashdata.dev/v2/jobs/{id}/results → resultados

Envie um pedido

Coloque FLASHDATA_API_KEY em uma chave que permite google_search. Escolha em tempo real ou assincronia, cada submissão faz uma busca. Mantenha scripts, recibos e resultados na mesma pasta de trabalho.

Exemplos Python usam Python 3.10+ e Pedidos. Cada script é executado independentemente e lê arquivos salvos de passos anteriores. A alternativa cURL precisa de Bash, cURL 7.76+ e jq.

Python · Instale uma vez
python3 -m pip install requests

Realtime: obter o resultado agora

POST /v1/queries/realtime retorna status: done e uma matriz de resultados. Leia result.json, nenhuma votação é necessária.

Salve como realtime.py e execute python3 realtime.py.

realtime.py
import json
import os
from pathlib import Path

import requests

response = requests.post(
    "https://data.flashdata.dev/v1/queries/realtime",
    headers={"X-API-Key": os.environ["FLASHDATA_API_KEY"]},
    json={"source": "google_search", "query": "battery recycling research", "params": {"num": 5}},
    timeout=120, allow_redirects=False,
)
response.raise_for_status()
result = response.json()
Path("result.json").write_text(json.dumps(result, indent=2), encoding="utf-8")
print(json.dumps(result, indent=2))

AsyncEconomize um recibo de trabalho

POST /v1/queries retorna um recibo de trabalho pendente, não os resultados da busca. Salve o submission.json e continue com os pedidos de status e resultado abaixo.

Salve como submit_async.py e execute python3 submit_async.py.

submit_async.py
import json
import os
from pathlib import Path

import requests

response = requests.post(
    "https://data.flashdata.dev/v1/queries",
    headers={"X-API-Key": os.environ["FLASHDATA_API_KEY"]},
    json={"source": "google_search", "query": "battery recycling research", "params": {"num": 5}},
    timeout=30, allow_redirects=False,
)
response.raise_for_status()
result = response.json()
Path("submission.json").write_text(json.dumps(result, indent=2), encoding="utf-8")
print(json.dumps(result, indent=2))
Campos de recepção. Exemplo abreviado
{
  "id": "job_EXAMPLE",
  "source": "google_search",
  "status": "pending"
}

verificação um trabalho assincronizado

Leia job.status usando ID em submission.json. Para aguardar ou processar, espere pelo atraso do Retry-After antes de verificar novamente; Python imprime e cURL salva em status-headers.txt. Use o backoff se nenhuma dica for devolvida. Um pedido de status bem sucedido não significa que o trabalho tenha terminado.

job.statusPróxima ação
pending / processingEspere, então verifique o mesmo trabalho ID novamente.
completedRecupere o resultado salvo.
failedLeia job.error. Conserte a causa antes de enviar um novo trabalho.

Salve como job_status.py e execute python3 job_status.py.

job_status.py
import json
import os
from pathlib import Path

import requests

job_id = json.loads(Path("submission.json").read_text(encoding="utf-8"))["id"]
response = requests.get(
    f"https://api.flashdata.dev/v2/jobs/{job_id}",
    headers={"X-API-Key": os.environ["FLASHDATA_API_KEY"]},
    timeout=30, allow_redirects=False,
)
response.raise_for_status()
Path("job.json").write_text(json.dumps(response.json(), indent=2), encoding="utf-8")
print(json.dumps(response.json()["job"], indent=2))
print("Retry-After:", response.headers.get("Retry-After", "not provided"))

Recupere o resultado finalizado

Execute isso depois que job.status estiver concluído. A resposta padrão dos resultados é 302: localização aponta para um armazenamento assinado URL. Os dois pedidos abaixo mantêm sua chave API no FlashData e salvam o JSON original no result.json. Para YouTube Download, este JSON descreve a mídia entregue em seu armazenamento, não é o arquivo de vídeo ou áudio.

Salve como job_result.py e execute python3 job_result.py.

job_result.py
import json
import os
from pathlib import Path

import requests

receipt = json.loads(Path("submission.json").read_text(encoding="utf-8"))
job_id = receipt["id"]
response = requests.get(
    f"https://api.flashdata.dev/v2/jobs/{job_id}/results",
    headers={"X-API-Key": os.environ["FLASHDATA_API_KEY"]},
    timeout=30, allow_redirects=False,
)
response.raise_for_status()
if response.status_code != 302:
    raise RuntimeError(f"Expected a result redirect, got {response.status_code}")
url = response.headers["Location"]
if not url.startswith("https://"):
    raise ValueError("Expected an HTTPS storage URL")

# A separate request: no FlashData key is sent to storage.
result = requests.get(url, timeout=120)
result.raise_for_status()
data = result.json()  # Requests automatically decodes Content-Encoding: gzip.
Path("result.json").write_text(json.dumps(data, indent=2), encoding="utf-8")
print(json.dumps(data, indent=2))

Lidar com atrasos e falhas

SituaçãoO que fazer
Tempo de envio esgotadoUm POST pode já ter sido aceito. verificação seu recibo e histórico de contas antes de reenviar, os POSTs repetidos podem criar novos trabalhos.
409 · result_not_readyContinue com o status de pesquisa. Não crie outro trabalho.
422 · result_not_readyO trabalho falhou. Leia job.error antes de tentar novamente.
429Honrar Retry-After ou retry_after, reduzir a taxa de submissão quando a capacidade pendente estiver cheia.
410 · result_expiredResultados armazenados expiram 24 horas após a conclusão. Use sua cópia guardada.