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

# CraftMyPDF plugin

> PDF generation API that renders PDFs and images from reusable drag-and-drop templates, and manages those templates, their versions and the account's usage.

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

CraftMyPDF renders from templates you design in its editor. The template calls
(`pdf.create`, `pdf.createAsync`, `pdf.createImage`, `pdf.createMerge`,
`pdf.createParallel`) need a `template_id`, which the templates list operation
returns, and the JSON data that fills it; the merge and parallel calls take one
per entry. `pdf.create` and `pdf.createImage` can fetch that data from a URL
with `load_data_from` instead of `data`. The PDF editing calls (`pdf.merge`,
`pdf.addText`, `pdf.addWatermark`, `pdf.updateFields`, `pdf.getInfo`) take PDF
URLs and no template.

Generation is metered: each PDF or image costs one credit from the monthly
allowance. Reads (account, templates, transactions) are free.

CraftMyPDF runs several regional APIs. The plugin calls the Singapore host
([https://api.craftmypdf.com/v1](https://api.craftmypdf.com/v1)) unless you pass `region`, which accepts `sg`,
`de`, `us` or `au`.

**What you get:**

* 23 typed API operations

## Setup

**1. Install**

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

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

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

```bash bun theme={null}
bun add corsair @corsair-dev/craftmypdf 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 { craftmypdf } from '@corsair-dev/craftmypdf';

export const corsair = createCorsair({
	plugins: [
		craftmypdf(),
	],
	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)
>
> No setup required yet. When you make your first request as a tenant, Corsair prompts for the API key.
>
> ```ts theme={null}
> craftmypdf()
> ```
>
> 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: 'craftmypdf',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**List the templates on the account**

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

**Generate a PDF from a template**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.craftmypdf.api.pdf.create({
	template_id: '05f77b2b18ad809a',
	data: { invoice_number: 'INV38379', total_amount: 82542.56 },
});
```

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

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/craftmypdf/api.md)
>
> Every `craftmypdf.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.