Crawl
O endpointPOST /crawl inicia um crawl BFS (busca em largura) a partir de
uma URL semente. Ele descobre links internos recursivamente e extrai o
conteúdo em Markdown de cada página encontrada.
Endpoint
Autenticação
HeaderX-API-Key obrigatório. Veja Autenticação.
Parâmetros
string
obrigatório
URL semente para iniciar o crawl. SSRF guard aplicado na seed e em cada link descoberto.
integer
obrigatório
Número máximo de páginas a rastrear (1–50). Valor recomendado: 10.
Sem valor default — omitir resulta em erro
422.Custo
1 crédito por página bem-sucedida.A partir de 5 créditos estimados, o Playground solicita confirmação do usuário antes de iniciar.
Páginas com falha (bloqueio, timeout) não consomem créditos.
Fluxo assíncrono
- Envie
POST /crawl→ receba202comjob_id - Poll via
GET /jobs/{job_id}a cada 2s - Quando
status: "SUCCESS", os resultados estão no camporesults - O campo
stopped_reasonpode indicarmax_pagesse o limite foi atingido