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

# Hyperbrowser plugin

> Fast cloud browsers for AI agents, web scraping, multi-page crawling, searching, and structured data extraction.

Use **Hyperbrowser** through Corsair: one client, typed API calls.

Hyperbrowser provides managed cloud browser sessions and web automation APIs. Authenticate requests using an API key passed in the `x-api-key` header. Get an API key from the Hyperbrowser dashboard at [https://app.hyperbrowser.ai/](https://app.hyperbrowser.ai/).

Key features:

* **Browser Sessions**: Launch headless or headed browser sessions with Playwright, Puppeteer, stealth anti-bot protection, residential proxies, and automatic CAPTCHA solving.
* **Persistent Profiles**: Maintain persistent browser cookies, local storage, and authentication state across multiple browser sessions.
* **Web Scraping & Extraction**: Asynchronous jobs for scraping single pages, batch scraping URL sets, multi-page web crawling, and extracting structured data with AI.
* **Web Search & Fetch**: Fetch rendered web pages in markdown, HTML, or screenshot formats, and search the web with clean structured results.

Credit consumption: Operations that launch browser sessions, trigger CAPTCHA evaluations, or start scrape/crawl/extract jobs consume compute credits according to your Hyperbrowser plan.

**What you get:**

* 31 typed API operations

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/hyperbrowser better-sqlite3
npm install --save-dev @types/better-sqlite3
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/hyperbrowser better-sqlite3
yarn add --dev @types/better-sqlite3
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/hyperbrowser better-sqlite3
pnpm install --save-dev @types/better-sqlite3
```

```bash bun theme={null}
bun add corsair @corsair-dev/hyperbrowser better-sqlite3
bun add --dev @types/better-sqlite3
```

**2. Add the plugin**

```ts corsair.ts theme={null}
import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { hyperbrowser } from '@corsair-dev/hyperbrowser';

export const corsair = createCorsair({
	plugins: [
		hyperbrowser(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});
```

With `multiTenancy: true`, scope calls with `corsair.withTenant(id)`. See [Quick start](https://docs.corsair.dev/quick-start.md) for KEK + Hub keys, and [Multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md) for account isolation.

**3. Choose authentication**

> [tab] API Key (Recommended)
>
> Store the Hyperbrowser API key before the first call: `pnpm corsair setup --plugin=hyperbrowser --tenant=acme api_key=<your-key>` (leave out `--tenant` without `multiTenancy`), or pass it as `key` in the plugin options. With Hub, each tenant enters their own key on the connect page. See [API key auth](https://docs.corsair.dev/concepts/api-key).
>
> ```ts theme={null}
> hyperbrowser()
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

**4. Connect a tenant**

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see [Connect / OAuth](https://docs.corsair.dev/management/connect).

```ts theme={null}
const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'hyperbrowser',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**List browser profiles**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.hyperbrowser.api.profiles.list({});
```

**Search the web**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.hyperbrowser.api.web.search({ query: 'Hyperbrowser documentation' });
```

See the full list on the [API](https://docs.corsair.dev/plugins/hyperbrowser/api.md) page.

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/hyperbrowser/api.md)
>
> Every `hyperbrowser.api.*` operation with input and output types.

> [card] [Connect / OAuth](https://docs.corsair.dev/management/connect)
>
> createLink, Hub delivery, and tenant connect flows.

> [card] [Use with agents](https://docs.corsair.dev/mcp-adapters/mcp-adapters)
>
> Expose this plugin's operations as MCP tools.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.