Documentation Index
Fetch the complete documentation index at: https://docs.scrapegraphai.com/llms.txt
Use this file to discover all available pages before exploring further.
POST /api/crawl. Each returned page includes its lightweight crawl metadata and, when available, the resolved scrape result for that page.
Use this endpoint for page content. Keep GET /api/crawl/:id for lightweight status polling.
Path parameters
The crawl job UUID returned by
POST /api/crawl.Query parameters
Number of crawl pages to return in this response. Minimum
1, maximum 100.Zero-based index cursor.
0 starts at the first crawl page. Use the pagination.nextCursor value from the previous response to fetch the next slice.Pagination behavior
limit controls the page size. If you omit it, the API returns up to 50 crawl pages. cursor is an index into the ordered crawl page list, not an opaque token. For example:
pagination.nextCursor is null, there are no more crawl pages to fetch.
Example request
Example response
| Field | Description |
|---|---|
data[] | Ordered crawl pages for this slice. |
data[].scrapeRefId | UUID of the underlying Scrape request. |
data[].scrape | Resolved Scrape response for the page, when the page has a scrapeRefId and the result is available. |
pagination.limit | Echo of the requested page size. |
pagination.nextCursor | Cursor for the next request, or null when there are no more pages. |
scrape is resolved by default. There is no expand or populate query parameter. If you only need one page’s underlying Scrape request, you can also fetch data[].scrapeRefId with GET /api/history/:id.Related
- Start a job:
POST /api/crawl - Poll status:
GET /api/crawl/:id - Fetch one underlying scrape:
GET /api/history/:id - Stop / resume / delete: Manage crawl jobs