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

# Browserbase

> Create and manage headless browser sessions in the cloud with Browserbase

## At a glance

* **Availability**: Experimental ([how to enable](/cloud/integrations)).
* **Auth**: API key.
* **Connection**: The key from `BROWSERBASE_API_KEY` is sent as the `X-BB-API-Key` header.
* **Docs**: [https://docs.browserbase.com/reference/api/create-a-session](https://docs.browserbase.com/reference/api/create-a-session)

## Credentials

Set these per environment. See [Connect an integration](/cloud/integrations).

| Variable              | Required | Description                                                                                               |
| --------------------- | -------- | --------------------------------------------------------------------------------------------------------- |
| `BROWSERBASE_API_KEY` | Yes      | Browserbase API key (starts with bb\_) [Docs](https://docs.browserbase.com/introduction/getting-started). |

## Setup

1. **Create a Browserbase account**: Sign up at [https://www.browserbase.com](https://www.browserbase.com) - the free plan includes browser hours for testing.
2. **Copy your API key and project ID**: In the dashboard, open Settings to find your API key (bb\_...) and your default project ID. Each key belongs to a project.
3. **Store the key**: Add it to your .env file as BROWSERBASE\_API\_KEY=bb\_.... - requests authenticate with the X-BB-API-Key header.
4. **Verify access**: Run the List Projects tool, then List Sessions. Create Session can omit projectId - it is inferred from the API key.

* Sessions are billed by browser minutes - release sessions you are done with via the Release Session tool
* Driving the browser (navigation, clicks) happens over the session's CDP connectUrl with Playwright/Puppeteer/Stagehand, not through this REST API
* keepAlive sessions are only available on paid plans

Provider API reference: [https://docs.browserbase.com/reference/api/create-a-session](https://docs.browserbase.com/reference/api/create-a-session)

## Tools

| Tool            | Access | Description                                                        |
| --------------- | ------ | ------------------------------------------------------------------ |
| List Sessions   | Read   | List browser sessions, optionally filtered by status               |
| Create Session  | Write  | Create a new cloud browser session (consumes plan browser minutes) |
| Get Session     | Read   | Get a session's status, connection URL, and metadata               |
| Release Session | Write  | Request release of a running session to stop billing for it        |
| List Projects   | Read   | List the Browserbase projects available to the API key             |

## Example prompts

* List my Browserbase sessions that are currently RUNNING and release any I no longer need.
* Create a new Browserbase session and give me its ID and connection details.