Cloudflare Browser Run plugin

Use Cloudflare Browser Run through Corsair: one client, typed API calls. This plugin exposes 24 REST operations: content.fetch, markdown.convert, snapshot.capture, accessibilityTree.capture, scrape.extract, json.extract, links.list, screenshot.capture, pdf.render, crawl.start, crawl.get, crawl.cancel, sessions.list, sessions.get, browser.create, browser.close, browser.version, browser.protocol, browser.liveView.create, targets.create, targets.list, targets.get, targets.activate, and targets.close. Quick Actions use the current /browser-run paths; DevTools use the generated API reference’s /browser-rendering/devtools paths. Screenshot/PDF bytes are returned as base64 JSON. Browser DevTools WebSocket/CDP transport, Workers Bindings, and inbound webhooks are not implemented. What you get:

24 typed API operations

Setup

Install

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

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

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

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

Add the plugin

corsair.ts

import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { cloudflarebrowserrendering } from '@corsair-dev/cloudflarebrowserrendering';

export const corsair = createCorsair({
	plugins: [
		cloudflarebrowserrendering({
			authType: 'api_key',
		}),
	],
	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 Cloudflare Browser Run API key before the first call: pnpm corsair setup --plugin=cloudflarebrowserrendering --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.

cloudflarebrowserrendering({
	authType: 'api_key',
})

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: 'cloudflarebrowserrendering',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl

Example API calls

Fetch rendered HTML

const tenant = corsair.withTenant('acme');
await tenant.cloudflarebrowserrendering.api.content.fetch({
	accountId: 'acct-123',
	body: { url: 'https://example.com' },
});

Create a browser session

const tenant = corsair.withTenant('acme');
await tenant.cloudflarebrowserrendering.api.browser.create({
	accountId: 'acct-123',
	keepAlive: 60000,
	guardrails: {
		allowedDomains: ['example.com'],
	},
});

See the full list on the API page.

What’s next

API reference

Every cloudflarebrowserrendering.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