MarkUDown
Jobs assíncronos — documentação da API de web scraping MarkUDown
Jobs Assíncronos
Operações de longa duração são processadas de forma assíncrona. A API retorna um id imediatamente; faça polling do endpoint de status até o job concluir.
Enviar um job assíncrono
POST /api/crawl
X-API-KEY: your-api-key
{
"url": ["https://docs.example.com/"],
"max_depth": 3,
"limit": 100
}
// Response
{
"success": true,
"id": "abc123",
"url": "/api/crawl/abc123"
}Consultar resultados
GET /api/crawl/abc123
X-API-KEY: your-api-key
// Waiting / running ("progress" appears on some jobs):
{ "success": false, "id": "abc123", "status": "pending" }
{ "success": false, "id": "abc123", "status": "processing", "progress": 50 }
// When complete:
{
"success": true,
"id": "abc123",
"status": "completed",
"data": {
"success": true,
"total": 42,
"data": [...]
}
}
// On failure:
{ "success": false, "id": "abc123", "status": "failed", "error": "job failed: ..." }
// Result no longer kept (see below):
{ "success": false, "id": "abc123", "status": "not_found" }
// A job id that is not yours: HTTP 404 { "detail": "Job not found" }Endpoints assíncronos suportados:
crawlmapextractprompt-extractsearchrssbatch-scrapechange-detectiondeep-researchagentsmart-extractrankdatasetJobs do Prompt Extract são consultados em /api/extract/{id}. Os resultados prontos ficam guardados por tempo limitado (no máximo 1–2 horas, menos sob carga alta) — leia logo ou use callback_url; depois disso o status vira not_found. Só a chave de API que enviou o job pode lê-lo.
Cancelar um job
Jobs de Crawl, Extract, Agent, Smart Extract e Dataset podem ser cancelados com DELETE na mesma URL.
DELETE /api/crawl/abc123
X-API-KEY: your-api-key
{ "success": true, "id": "abc123", "status": "cancelled" }
// or, when the job can no longer be removed:
{ "success": false, "id": "abc123", "status": "not_cancellable" }Webhook (callback_url)
Os endpoints que aceitam callback_url enviam este JSON (POST) para ele quando o job termina. A URL precisa ser um endereço http(s) público.
{
"event": "completed", // or "failed"
"queue": "crawl",
"jobId": "abc123",
"data": { ... }, // same as "data" when polling; "error" instead on failure
"timestamp": "2026-11-16T14:30:00.000Z"
}