> ## Documentation Index
> Fetch the complete documentation index at: https://browseruse-0aece648-codex-docs-supported-exports.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
> ## Agent Instructions
> 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; V2 is the lower-cost option for simple tasks. Keep V3 examples explicitly versioned. The open-source browser-use library and hosted browser-use-sdk have different APIs.
> 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 / $200 / $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.
> Budget polling across the project: the standard general bucket is 25 requests/second, including V4 event reads and full run reads. Selected status reads have a separate higher bucket. Use bounded workers, stagger polls, respect Retry-After, and drain hasMore event pages after terminal status. A busy V4 session returns 409; its queue holds 10 pending messages and is not a project-wide batch queue.
> A completed run or closed CDP connection does not immediately stop its cloud 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.
# Proxies
> Configure residential or custom proxies for API V4 browsers and agent runs.
A US residential proxy is enabled by default. The browser's traffic passes
through that residential IP before reaching the website, so the website sees
the proxy's location—not your server's.
Set `browser_settings` / `browserSettings` when you create a V4 run to choose
another country:
The current TypeScript SDK type requires `proxyCountryCode` whenever
`browserSettings` is present. Use `"us"` to keep the default, or `null` to
disable the managed proxy.
```python Python theme={null}
from browser_use_sdk.v4 import BrowserUse
client = BrowserUse()
run = client.runs.create(
"Get the iPhone 16 price on amazon.de",
browser_settings={"proxyCountryCode": "de"},
)
```
```typescript TypeScript theme={null}
import { BrowserUse } from "browser-use-sdk/v4";
const client = new BrowserUse();
const run = await client.runs.create({
task: "Get the iPhone 16 price on amazon.de",
model: "grok-4.5",
browserSettings: { proxyCountryCode: "de" },
});
```
```bash curl theme={null}
curl https://api.browser-use.com/api/v4/runs \
-H "X-Browser-Use-API-Key: $BROWSER_USE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"task":"Get the iPhone 16 price on amazon.de",
"browserSettings":{"proxyCountryCode":"de"}}'
```
## Disable proxies
Pass `null` for QA or internal sites that do not need a residential proxy:
```python Python theme={null}
run = client.runs.create(
"Test my staging site",
browser_settings={"proxyCountryCode": None},
)
```
```typescript TypeScript theme={null}
const run = await client.runs.create({
task: "Test my staging site",
model: "grok-4.5",
browserSettings: { proxyCountryCode: null },
});
```
## Custom proxy
Custom proxies are available to all accounts, including free and pay-as-you-go
accounts. No subscription is required. Normal credit, spend, and concurrency
limits still apply.
The request format depends on what you are creating:
| REST endpoint | Custom proxy field |
| ----------------------- | ----------------------------- |
| `POST /api/v4/browsers` | Top-level `customProxy` |
| `POST /api/v4/runs` | `browserSettings.customProxy` |
`browser_settings` is the Python SDK keyword for agent runs. In REST JSON,
the agent-run field is `browserSettings`.
### Standalone browsers
For a browser you control with Playwright, Puppeteer, or another CDP client,
put `customProxy` directly in the request body:
```bash curl theme={null}
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 '{
"customProxy": {
"host": "proxy.example.com",
"port": 8080,
"username": "YOUR_PROXY_USERNAME",
"password": "YOUR_PROXY_PASSWORD"
}
}'
```
Replace the proxy details with yours. Omit both `username` and `password` if
your proxy does not require authentication. Do not wrap these settings in
`browserSettings` or `browser_settings` on `/api/v4/browsers`.
Keep the returned browser ID and stop the browser with
`PATCH /api/v4/browsers/{id}` and `{"action":"stop"}` when finished. See the
[Create browser reference](/cloud/api-v4/browsers/create-browser-session) and
[Browser quickstart](/cloud/browser/quickstart).
### Agent runs
For a hosted agent, pass the proxy in the run's browser settings:
```python Python theme={null}
run = client.runs.create(
"Check the account dashboard",
browser_settings={
"customProxy": {
"host": "proxy.example.com",
"port": 8080,
"username": "user",
"password": "pass",
"ignoreCertErrors": False,
}
},
)
```
```typescript TypeScript theme={null}
const run = await client.runs.create({
task: "Check the account dashboard",
model: "grok-4.5",
browserSettings: {
proxyCountryCode: "us",
customProxy: {
host: "proxy.example.com",
port: 8080,
username: "user",
password: "pass",
ignoreCertErrors: false,
},
},
});
```
A custom proxy overrides `proxyCountryCode` and must be passed again when a
follow-up provisions a new browser. See the [Create run
reference](/cloud/api-v4/runs/create-run) for the complete settings object.