> ## 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.

# Quick start

> Run a hosted agent or launch a cloud browser.

<CardGroup cols={2}>
  <Card title="Browser Use Agents" icon="robot" href="/cloud/agent/quickstart">
    Give an agent a task and get the result.
  </Card>

  <Card title="Browser Infrastructure" icon="globe" href="/cloud/browser/quickstart">
    Launch a cloud browser and connect to it from your code.
  </Card>
</CardGroup>

Both Cloud paths use API V4. Choose whether Browser Use drives the browser or
your Playwright/Puppeteer code connects directly over CDP. For a local agent,
use the [open-source library](/open-source/quickstart).

Get an [API key](https://cloud.browser-use.com/settings?tab=api-keys\&new=1) and
export it:

```bash theme={null}
export BROWSER_USE_API_KEY=your_key
```

## Install the SDK

Skip this step if you use curl.

<CodeGroup>
  ```bash Python theme={null}
  pip install --upgrade browser-use-sdk playwright
  ```

  ```bash TypeScript theme={null}
  npm install browser-use-sdk@latest puppeteer-core
  ```
</CodeGroup>

## Run Browser Use Agents

<CodeGroup>
  ```python Python theme={null}
  from browser_use_sdk.v4 import BrowserUse

  with BrowserUse() as client:
      run = client.runs.create("Find the top Hacker News story")
      result = client.runs.wait_for_completion(run.id)
      print(result.result)
  ```

  ```typescript TypeScript theme={null}
  import { BrowserUse } from "browser-use-sdk/v4";

  const client = new BrowserUse();
  const run = await client.runs.create({
    task: "Find the top Hacker News story",
  });
  const result = await client.runs.waitForCompletion(run.id);
  console.log(result.result);
  ```

  ```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":"Find the top Hacker News story"}'
  ```
</CodeGroup>

## Use Browser Infrastructure

Launch a browser, connect to its CDP URL, then stop it:

<CodeGroup>
  ```python Python theme={null}
  from browser_use_sdk.v4 import BrowserUse
  from playwright.sync_api import sync_playwright

  client = BrowserUse()
  browser = client.browsers.create(proxy_country_code="us")
  print(browser.cdp_url)

  with sync_playwright() as p:
      chrome = p.chromium.connect_over_cdp(browser.cdp_url)
      page = chrome.new_page()
      page.goto("https://example.com")
      print(page.title())

  # When finished:
  client.browsers.stop(browser.id)
  ```

  ```typescript TypeScript theme={null}
  import { BrowserUse } from "browser-use-sdk/v4";
  import puppeteer from "puppeteer-core";

  const client = new BrowserUse();
  const browser = await client.browsers.create({ proxyCountryCode: "us" });
  console.log(browser.cdpUrl);

  const chrome = await puppeteer.connect({
    browserWSEndpoint: browser.cdpUrl,
  });
  const page = await chrome.newPage();
  await page.goto("https://example.com");
  console.log(await page.title());

  // When finished:
  await client.browsers.stop(browser.id);
  ```

  ```bash curl theme={null}
  browser=$(curl -sS https://api.browser-use.com/api/v4/browsers \
    -H "X-Browser-Use-API-Key: $BROWSER_USE_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{"proxyCountryCode":"us"}')

  export BROWSER_SESSION_ID=$(echo "$browser" | jq -r .id)
  export BROWSER_USE_CDP_URL=$(echo "$browser" | jq -r .cdpUrl)

  # Connect Playwright or Puppeteer to $BROWSER_USE_CDP_URL, then stop:
  curl -X PATCH \
    "https://api.browser-use.com/api/v4/browsers/$BROWSER_SESSION_ID" \
    -H "X-Browser-Use-API-Key: $BROWSER_USE_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{"action":"stop"}'
  ```
</CodeGroup>

<Warning>
  Closing Playwright, Puppeteer, or CDP does not stop the browser. Use
  `client.browsers.stop(browser.id)` or call `PATCH /api/v4/browsers/{id}` with
  `{"action":"stop"}`.
</Warning>

<Card title="Copy for an LLM" icon="sparkles" href="https://docs.browser-use.com/llms.txt">
  Give your coding agent the compact API V4 context.
</Card>