Start a batch scrape
brightdata.web.scrape.job.startStart an asynchronous scraping job over a batch of URLs and get a snapshot id back
- Price
- $0.0015/resultAt provider cost
- Success rate
- 99.3%Last 30 days · 631 calls
- Latency p50
- 394 msp95 1 s
- Last verified
- Jul 28, 2026Verified working
POSThttps://toolswitch.dev/v1/tools/brightdata.web.scrape.job.start?dataset_id=gd_l1vikfch901nx3by4Preview- Uses platform quota
- Synchronous response
- Reads public data
Parameters
returns {snapshot_id: "s_…"} immediately; nothing is billed until records are delivered. Always set limit_per_input on a discovery run — a discover_new job with no cap decides for itself how many records to produce, and each one is billable
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Query parameters | ||||
type | string | Optional | set to discover_new to run a discovery crawl instead of scraping the given URLs | discover_new |
format | string | Optional | json | ndjson | jsonl | csv | |
notify | boolean | Optional | fire a webhook when the job finishes | |
endpoint | string | Optional | webhook URL used when notify is set | |
dataset_id | string | Required | which managed scraper to run | gd_l1vikfch901nx3by4 |
auth_header | string | Optional | Authorization header value Bright Data should send to your webhook | |
discover_by | string | Optional | with type=discover_new: keyword | best_sellers_url | category_url | location | |
include_errors | boolean | Optional | include a per-input error report in the snapshot | |
limit_per_input | integer | Optional | cap records produced per input row — the main guard on discovery spend | 10 |
custom_output_fields | string | Optional | pipe-separated field list | |
uncompressed_webhook | boolean | Optional | ||
limit_multiple_results | integer | Optional | cap total records across the whole job | |
- Query parameters
typestringOptionalset to discover_new to run a discovery crawl instead of scraping the given URLs
Example:
discover_newformatstringOptionaljson | ndjson | jsonl | csv
notifybooleanOptionalfire a webhook when the job finishes
endpointstringOptionalwebhook URL used when notify is set
dataset_idstringRequiredwhich managed scraper to run
Example:
gd_l1vikfch901nx3by4auth_headerstringOptionalAuthorization header value Bright Data should send to your webhook
discover_bystringOptionalwith type=discover_new: keyword | best_sellers_url | category_url | location
include_errorsbooleanOptionalinclude a per-input error report in the snapshot
limit_per_inputintegerOptionalcap records produced per input row — the main guard on discovery spend
Example:
10custom_output_fieldsstringOptionalpipe-separated field list
uncompressed_webhookbooleanOptionallimit_multiple_resultsintegerOptionalcap total records across the whole job
Code samples
Replace $TOOLSWITCH_KEY with the key you created in the console.
curl -X POST 'https://toolswitch.dev/v1/tools/brightdata.web.scrape.job.start?dataset_id=gd_l1vikfch901nx3by4' \
-H "X-Toolswitch-Key: $TOOLSWITCH_KEY" \
-H "Content-Type: application/json" \
--data-raw '[{"url":"https://www.instagram.com/instagram"}]'import os
import json
import requests
response = requests.request(
"POST",
"https://toolswitch.dev/v1/tools/brightdata.web.scrape.job.start?dataset_id=gd_l1vikfch901nx3by4",
headers={"X-Toolswitch-Key": os.environ["TOOLSWITCH_KEY"]},
json=json.loads("[{\"url\":\"https://www.instagram.com/instagram\"}]"),
)
response.raise_for_status()
print(response.text)const response = await fetch("https://toolswitch.dev/v1/tools/brightdata.web.scrape.job.start?dataset_id=gd_l1vikfch901nx3by4", {
method: "POST",
headers: {
"X-Toolswitch-Key": process.env.TOOLSWITCH_KEY ?? "",
"Content-Type": "application/json",
},
body: JSON.stringify(JSON.parse("[{\"url\":\"https://www.instagram.com/instagram\"}]")),
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
console.log(await response.text());This gateway API is in preview; its URL and authentication may change. The example parameters are sample data. Calls are billed at $0.0015/result, including the service fee.