Bright Data logo

Bright Data

Bright Data provides the world's #1 web data platform with Web Unlocker for bypassing anti-bot systems, SERP API for search engine data, and pre-made scrapers for popular websites. Collect any web data at scale.

23 actions Integration catalog
Request access
Connect Bright Data once you're in Boring.
01 · WHAT THE AGENT CAN DO

Actions

Every capability is a discrete, logged action the agent calls by name — scoped to what you authorize and recorded in the run trace.

Start Site CrawlBRIGHTDATA_CRAWL_API
Start an asynchronous dataset or site crawl. Poll the returned snapshot_id with BRIGHTDATA_GET_SNAPSHOT_STATUS, then download it with BRIGHTDATA_GET_SNAPSHOT_RESULTS.
Create Safe ZoneBRIGHTDATA_CREATE_SAFE_ZONE
Create a durable SERP API or Scraping Browser zone using a fixed safe plan. This Admin/Ops operation changes account infrastructure and may incur charges. If Bright Data returns HTTP 429, retry after the Retry-After delay when present.
List Marketplace DatasetsBRIGHTDATA_DATASET_LIST
List pre-built datasets in Bright Data's marketplace for structured scraping.
Filter DatasetBRIGHTDATA_FILTER_DATASET
Create a billable filtered marketplace-dataset snapshot. Use records_limit to cap the number of included records.
Get Customer BalanceBRIGHTDATA_GET_CUSTOMER_BALANCE
Get current and pending Bright Data account balances. This endpoint requires an API key with Admin permission. If HTTP 429 is returned, retry after the Retry-After delay when present.
Get Dataset MetadataBRIGHTDATA_GET_DATASET_METADATA
Retrieve field definitions for a Bright Data marketplace dataset.
Get Deep Lookup ResultsBRIGHTDATA_GET_DEEP_LOOKUP_RESULTS
Retrieve enriched records plus available progress, cost, and provider metadata for a completed Deep Lookup request. Each record preserves the lookup's dynamic columns. If the API returns HTTP 429, retry according to Retry-After when present rather than using a fixed request rate.
Get Deep Lookup StatusBRIGHTDATA_GET_DEEP_LOOKUP_STATUS
Check a Deep Lookup request's status, progress, cost, and provider metadata. Poll until completion before retrieving results. If the API returns HTTP 429, retry according to Retry-After when present rather than using a fixed request rate.
List Available CitiesBRIGHTDATA_GET_LIST_OF_AVAILABLE_CITIES
List static-network cities available for a country and proxy pool type.
List Available CountriesBRIGHTDATA_GET_LIST_OF_AVAILABLE_COUNTRIES
List country codes available for each static proxy zone type.
Get SERP ResultsBRIGHTDATA_GET_SERP_RESULTS
Retrieve JSON or raw results for an asynchronous BRIGHTDATA_SERP_SEARCH request. A 202 response means the job is still pending and should be retried later.
Download Snapshot ResultsBRIGHTDATA_GET_SNAPSHOT_RESULTS
Download a completed dataset snapshot. A pending response contains no result data; poll BRIGHTDATA_GET_SNAPSHOT_STATUS before retrying.
Check Snapshot StatusBRIGHTDATA_GET_SNAPSHOT_STATUS
Check whether a dataset snapshot is running, ready, or failed before downloading it.
Get Web Archive SearchBRIGHTDATA_GET_WEB_ARCHIVE_SEARCH
Get a Web Archive search's status and its matching-file, dump-size-in-bytes, and dump-cost-in-USD estimates. The search only estimates a dump and does not create a billable dump. Up to 100 searches that have not had a dump triggered are allowed per day.
Get Zone BandwidthBRIGHTDATA_GET_ZONE_BANDWIDTH
Get uploaded, downloaded, and total byte usage for one zone and date range. If HTTP 429 is returned, retry after the Retry-After delay when present.
Get Zone CostBRIGHTDATA_GET_ZONE_COST
Get invoice-aligned billed cost and bandwidth for one zone and date range. The `to_date` boundary is exclusive. If HTTP 429 is returned, retry after the Retry-After delay when present.
List Scraper Studio ScrapersBRIGHTDATA_LIST_SCRAPERS
List account-owned Scraper Studio scrapers and discover collector IDs.
List Unlocker ZonesBRIGHTDATA_LIST_WEB_UNLOCKER_ZONES
List configured Web Unlocker zones and their types for protected-URL scraping.
Scrape Data SynchronouslyBRIGHTDATA_SCRAPE_DATA_SYNC
Scrape up to 20 input objects synchronously. Bright Data bills per returned record. Requests exceeding the one-minute synchronous limit fall back to an asynchronous snapshot; use the returned snapshot ID after retry_after seconds. On HTTP 429, honor the provider's Retry-After header before retrying.
Search Web ArchiveBRIGHTDATA_SEARCH_WEB_ARCHIVE
Search Bright Data's Web Archive and estimate matching files, dump size in bytes, and dump cost in USD. A search that exceeds 30 seconds returns only a search_id; pass it to BRIGHTDATA_GET_WEB_ARCHIVE_SEARCH until complete. The search itself estimates a dump and does not create a billable dump. Up to 100 searches that have not had a dump triggered are allowed per day.
Search SERPBRIGHTDATA_SERP_SEARCH
Submit an asynchronous SERP search and return its response_id. Retrieve it with BRIGHTDATA_GET_SERP_RESULTS, selecting the same JSON or raw result format used here.
Start Deep LookupBRIGHTDATA_START_DEEP_LOOKUP
Start an asynchronous Deep Lookup research request and return its request_id. Billing is $1 per matched record; the first 10 enrichment columns are included, each additional enrichment column costs $0.05, and skipped or unmatched records are free. The API may return HTTP 429; retry according to Retry-After when present rather than using a fixed request rate.
Scrape Protected URLBRIGHTDATA_WEB_UNLOCKER
Scrape a public URL through Web Unlocker when ordinary requests are blocked or require JavaScript rendering. Inspect returned content before retrying CAPTCHA pages.