Hyperbrowser plugin

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

Install

npm install corsair @corsair-dev/hyperbrowser better-sqlite3
npm install --save-dev @types/better-sqlite3

yarn add corsair @corsair-dev/hyperbrowser better-sqlite3
yarn add --dev @types/better-sqlite3

pnpm install corsair @corsair-dev/hyperbrowser better-sqlite3
pnpm install --save-dev @types/better-sqlite3

bun add corsair @corsair-dev/hyperbrowser better-sqlite3
bun add --dev @types/better-sqlite3

Add the plugin

corsair.ts

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 for KEK + Hub keys, and Multi-tenancy for account isolation.

Choose authentication

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.

hyperbrowser()

More: API Key

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.

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

Example API calls

List browser profiles

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

Search the web

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

See the full list on the API page.

What’s next

API reference

Every hyperbrowser.api.* operation with input and output types.

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.

Overview

Plugins