Cloudlayer plugin

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

Install

npm install corsair @corsair-dev/cloudlayer better-sqlite3
npm install --save-dev @types/better-sqlite3

yarn add corsair @corsair-dev/cloudlayer better-sqlite3
yarn add --dev @types/better-sqlite3

pnpm install corsair @corsair-dev/cloudlayer better-sqlite3
pnpm install --save-dev @types/better-sqlite3

bun add corsair @corsair-dev/cloudlayer better-sqlite3
bun add --dev @types/better-sqlite3

Add the plugin

corsair.ts

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 for KEK + Hub keys, and Multi-tenancy for account isolation.

Choose authentication

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

cloudlayer()

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

Example API calls

Read account usage

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

Render HTML to an image

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

See the full list on the API page.

What’s next

API reference

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

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.

Overview

Plugins