Bright Data Web Scraper API
Bright Data Web Scraper API triggers an authorized dataset collection from URL records and provides snapshot retrieval endpoints. The returned structured records can contain page text, HTML, or domain-specific fields depending on the selected dataset.
Connect this API to an AI agent Browse all specs
What you can do with Bright Data Web Scraper API via MCP
Every endpoint below becomes a governed tool your AI agent (Claude, ChatGPT, or a customer-facing VX agent) can call — with scoped permissions, sandbox testing, and audit logs.
| Method | Path | Operation | Description |
|---|---|---|---|
| POST | /datasets/v3/trigger |
postDatasetsV3Trigger | Trigger a URL collection Method: POST Path: /datasets/v3/trigger IMPORTANT: This function has 2 REQUIRED parameter(s) and 2 OPTIONAL parameter(s) REQUIRED parameters MUST be provided OPTIONAL parameters can be omitted if not needed Parameters: Query Parameters: REQUIRED: - dataset_id: Bright Data dataset or collector identifier. OPTIONAL: - include_errors: Include error records in the snapshot. - notify: Request a notification when the snapshot is ready. Request Body: REQUIRED: - body: Request body (application/json) |
| GET | /datasets/v3/snapshot/{snapshot_id} |
getDatasetsV3SnapshotBySnapshotId | Get collection snapshot Method: GET Path: /datasets/v3/snapshot/{snapshot_id} IMPORTANT: This function has 1 REQUIRED parameter(s) and 1 OPTIONAL parameter(s) REQUIRED parameters MUST be provided OPTIONAL parameters can be omitted if not needed Parameters: Path Parameters: REQUIRED: - snapshot_id: Snapshot identifier returned by the trigger operation. Query Parameters: OPTIONAL: - format: Response format. |
Usage guide
## Authentication Create a Bright Data API key in the Bright Data control panel. Send `Authorization: Bearer <BRIGHTDATA_API_KEY>` on every request. Keep the key server-side. The `dataset_id` identifies the approved Web Scraper dataset or collector used by your account. ## Operations - `POST /datasets/v3/trigger` starts a collection from a JSON array of URL records and returns a snapshot ID. - `GET /datasets/v3/snapshot/{snapshot_id}` retrieves the resulting dataset, commonly as JSON. ## Example ```bash curl -X POST "https://api.brightdata.com/datasets/v3/trigger?dataset_id=$DATASET_ID&include_errors=true" \ -H "Authorization: Bearer $BRIGHTDATA_API_KEY" \ -H "Content-Type: application/json" \ -d '[{"url":"https://example.com"}]' ``` Use only datasets and target URLs authorized by your account and applicable terms. Official documentation: https://docs.brightdata.com/datasets/scrapers/scraper-api
How to use this spec
- Create a free VX Agents account (sandbox tools included).
- Open the marketplace and connect “Bright Data Web Scraper API” to an agent.
- Expose it as an MCP server for Claude/ChatGPT, or chat with it directly.