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

# Overview

> Document generation and template rendering API for creating files from data-driven templates.

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

<Steps>
  <Step title="Install">
    <CodeGroup>
      ```bash npm theme={null}
      npm install corsair @corsair-dev/carbone
      ```

      ```bash yarn theme={null}
      yarn add corsair @corsair-dev/carbone
      ```

      ```bash pnpm theme={null}
      pnpm install corsair @corsair-dev/carbone
      ```

      ```bash bun theme={null}
      bun add corsair @corsair-dev/carbone
      ```
    </CodeGroup>
  </Step>

  <Step title="Add the plugin">
    ```ts corsair.ts theme={null}
    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](/quick-start) for KEK + Hub keys, and [Multi-tenancy](/concepts/multi-tenancy) for account isolation.
  </Step>

  <Step title="Choose authentication">
    <Tabs>
      <Tab title="API Key (Recommended)">
        No setup required yet. When you make your first request as a tenant, Corsair prompts for the API key.

        ```ts theme={null}
        carbone()
        ```

        More: [API Key](/concepts/api-key)
      </Tab>
    </Tabs>
  </Step>

  <Step title="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](/management/connect).

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

## Example API calls

**List templates**

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

**Generate report from template**

```ts theme={null}
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](/plugins/carbone/api) page.

## Query synced data

Search synced templates without calling Carbone.

```ts theme={null}
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](/plugins/carbone/database) for filters and operators.

## What's next

<CardGroup cols={2}>
  <Card title="API reference" href="/plugins/carbone/api">
    Every `carbone.api.*` operation with input and output types.
  </Card>

  <Card title="Database" href="/plugins/carbone/database">
    Synced entities, search filters, and operators.
  </Card>

  <Card title="Connect / OAuth" href="/management/connect">
    createLink, Hub delivery, and tenant connect flows.
  </Card>

  <Card title="Use with agents" href="/mcp-adapters/mcp-adapters">
    Expose this plugin's operations as MCP tools.
  </Card>
</CardGroup>