Bright Data Get Scraper Progress

0 credits/call
ae_brightdata_get_scraper_progress

Check the status of an existing Bright Data scraper run using the required snapshot_id string returned by run_scraper. Returns the run status: starting, running, ready, failed, or canceled. When the status is ready, use get_scraper_results to retrieve the scraped data.

Productivity
0 credits/call

Pricing

0 credits/call
ConditionCharge
Each call0 credits/call

This price applies only to checking the status of an existing scraping task; it does not cover starting a scrape or retrieving results. Provide the snapshot_id returned by run_scraper. Once the status is ready, use get_scraper_results to retrieve the data.

Parameters

Optional parameters use the platform defaults when omitted.

ParameterTypeRequiredDescriptionDefault
snapshot_idstringYessnapshot_id from run_scraper—

Invocation example

Copy the request and explore its response example.

POST/agent-api/v1/tool/executeX-Api-Key
Request coderequest.sh
curl --request POST \
  --url 'https://agentearth.ai/agent-api/v1/tool/execute?tool_name=ae_brightdata_get_scraper_progress' \
  --header "X-Api-Key: $AGENTEARTH_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "params": {
    "snapshot_id": "sd_mw4jknwx75ptslaq2"
  }
}'
Response exampleresponse.json
JSONPartial content
{
  "avg_duration_per_input": 8358,
  "collection_duration": 8358,
  "dataset_id": "gd_l7q7dkf244hwjntr0",
  "errors": 0,
  "records": 1,
  "status": "ready"
}

This example shows part of the response. Copied content is valid JSON.