GET/v1/crawl/:id

Poll crawl status

Returns the current status and results of a crawl job. Poll this endpoint until status is "completed" or "failed". Pages array grows as the crawl progresses.

Query parameters

Name	Type	Required	Description
id	string	required	Job ID returned by POST /v1/crawl

Example

bash

curl http://localhost:3000/v1/crawl/c3d4e5f6-...

Response

bash

{
  "success": true,
  "data": {
    "id": "c3d4e5f6-...",
    "status": "completed",
    "startUrl": "https://docs.example.com",
    "totalFound": 87,
    "totalScraped": 87,
    "pages": [
      { "url": "https://docs.example.com/intro", "title": "Introduction", "markdown": "..." }
    ],
    "createdAt": "2026-06-13T10:00:00Z",
    "completedAt": "2026-06-13T10:02:33Z"
  }
}

Try it

Live preview only works when the API is running on your machine.

Run docker compose up and the Try-It panel will become interactive. Until then, copy the curl example below.

Start a crawl Attach a webhook