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

# PDFLess plugin

> Generate PDFs from PDFLess document templates, list the templates and read the workspace quota. Requests send the API key in the apikey header.

Use **PDFLess** through Corsair: one client, typed API calls, local DB sync.

Auth is the apikey header on [https://api.pdfless.com](https://api.pdfless.com). With no key stored, Corsair raises AuthMissingError before any request; a key PDFLess rejects comes back as HTTP 401 ("No API key found in request" when the header is empty). pdfs.generate renders one document against the workspace quota (workspace.get shows remainingQuota), so it is destructive; its download\_url expires at `expires`. Template data and PDF passwords are kept out of errors and events. The workspace model has no id, so a workspace row is stored only when name is present. A template row is stored only when id is present.

**What you get:**

* 3 typed API operations
* 2 synced entities (`templates`, `workspaces`) for fast `.search()` / `.list()`

## Setup

**1. Install**

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

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

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

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

export const corsair = createCorsair({
	plugins: [
		pdfless(),
	],
	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)
>
> Store the PDFLess API key before the first call: `pnpm corsair setup --plugin=pdfless --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](https://docs.corsair.dev/concepts/api-key).
>
> ```ts theme={null}
> pdfless()
> ```
>
> 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: 'pdfless',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**List document templates**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.pdfless.api.templates.list({ page: 1, pageSize: 25 });
```

**Render an invoice PDF from a template**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.pdfless.api.pdfs.generate({
	template_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
	reference_id: 'invoice-42',
	payload: {
		customer: { name: 'Ada Lovelace' },
		total: 42,
	},
});
```

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

## Query synced data

Synced entities support `tenant.pdfless.db.<entity>.search()` and `.list()`: `templates`, `workspaces`.

See [Database](https://docs.corsair.dev/plugins/pdfless/database.md) for filters and operators.

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/pdfless/api.md)
>
> Every `pdfless.api.*` operation with input and output types.

> [card] [Database](https://docs.corsair.dev/plugins/pdfless/database.md)
>
> Synced entities, search filters, and operators.

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