Trigger async batch collection
POST /dca/trigger queues a Bright Data Scraper Studio collector to run against one or more inputs. Returns a collection_id to poll for the dataset.
Queue a published Bright Data Scraper Studio collector to run against one or more inputs. The endpoint returns aDocumentation Index
Fetch the complete documentation index at: https://docs.brightdata.com/llms.txt
Use this file to discover all available pages before exploring further.
collection_id immediately. Poll the Receive batch data endpoint with that ID until the dataset is ready.
For the full happy-path walkthrough (auth, trigger, poll, parse) in cURL, Python and Node.js, see the Quickstart. This page is the parameter and error reference.
Request
The request body is a JSON array of input objects. Each object must match the input schema you defined when you built the collector in Scraper Studio. The default schema is a singleurl field.
Response
collection_id is the snapshot identifier. Pass it to /dca/dataset?id=<collection_id> to poll for results. See the Quickstart for how the IDs relate to one another.
Errors
| Status | Cause | Fix |
|---|---|---|
401 Unauthorized | Token missing, malformed or revoked | Re-copy from Account Settings → API Tokens |
404 Not Found | Collector ID does not exist or your account does not have access | Open the collector in Scraper Studio and re-copy the ID |
422 Unprocessable Entity | The objects in your request body do not match the collector’s input schema | Confirm field names against the Inputs tab of your collector |
5xx | Transient Bright Data API error | Retry with exponential backoff, for example 1s, 2s, 4s |
Retry behavior
Re-triggering the same inputs creates a new collection with a newcollection_id. The endpoint is not idempotent and there is no de-duplication across triggers. To retry only the failed inputs from a previous run, use Get errors for a job to identify them, then trigger a new collection with just those inputs.
Related
- Quickstart: full trigger, poll and parse walkthrough in cURL, Python and Node.js
- Receive batch data: poll for the dataset
- Node.js starter: production-grade client that calls this endpoint
- Python starter: same, in Python
Authorizations
Use your Bright Data API Key as a Bearer token in the Authorization header.
How to authenticate:
- Obtain your API Key from the Bright Data account settings at https://brightdata.com/cp/setting/users
- Include the API Key in the Authorization header of your requests
- Format:
Authorization: Bearer YOUR_API_KEY
Example:
Authorization: Bearer b5648e1096c6442f60a6c4bbbe73f8d2234d3d8324554bd6a7ec8f3f251f07dfLearn how to get your Bright Data API key: https://docs.brightdata.com/api-reference/authentication
Query Parameters
A unique identification of scraper
Set to dev to trigger the development version of the scraper
human_name - A human readable name for the batch
If there's already something in the crawl queue, push this job into the queue
Send another batch of requests that will start after the last one is finished
Cancel running job and run instead, submit the request and cancel running one
Disable media file download
Set job time deadline, job will be terminated after specified time. h for hours, m for minutes, s for seconds.
Body
Response
OK