Bright Data Get Scraper Details

0 credits/call
ae_brightdata_get_scraper_details

View the documentation for one Bright Data scraper method before running it. Provide both required inputs: dataset_id from search_scrapers and method copied exactly from the scraper's collection_methods list, including any apparent misspellings. Returns the scraper description, input fields, example input and main output fields. Build the input for run_scraper using sample_input or input_fields. Actual collected records may contain more fields than output_fields lists.

Productivity
0 credits/call

Pricing

0 credits/call
ConditionCharge
Each call0 credits/call

Parameters

Optional parameters use the platform defaults when omitted.

ParameterTypeRequiredDescriptionDefault
methodstringYesOne of the scraper collection_methods, exactly as listed (some names are misspelled on purpose)—
dataset_idstringYesdataset_id from search_scrapers—

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_details' \
  --header "X-Api-Key: $AGENTEARTH_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "params": {
    "dataset_id": "gd_le8e811kzy4ggddlq",
    "method": "collect_by_url"
  }
}'
Response exampleresponse.json
JSONPartial content
{
  "dataset_id": "gd_le8e811kzy4ggddlq",
  "description": null,
  "domain": "amazon.com",
  "input_fields": [
    {
      "name": "url",
      "required": true,
      "type": "url"
    }
  ],
  "method": "collect_by_url",
  "name": "Amazon Reviews"
}

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