Overview - Corsair

Use Carbone through Corsair: one client, typed API calls, local DB sync. What you get:

11 typed API operations
3 synced entities (categories, tags, templates) for fast .search() / .list()

Setup

Install

npm install corsair @corsair-dev/carbone

yarn add corsair @corsair-dev/carbone

pnpm install corsair @corsair-dev/carbone

bun add corsair @corsair-dev/carbone

Add the plugin

corsair.ts

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

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

Multi-tenancy is the default — scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.

Choose authentication

API Key (Recommended)

No setup required yet. When you make your first request as a tenant, Corsair prompts for the API key.

carbone()

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

Example API calls

List templates

const tenant = corsair.withTenant('acme');
await tenant.carbone.api.templates.list({ id: 'tmpl_1234567890abcdef', cursor: 0 });

Generate report from template

const tenant = corsair.withTenant('acme');
await tenant.carbone.api.render.generateReport({
	templateId: 'tmpl_1234567890abcdef',
	data: { customer: 'Acme Corp', amount: 1250 },
	convertTo: 'pdf',
});

See the full list on the API page.

Query synced data

Search synced templates without calling Carbone.

const tenant = corsair.withTenant('acme');
const rows = await tenant.carbone.db.templates.search({
	data: { category: 'Finance' },
	limit: 50,
});

Synced entities: categories, tags, templates. See Database for filters and operators.

What’s next

API reference

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

Database

Synced entities, search filters, and operators.

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.

​Setup

​Example API calls

​Query synced data

​What’s next