POST /api/crawl.
Path parameters
The crawl job UUID returned by
POST /api/crawl.Example request
Example response
| Field | Description |
|---|---|
status | "running", "completed", "failed", or "stopped". |
total / finished | Progress counters. |
pages[] | Per-page results, ordered by crawl time. |
pages[].scrapeRefId | UUID of the underlying Scrape call — use it to fetch the full formatted content. |
Poll at a reasonable cadence (every 1–5 seconds) until
status is "completed", "failed", or "stopped". Or use Monitor with a webhook to avoid polling entirely.Related
- Start a job:
POST /api/crawl - Stop / resume / delete: Manage crawl jobs