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

# Cloudlayer plugin

> Generate PDFs and images from HTML, URLs, and templates, and manage Cloudlayer jobs, assets, and storage.

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

V2 generation returns JSON job responses, including a completed job when `async: false`; v1 generation routes return base64 artifacts. Run the Corsair database migration once before passing the connection to `createCorsair`; creating a SQLite file does not create Corsair's tables. Before creating a tenant connect link, mount a Hub delivery handler as described in [Connect / OAuth](https://docs.corsair.dev/management/connect). A call for a tenant with no stored key fails with `AuthMissingError`, which carries a connect link when Hub is configured.

**What you get:**

* 26 typed API operations

## Setup

**1. Install**

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

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

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

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

export const corsair = createCorsair({
	plugins: [
		cloudlayer(),
	],
	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 Cloudlayer API key before the first call: `pnpm corsair setup --plugin=cloudlayer --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).
>
> A call with no stored key fails with `AuthMissingError` and a connect link when Hub is configured. To skip that, connect the tenant through Hub below or store the key with `tenant.cloudlayer.keys.set_api_key(...)` first.
>
> ```ts theme={null}
> cloudlayer()
> ```
>
> 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: 'cloudlayer',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**Read account usage**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.cloudlayer.api.account.get({});
```

**Render HTML to an image**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.cloudlayer.api.html.toImage({ html: 'PGgxPkhlbGxvPC9oMT4=' });
```

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

## What's next

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