API Reference
5 endpoints for Research Jobs: Start a durable cross-corpus research job; Read a research job status; Cancel a research job; Read research job events; Read all retained research results.
curl -X POST "https://api.crawlora.net/api/v1/research/jobs" \
-H "x-api-key: $CRAWLORA_API_KEY" \
-H "Content-Type: application/json" \
-d '{"exclude_domains":["string"],"idempotency_key":"0123456789abcdef","include_domains":["string"],"limits":{"browser_renders":0,"input_tokens":60000,"max_credits":1,"output_tokens":8000,"rounds":3,"searches":8,"sources":20,"timeout_seconds":180},"output_format":"report","query":"How do recent studies measure retrieval quality?","schema":{},"scope":"mixed","seed_urls":["string"],"sources":["string"]}'/research/jobsapiKey0 credits/requestSubmits bounded research over the selected web, arXiv paper, and developer-document sources. Repeated owner-scoped idempotency requests return the original job.
Required: request.
/research/jobs/{job_id}apiKey0 credits/requestReturns the state of a research job by `job_id`: queued, running, cancelling, succeeded, failed or cancelled. The response carries `progress` counts, `research` progress (round, searches completed, sources read, questions answered), usage, warnings, `partial`, `deadline_at` and any error. A job not started within 30 minutes fails with `timeout`.
Required: job_id.
/research/jobs/{job_id}/cancelapiKey0 credits/requestRequests cancellation of the caller's own research job, given by `job_id`. Returns the job's current state (such as `cancelling`), `cancel_requested`, `partial`, progress counts, research progress and usage. Results already retained stay readable and are marked partial where appropriate.
Required: job_id.
/research/jobs/{job_id}/eventsapiKey0 credits/requestReads a page of events for one of the caller's research jobs, by `job_id`. `limit` is 1 to 100 (default 50); pass `next_cursor` back as `cursor` to continue, with `has_more` showing whether more remain. Each event has `sequence`, `type` (such as `source_fetched` or `round_completed`), `timestamp`, `message` and `source_id`.
Required: job_id. Optional: cursor, limit.
/research/jobs/{job_id}/resultsapiKey0 credits/requestReturns the complete owner-scoped retained result prefix up to a consistent manifest sequence. Before a valid report or structured result exists, returns `ready=false` with `partial=true` and any retained evidence.
Required: job_id.