Terminal
Terminal/Skill
Reference docs for the Browser Use Cloud API and SDKs, covering sessions, profiles, proxies, webhooks and integration patterns.
By Browser Use
Works with
npx skills add browser-use/browser-use --skill cloudReference docs for the Cloud REST API, SDKs, and integration patterns. Read the relevant file based on what the user needs.
runs resource in references/api-v4.md.browsers resource or REST/CDP, then explicitly stop the browser.browser-use skill, 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.
| 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 |
| 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 |
https://api.browser-use.com/api/v2/ (v2), https://api.browser-use.com/api/v3 (v3), or https://api.browser-use.com/api/v4 (v4)X-Browser-Use-API-Key: <key>BROWSER_USE_API_KEY=<key>uv pip install browser-use-sdk (Python) or npm install browser-use-sdk (TypeScript)from browser_use_sdk import AsyncBrowserUsefrom browser_use_sdk.v3 import AsyncBrowserUsefrom browser_use_sdk.v4 import BrowserUse or AsyncBrowserUseimport { BrowserUse } from "browser-use-sdk"import { BrowserUse } from "browser-use-sdk/v3"import { BrowserUse } from "browser-use-sdk/v4"browsers.create and browsers.stop in the v4 namespace, alongside the v4 REST /browsers resource. Always stop a browser explicitly; closing CDP does not stop billing.wss://connect.browser-use.com?apiKey=KEY&proxyCountryCode=us