Skip to content
Agentic Scraper

Scrape quickstart

The POST /api/v1/scrape endpoint requires url. Asynchronous execution is the default; this example sets it explicitly.

Terminal window
curl --request POST \
  --url https://api.agenticscraper.com/api/v1/scrape \
  --header "Content-Type: application/json" \
  --header "X-API-Key: $AGENTIC_SCRAPER_API_KEY" \
  --data '{
    "url": "https://example.com",
    "async": true
  }'

The asynchronous branch returns HTTP 202 with the stored job ID and initial status:

{
  "jobId": "<uuid>",
  "status": "pending"
}

Poll the user-scoped job record:

Terminal window
curl \
  --url "https://api.agenticscraper.com/api/v1/scrape/status/$JOB_ID" \
  --header "X-API-Key: $AGENTIC_SCRAPER_API_KEY"

Setting async to false keeps the HTTP request open until the pipeline finishes and then returns the stored result, or a fallback object containing jobId, status, and error.

The API validates the active subscription and monthly transaction limit before creating the job. Runtime options and request fields are defined in the API reference.