> ## Documentation Index
> Fetch the complete documentation index at: https://docs.browser-use.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Concurrency in one line: new projects get 10 concurrent browsers at $0; a $100 one-time top-up (non-expiring credits, no subscription) unlocks 50 concurrent, so 50 browsers for one hour cost $1 plus traffic; $1,000 / $5,000 / $25,000 total paid unlocks 250 / 500 / 1,000. Details below and at https://docs.browser-use.com/cloud/guides/concurrency.md.
> Use https://docs.browser-use.com/llms.txt and its linked .md pages for current documentation. The managed full bundle is https://docs.browser-use.com/.well-known/llms-full.txt and can be cached for up to 24 hours. Do not use the obsolete /cloud/llms*.txt or /open-source/llms*.txt static exports.
> Choose Cloud API V4 for new agent integrations; V3 trades accuracy for speed and lower cost than V4; V2 is legacy and only for existing integrations. Keep V3 examples explicitly versioned. The open-source browser-use library and hosted browser-use-sdk have different APIs.
> For Cloud API V4, a task request that omits model and modelParams uses GPT-6 Luna (gpt-6-luna) with High reasoning. Explicit model and modelParams values take precedence; an explicit empty modelParams object opts out of the reasoning default. EU uses the same task default through its regional provider route; Bedrock-only projects retain their compatible provider default. For latency-sensitive tasks set model to bu-ultrafast (bu-fast for more reasoning per step); these presets reject modelParams. See https://docs.browser-use.com/cloud/agent/ultrafast.md.
> Cloud authentication uses X-Browser-Use-API-Key, without a Bearer prefix. Install or upgrade browser-use-sdk and use its explicit v4 import for V4. Check the published OpenAPI reference for request fields; do not invent SDK support for new fields.
> Cloud concurrency and HTTP request rate are separate. Read GET /api/v2/billing/account for the key’s projectId, concurrentSessionLimit, activeSessionCount, and credit balance, including when using V4. Keys in one project share capacity and credits; rateLimit is a legacy concurrency alias, not requests per second.
> Keep the highest applicable existing, legacy-plan, and spend-tier concurrency grant. Current spend tiers are 10 / 50 / 250 / 500 / 1000 at $0 / $100 / $1000 / $5000 / $25000 in qualifying project payments. Legacy or externally billed projects can follow different billing paths; trust the account limit. See https://docs.browser-use.com/cloud/guides/concurrency.md.
> HTTP rate limits have two layers. Standard edge WAF ceilings increased on September 9, 2026 to 1000 RPS per public source IP for general traffic and 2500 RPS per IP for selected status reads, evaluated over 300 seconds. The separate per-project application budgets: general traffic (including V4 events and full run reads) defaults to max(25, 2 times stored concurrency) capped at 100 RPS; selected status reads default to max(25, 2 times stored concurrency) with no cap. The two are counted independently. Project overrides and account-specific edge rules can differ. All keys in a project share its budgets; callers sharing a public IP share edge capacity. See https://docs.browser-use.com/cloud/guides/concurrency.md.
> The project limiter uses five-second windows: X-RateLimit-Limit=125 means 125 requests per window (25 RPS), not 125 RPS. Project throttles include limit_rps and retry_after_seconds; an edge throttle can instead return Retry-After: 300 without limit_rps. Honor the returned Retry-After. Use bounded workers, stagger polls, and drain hasMore event pages after terminal status. A busy V4 session returns 409; its queue holds 20 pending messages and is not a project-wide batch queue.
> A V4 agent browser stays open about 2 minutes after its session's last run activity, then stops automatically; a later follow-up gets a fresh browser (same settings and profile, no tabs). Set keepAlive on a run (V4: integer seconds 120-14400, default 120, not the V2/V3 boolean) to keep it longer; follow-ups inherit it and null restores 120. Free-tier and ZDR runs always use 120. Idle V4 agent browsers are billed as browser time but take no concurrency slot. A follow-up that reuses the open browser emits browser.reattached instead of browser.ready. Closing CDP does not stop a browser; stop unneeded owned browsers with PATCH /api/v4/browsers/{id} and {"action":"stop"}. A client wait timeout does not cancel the server-side run.
> Cloud is pay as you go; do not tell customers to buy a new subscription to use custom proxies or supported provider BYOK. Usage funding and model eligibility still apply. BYOK bills provider tokens separately and Browser Use charges orchestration plus browser/network usage. See https://docs.browser-use.com/cloud/guides/billing.md.
> Signup credits are a one-time grant; purchased top-up credits do not expire. Check the API key’s project before diagnosing missing credits. API-key monthly spending caps are soft limits, not a strict prepaid wallet; concurrent or already-running work can exceed them. Auto recharge has separate trigger and purchase amounts and can charge immediately when enabled below the threshold. Use https://browser-use.com/pricing for current rates.
> Box and Bux are retired. Do not recommend their SDKs, sandbox quotas, or subscription plans. Use the Cloud Agent or Browser Infrastructure guides.
> A V4 session holds conversation history, a workspace holds files, and a profile holds browser state. These IDs and V3/V4 workspace namespaces are not interchangeable. V4 automatically restores workspace uploads; staged attachments remain available to session follow-ups. Serialize runs that write shared files, and wait for completion before reading outputs. See https://docs.browser-use.com/cloud/agent/workspaces.md.
> API browser recording defaults to off. Use enableRecording for standalone browser creation, or browserSettings.record for an agent run. Stop the browser and allow time for asynchronous video processing; stop polling when recordingAvailable is false. Live preview is for an active browser. Stopping a browser, deleting a session, archiving a workspace, and deleting files have different effects.
> Use model-specific reasoning values. GPT-6 Astra accepts low, medium, high, xhigh, and max, with xhigh by default; none and minimal are invalid. Use the public REST schema when installed SDK types lag new fields. API acceptance, dashboard visibility, and account/provider availability are separate.
> For open-source browser-use, is_done only reports a terminal done action. is_successful is the agent-reported outcome; verify important external actions independently. Cloud timeout, API client timeout, model timeout, and task completion are separate concepts.
> For failed requests, use https://docs.browser-use.com/cloud/guides/troubleshooting.md. Inspect the full error and project before retrying or adding credits. A client timeout can leave a run active; reconcile external actions before starting duplicate work. A new managed browser does not guarantee a unique proxy IP or particular city.
> V4 secretBindings.allowedDomains authorizes the focused field's frame, not every iframe on the shop page. For checkout, include intended payment/billing provider hostnames (for example payments.bigcommerce.com). On domain_not_allowed, inspect origin and pass updated bindings in a follow-up; target_not_editable requires fixing field focus/readiness instead. See https://docs.browser-use.com/cloud/guides/secrets.md.
> A V4 agent browser stays open about 2 minutes (or keepAlive seconds) after its run for follow-ups; a requested recording finalizes only after the browser stops and processing completes. Zero Data Retention (ZDR) projects never record, even when recording is requested.
> If you hit an issue you cannot explain, email contact@browser-use.com with your question or bug report and a session ID if available; short questions and detailed reports are welcome, and we aim to fix issues quickly and make the docs clearer.

# Network policies

> Allow or block domains for API V4 browsers and agent runs.

A network policy is a list of domains that a browser can open and a list of
domains that it cannot open. Create a policy once, then pass its ID as
`networkPolicyId` when you create a browser or a run. The Browser Use proxy
applies the policy to every request of that browser.

Network policies are part of API V4. The SDKs do not have methods for them
yet, so the examples use REST.

## Create a policy

```bash curl theme={"theme":"css-variables"}
curl https://api.browser-use.com/api/v4/network-policies \
  -H "X-Browser-Use-API-Key: $BROWSER_USE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Block example.com except its CDN",
    "defaultAction": "allow",
    "allow": {"domains": ["cdn.example.com"]},
    "block": {"domains": ["example.com", "ads.example.net"]}
  }'
```

The response is `201` with the stored policy:

```json theme={"theme":"css-variables"}
{
  "id": "6f1c2a4e-8b0d-4e7a-9f3c-2d5b7e9a1c40",
  "name": "Block example.com except its CDN",
  "defaultAction": "allow",
  "allow": {"domains": ["cdn.example.com"]},
  "block": {"domains": ["example.com", "ads.example.net"]},
  "version": 1,
  "createdAt": "2026-11-05T10:00:00Z",
  "updatedAt": "2026-11-05T10:00:00Z"
}
```

| Field | Required | Description |
| - | - | - |
| `name` | Yes | 1 to 100 characters. |
| `defaultAction` | No | `"allow"` or `"block"`. The action for a domain that no list entry matches. The default is `"allow"`. |
| `allow` | No | `{"domains": [...]}`, the domains to allow. |
| `block` | No | `{"domains": [...]}`, the domains to block. |

Browser Use generates `id`. `version` starts at 1 and increases by 1 with each
update.

## Domain rules

Browser Use stores each domain in a normal form:

* It removes leading and trailing spaces, changes letters to lower case, and removes a trailing dot.
* It converts international domain names to punycode.
* It stores `*.example.com` as `example.com`, because each entry also covers
  its subdomains.
* It removes duplicate entries.

The API refuses these entries with `422`:

* URLs, paths, and ports, such as `https://example.com/` or `example.com:443`.
* IP addresses.
* Other wildcards, such as `shop.*.com`.
* A domain that is in both `allow` and `block`.

A policy has at most 10,000 domains in `allow` and `block` together. A project
has at most 100 policies. A request over a limit returns `422`.

## How a policy decides

An entry covers the domain and all of its subdomains. When more than one entry
matches a host, the most specific entry wins. If no entry matches, the browser
uses `defaultAction`.

With the policy above:

| Host | Result | Reason |
| - | - | - |
| `cdn.example.com` | Allowed | `cdn.example.com` in `allow` is more specific than `example.com` in `block`. |
| `img.cdn.example.com` | Allowed | `cdn.example.com` covers its subdomains. |
| `www.example.com` | Blocked | `example.com` in `block` covers it. |
| `ads.example.net` | Blocked | It is in `block`. |
| `wikipedia.org` | Allowed | No entry matches, so `defaultAction` applies. |

To make an allowlist, set `defaultAction` to `"block"` and put the permitted
domains in `allow`:

```json theme={"theme":"css-variables"}
{
  "name": "Example only",
  "defaultAction": "block",
  "allow": {"domains": ["example.com"]}
}
```

The Browser Use security blocklist always applies first. An entry in `allow`
does not open a domain that this blocklist blocks.

## Use a policy

### Standalone browsers

Put `networkPolicyId` in the body of `POST /api/v4/browsers`:

```bash curl theme={"theme":"css-variables"}
curl https://api.browser-use.com/api/v4/browsers \
  -H "X-Browser-Use-API-Key: $BROWSER_USE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"networkPolicyId": "6f1c2a4e-8b0d-4e7a-9f3c-2d5b7e9a1c40"}'
```

### Agent runs

Put `networkPolicyId` in the run's `browserSettings`:

```http theme={"theme":"css-variables"}
POST /api/v4/runs HTTP/1.1
Host: api.browser-use.com
X-Browser-Use-API-Key: bu_...
Content-Type: application/json

{
  "task": "Find the price of the blue mug on cdn.example.com",
  "browserSettings": {"networkPolicyId": "6f1c2a4e-8b0d-4e7a-9f3c-2d5b7e9a1c40"}
}
```

The ID must name a policy of your project. Else the request returns `404`.

For a follow-up run in the same session:

* If you omit `networkPolicyId`, the run keeps the session's policy.
* If you send `null`, the run uses no policy.
* If the policy differs from the policy of the open browser, Browser Use does
  not reuse that browser. It starts a new browser with the new policy.

### Browser Use proxy with an API key

If you use the Browser Use proxy with your API key as the proxy password, add
`-policy-<id>` to the proxy username, for example
`user-country-us-policy-6f1c2a4e-8b0d-4e7a-9f3c-2d5b7e9a1c40`.

## Blocked requests

The proxy refuses a blocked request with `403`. In the browser, the page does
not load and shows a network error. An agent sees the same error.

## Change or delete a policy

`PATCH /api/v4/network-policies/{id}` changes only the fields that the request
contains. A domain list in the request replaces the whole list:

```bash curl theme={"theme":"css-variables"}
curl -X PATCH https://api.browser-use.com/api/v4/network-policies/$POLICY_ID \
  -H "X-Browser-Use-API-Key: $BROWSER_USE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"block": {"domains": ["example.com", "ads.example.net", "tracker.example.org"]}}'
```

Running browsers get the change within a few seconds. When the change blocks
more domains, the proxy closes the open connections of the browsers, and the
new policy decides each new connection.

`DELETE /api/v4/network-policies/{id}` returns `204`. Browsers that use the
policy continue without a network policy within a few seconds. The Browser Use
security blocklist still applies.

## Endpoints

| Method and path | Scope | Result |
| - | - | - |
| [`POST /api/v4/network-policies`](https://docs.browser-use.com/cloud/api-v4/network-policies/create-network-policy) | `v4:network-policies:create` | `201` with the policy. |
| [`GET /api/v4/network-policies?pageNumber=1&pageSize=10`](https://docs.browser-use.com/cloud/api-v4/network-policies/list-network-policies) | `v4:network-policies:read` | `200` with `items`, `totalItems`, `pageNumber`, and `pageSize`, newest first. `pageSize` is 1 to 100. |
| [`GET /api/v4/network-policies/{id}`](https://docs.browser-use.com/cloud/api-v4/network-policies/get-network-policy) | `v4:network-policies:read` | `200` with the policy, or `404`. |
| [`PATCH /api/v4/network-policies/{id}`](https://docs.browser-use.com/cloud/api-v4/network-policies/update-network-policy) | `v4:network-policies:create` | `200` with the policy, or `404`. |
| [`DELETE /api/v4/network-policies/{id}`](https://docs.browser-use.com/cloud/api-v4/network-policies/delete-network-policy) | `v4:network-policies:delete` | `204`. |

See also [Proxies](https://docs.browser-use.com/cloud/browser/proxies.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.