Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

Bright Data (BYOK) — connector documentation

  • MCP endpoint: https://byok-brightdata.connectorbay.com/mcp
  • REST API: POST https://byok-brightdata.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-brightdata.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own Bright Data Bright Data API key, sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-brightdata.connectorbay.com/health · Tool schemas: https://byok-brightdata.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-brightdata · agent@connectorbay.com

What Bright Data (BYOK) is for

Bright Data (BYOK) lets an AI assistant read your own Bright Data data through the Bright Data API with a key you supply (Bright Data API key). Read-only: 12 tools (get_account_status, get_balance, list_pricing_plans, list_active_zones, list_all_zones, get_zone, get_zone_bandwidth, get_zone_cost, get_account_bandwidth, list_available_countries, list_country_cities, get_network_status). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to api.brightdata.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Bright Data. Bright Data and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Is my Bright Data API key working?"
  • "What is my Bright Data balance?"
  • "Which pricing plan am I on at Bright Data?"
  • "Which active zones do I have at Bright Data?"
  • "Show every Bright Data zone I ever created"
  • "Show the settings of Bright Data zone my_unlocker_zone"

What it does

  • get_account_status: Show whether the key is valid and the account can make requests, with the customer id and the caller's IP address.
  • get_balance: Show the account balance, credit, prepayment and pending costs.
  • list_pricing_plans: List Bright Data pricing plans, marking the current one, with pre-commit amount and per-product prices.
  • list_active_zones: List the account's active zones (a zone is one product configuration such as Web Unlocker or SERP) with name and type.
  • list_all_zones: List all zones including deleted ones, with name, type and status (active or deleted).
  • get_zone: Get the configuration details of one zone by name.
  • get_zone_bandwidth: Get bandwidth used by one zone, optionally between two dates.
  • get_zone_cost: Get the cost and bandwidth of one zone for a date range (end date excluded, format YYYY-MM-DD).
  • get_account_bandwidth: Get the bandwidth used by the whole account, optionally between two dates.
  • list_available_countries: List the country codes available per zone type (datacenter and ISP, shared or dedicated).
  • list_country_cities: List the cities available in one country (2-letter country code) for the network.
  • get_network_status: Show the current status of the Bright Data proxy networks: all, residential, datacenter or mobile.

BYOK key

You bring your own Bright Data Bright Data API key (https://brightdata.com/cp/setting/users). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to api.brightdata.com over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the Bright Data API (api.brightdata.com) with a BYOK key; documentation: https://docs.brightdata.com/api-reference/authentication. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Bright Data. Bright Data and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your Bright Data account.

Built for: Worldwide. Languages: English.