Browser Use Cloud Reference
Reference docs for the Cloud REST API, SDKs, and integration patterns. Read the relevant file based on what the user needs.
Choose a starter
- Hosted task in, result out: use the V4 SDK
runsresource inreferences/api-v4.md. - Your existing agent needs a browser: use the V4 SDK
browsersresource or REST/CDP, then explicitly stop the browser. - Local framework development: use the open-source
browser-useskill, not Cloud SDK calls.
Eligible new Google, GitHub or Microsoft signups get a one-time $15 Cloud credit. No card required; email/password signups do not qualify. Pricing and eligibility. Use gpt-5.6-luna for the free starter; paid-only models need a top-up.
Reuse BROWSER_USE_API_KEY, or guide the user through Cloud signup and key creation. Keep keys server-side, never in prompts or client bundles.
API & Platform
| Topic | Read |
|---|---|
| Current v4 setup, first run, sessions, workspaces, browsers | references/api-v4.md |
| Legacy v2 setup, pricing, FAQ | references/quickstart.md |
| v2 REST API: all 30 endpoints, cURL examples, schemas | references/api-v2.md |
| v3 BU Agent API: sessions, messages, files, workspaces | references/api-v3.md |
| Sessions, profiles, auth strategies, 1Password | references/sessions.md |
| CDP direct access, Playwright/Puppeteer/Selenium | references/browser-api.md |
| Proxies, webhooks, workspaces, skills, MCP, live view | references/features.md |
| Parallel, streaming, geo-scraping, tutorials | references/patterns.md |
Integration Guides
| Topic | Read |
|---|---|
| Building a chat interface with live browser view | references/guides/chat-ui.md |
| Using browser-use as a subagent (task in → result out) | references/guides/subagent.md |
| Adding browser-use tools to an existing agent | references/guides/tools-integration.md |
Critical Notes
- Use v4 for new hosted-agent integrations. Keep v2 or v3 only when maintaining an existing integration or using a resource not yet wrapped by the v4 SDK.
- Cloud API base URL:
https://api.browser-use.com/api/v2/(v2),https://api.browser-use.com/api/v3(v3), orhttps://api.browser-use.com/api/v4(v4) - Auth header:
X-Browser-Use-API-Key: <key> - Get API key: https://cloud.browser-use.com/new-api-key
- Set env var:
BROWSER_USE_API_KEY=<key> - Cloud SDK:
uv pip install browser-use-sdk(Python) ornpm install browser-use-sdk(TypeScript) - Python v2:
from browser_use_sdk import AsyncBrowserUse - Python v3:
from browser_use_sdk.v3 import AsyncBrowserUse - Python v4:
from browser_use_sdk.v4 import BrowserUseorAsyncBrowserUse - TypeScript v2:
import { BrowserUse } from "browser-use-sdk" - TypeScript v3:
import { BrowserUse } from "browser-use-sdk/v3" - TypeScript v4:
import { BrowserUse } from "browser-use-sdk/v4" - SDK 3.11.3 or newer exposes
browsers.createandbrowsers.stopin the v4 namespace, alongside the v4 REST/browsersresource. Always stop a browser explicitly; closing CDP does not stop billing. - CDP WebSocket:
wss://connect.browser-use.com?apiKey=KEY&proxyCountryCode=us