Bright Data

Usage Instructions

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.

Tools

`brightdata_scrape_url`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`zone`	string	Yes	No description
`url`	string	Yes	No description
`format`	string	No	No description
`country`	string	No	No description

Output

Parameter	Type	Description
`content`	string	content output from the tool
`url`	string	url output from the tool
`statusCode`	number	statusCode output from the tool

`brightdata_serp_search`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`zone`	string	Yes	No description
`query`	string	Yes	No description
`searchEngine`	string	No	No description
`country`	string	No	No description
`language`	string	No	No description
`numResults`	number	No	No description

Output

Parameter	Type	Description
`results`	array	results output from the tool
↳ `title`	string	title output from the tool
↳ `url`	string	url output from the tool
↳ `description`	string	description output from the tool
↳ `rank`	number	rank output from the tool
`query`	string	query output from the tool
`searchEngine`	string	searchEngine output from the tool

`brightdata_discover`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`query`	string	Yes	No description
`numResults`	number	No	No description
`intent`	string	No	No description
`includeContent`	boolean	No	No description
`format`	string	No	No description
`language`	string	No	No description
`country`	string	No	No description

Output

Parameter	Type	Description
`results`	array	results output from the tool
↳ `url`	string	url output from the tool
↳ `title`	string	title output from the tool
↳ `description`	string	description output from the tool
↳ `relevanceScore`	number	relevanceScore output from the tool
↳ `content`	string	content output from the tool
`query`	string	query output from the tool
`totalResults`	number	totalResults output from the tool

`brightdata_sync_scrape`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`datasetId`	string	Yes	No description
`urls`	string	Yes	No description
`format`	string	No	No description
`includeErrors`	boolean	No	No description

Output

Parameter	Type	Description
`data`	array	data output from the tool
`snapshotId`	string	snapshotId output from the tool
`isAsync`	boolean	isAsync output from the tool

`brightdata_scrape_dataset`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`datasetId`	string	Yes	No description
`urls`	string	Yes	No description
`format`	string	No	No description

Output

Parameter	Type	Description
`snapshotId`	string	snapshotId output from the tool
`status`	string	status output from the tool

`brightdata_snapshot_status`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`snapshotId`	string	Yes	No description

Output

Parameter	Type	Description
`snapshotId`	string	snapshotId output from the tool
`datasetId`	string	datasetId output from the tool
`status`	string	status output from the tool

`brightdata_download_snapshot`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`snapshotId`	string	Yes	No description
`format`	string	No	No description
`compress`	boolean	No	No description

Output

Parameter	Type	Description
`data`	array	data output from the tool
`format`	string	format output from the tool
`snapshotId`	string	snapshotId output from the tool

`brightdata_cancel_snapshot`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`snapshotId`	string	Yes	No description

Output

Parameter	Type	Description
`snapshotId`	string	snapshotId output from the tool
`cancelled`	boolean	cancelled output from the tool

Bright Data

On this page