Bright Data

使用说明

Integrate Bright Data into the workflow. Scrape any URL with Web Unlocker, search Google and other engines with SERP API, discover web content ranked by intent, or trigger pre-built scrapers for structured data extraction.

工具

`brightdata_scrape_url`

Fetch content from any URL using Bright Data Web Unlocker. Bypasses anti-bot protections, CAPTCHAs, and IP blocks automatically.

输入

参数	类型	必填	描述
`apiKey`	string	是	Bright Data API token
`zone`	string	是	Web Unlocker zone name from your Bright Data dashboard (e.g., "web_unlocker1")
`url`	string	是	The URL to scrape (e.g., "https://example.com/page"\)
`format`	string	否	Response format: "raw" for HTML or "json" for parsed content. Defaults to "raw"
`country`	string	否	Two-letter country code for geo-targeting (e.g., "us", "gb")

输出

参数	类型	描述
`content`	string	The scraped page content (HTML or JSON depending on format)
`url`	string	The URL that was scraped
`statusCode`	number	HTTP status code of the response

`brightdata_serp_search`

Search Google, Bing, DuckDuckGo, or Yandex and get structured search results using Bright Data SERP API.

输入

参数	类型	必填	描述
`apiKey`	string	是	Bright Data API token
`zone`	string	是	SERP API zone name from your Bright Data dashboard (e.g., "serp_api1")
`query`	string	是	The search query (e.g., "best project management tools")
`searchEngine`	string	否	Search engine to use: "google", "bing", "duckduckgo", or "yandex". Defaults to "google"
`country`	string	否	Two-letter country code for localized results (e.g., "us", "gb")
`language`	string	否	Two-letter language code (e.g., "en", "es")
`numResults`	number	否	Number of results to return (e.g., 10, 20). Defaults to 10

输出

参数	类型	描述
`results`	array	Array of search results
↳ `title`	string	Title of the search result
↳ `url`	string	URL of the search result
↳ `description`	string	Snippet or description of the result
↳ `rank`	number	Position in search results
`query`	string	The search query that was executed
`searchEngine`	string	The search engine that was used

`brightdata_discover`

AI-powered web discovery that finds and ranks results by intent. Returns up to 1,000 results with optional cleaned page content for RAG and verification.

输入

参数	类型	必填	描述
`apiKey`	string	是	Bright Data API token
`query`	string	是	The search query (e.g., "competitor pricing changes enterprise plan")
`numResults`	number	否	Number of results to return, up to 1000. Defaults to 10
`intent`	string	否	Describes what the agent is trying to accomplish, used to rank results by relevance (e.g., "find official pricing pages and change notes")
`includeContent`	boolean	否	Whether to include cleaned page content in results
`format`	string	否	Response format: "json" or "markdown". Defaults to "json"
`language`	string	否	Search language code (e.g., "en", "es", "fr"). Defaults to "en"
`country`	string	否	Two-letter ISO country code for localized results (e.g., "us", "gb")

输出

参数	类型	描述
`results`	array	Array of discovered web results ranked by intent relevance
↳ `url`	string	URL of the discovered page
↳ `title`	string	Page title
↳ `description`	string	Page description or snippet
↳ `relevanceScore`	number	AI-calculated relevance score for intent-based ranking
↳ `content`	string	Cleaned page content in the requested format (when includeContent is true)
`query`	string	The search query that was executed
`totalResults`	number	Total number of results returned

`brightdata_sync_scrape`

Scrape URLs synchronously using a Bright Data pre-built scraper and get structured results directly. Supports up to 20 URLs with a 1-minute timeout.

输入

参数	类型	必填	描述
`apiKey`	string	是	Bright Data API token
`datasetId`	string	是	Dataset scraper ID from your Bright Data dashboard (e.g., "gd_l1viktl72bvl7bjuj0")
`urls`	string	是	JSON array of URL objects to scrape, up to 20 (e.g., [{"url": "https://example.com/product"\}\]\)
`format`	string	否	Output format: "json", "ndjson", or "csv". Defaults to "json"
`includeErrors`	boolean	否	Whether to include error reports in results

输出

参数	类型	描述
`data`	array	Array of scraped result objects with fields specific to the dataset scraper used
`snapshotId`	string	Snapshot ID returned if the request exceeded the 1-minute timeout and switched to async processing
`isAsync`	boolean	Whether the request fell back to async mode (true means use snapshot ID to retrieve results)

`brightdata_scrape_dataset`

Trigger a Bright Data pre-built scraper to extract structured data from URLs. Supports 660+ scrapers for platforms like Amazon, LinkedIn, Instagram, and more.

输入

参数	类型	必填	描述
`apiKey`	string	是	Bright Data API token
`datasetId`	string	是	Dataset scraper ID from your Bright Data dashboard (e.g., "gd_l1viktl72bvl7bjuj0")
`urls`	string	是	JSON array of URL objects to scrape (e.g., [{"url": "https://example.com/product"\}\]\)
`format`	string	否	Output format: "json" or "csv". Defaults to "json"

输出

参数	类型	描述
`snapshotId`	string	The snapshot ID to retrieve results later
`status`	string	Status of the scraping job (e.g., "triggered", "running")

`brightdata_snapshot_status`

Check the progress of an async Bright Data scraping job. Returns status: starting, running, ready, or failed.

输入

参数	类型	必填	描述
`apiKey`	string	是	Bright Data API token
`snapshotId`	string	是	The snapshot ID returned when the collection was triggered (e.g., "s_m4x7enmven8djfqak")

输出

参数	类型	描述
`snapshotId`	string	The snapshot ID that was queried
`datasetId`	string	The dataset ID associated with this snapshot
`status`	string	Current status of the snapshot: "starting", "running", "ready", or "failed"

`brightdata_download_snapshot`

Download the results of a completed Bright Data scraping job using its snapshot ID. The snapshot must have ready status.

输入

参数	类型	必填	描述
`apiKey`	string	是	Bright Data API token
`snapshotId`	string	是	The snapshot ID returned when the collection was triggered (e.g., "s_m4x7enmven8djfqak")
`format`	string	否	Output format: "json", "ndjson", "jsonl", or "csv". Defaults to "json"
`compress`	boolean	否	Whether to compress the results

输出

参数	类型	描述
`data`	array	Array of scraped result records
`format`	string	The content type of the downloaded data
`snapshotId`	string	The snapshot ID that was downloaded

`brightdata_cancel_snapshot`

Cancel an active Bright Data scraping job using its snapshot ID. Terminates data collection in progress.

输入

参数	类型	必填	描述
`apiKey`	string	是	Bright Data API token
`snapshotId`	string	是	The snapshot ID of the collection to cancel (e.g., "s_m4x7enmven8djfqak")

输出

参数	类型	描述
`snapshotId`	string	The snapshot ID that was cancelled
`cancelled`	boolean	Whether the cancellation was successful

Bright Data

On this page