Skip to main content

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.

Every management endpoint takes the crawl job id returned by POST /api/crawl. All three return { "ok": true } on success.

​
Stop

POST https://v2-api.scrapegraphai.com/api/crawl/:id/stop
Stops an in-flight crawl. Already-fetched pages remain available; no further URLs will be expanded. 
curl -X POST https://v2-api.scrapegraphai.com/api/crawl/79694e03-.../stop \
  -H "SGAI-APIKEY: $SGAI_API_KEY"

​
Resume

POST https://v2-api.scrapegraphai.com/api/crawl/:id/resume
Resumes a stopped job from its last frontier. 
curl -X POST https://v2-api.scrapegraphai.com/api/crawl/79694e03-.../resume \
  -H "SGAI-APIKEY: $SGAI_API_KEY"

​
Delete

DELETE https://v2-api.scrapegraphai.com/api/crawl/:id
Permanently removes the crawl record and its stored pages. Cannot be undone. 
curl -X DELETE https://v2-api.scrapegraphai.com/api/crawl/79694e03-... \
  -H "SGAI-APIKEY: $SGAI_API_KEY"