Skip to main content
You are viewing the v1 (legacy) API documentation. The v1 API uses /v1/* endpoints. Please migrate to the v2 API which uses /api/v2/* endpoints.

Base URL

https://api.scrapegraphai.com/v1

Authentication

All v1 API requests require the SGAI-APIKEY header:
curl -X POST "https://api.scrapegraphai.com/v1/smartscraper" \
  -H "SGAI-APIKEY: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"website_url": "https://example.com", "user_prompt": "Extract data"}'
In v2, authentication uses the Authorization: Bearer header instead.

v1 Endpoints

EndpointMethodDescription
/v1/smartscraperPOSTStart a SmartScraper job
/v1/smartscraper/{id}GETGet SmartScraper job status
/v1/searchscraperPOSTStart a SearchScraper job
/v1/searchscraper/{id}GETGet SearchScraper job status
/v1/markdownifyPOSTStart a Markdownify job
/v1/markdownify/{id}GETGet Markdownify job status
/v1/smartcrawlerPOSTStart a SmartCrawler job
/v1/smartcrawler/{id}GETGet SmartCrawler job status
/v1/sitemapPOSTStart a Sitemap job
/v1/sitemap/{id}GETGet Sitemap job status
/v1/creditsGETGet remaining credits
/v1/feedbackPOSTSubmit feedback

Migration to v2

See the v2 API Reference for the latest endpoints and authentication methods.