Overview - Corsair

Use Bannerbear through Corsair: one client, typed API calls, and incoming webhooks. What you get:

27 typed API operations
2 incoming webhook event types

Setup

Install

npm install corsair @corsair-dev/bannerbear

yarn add corsair @corsair-dev/bannerbear

pnpm install corsair @corsair-dev/bannerbear

bun add corsair @corsair-dev/bannerbear

Add the plugin

corsair.ts

import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { bannerbear } from '@corsair-dev/bannerbear';

export const corsair = createCorsair({
	plugins: [
		bannerbear(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	hub: {
		projectApiKey: process.env.CORSAIR_DEV_API_KEY!,
		signingSecret: process.env.CORSAIR_DEV_SIGNING_SECRET!,
	},
});

Multi-tenancy is the default — scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.

Choose authentication

API Key (Recommended)

No setup required yet. When you make your first request as a tenant, Corsair prompts for the API key.

bannerbear()

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

Example API calls

account.getAccountInfo

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

animations.create

const tenant = corsair.withTenant('acme');
await tenant.bannerbear.api.animations.create({});

See the full list on the API page.

Webhooks

This plugin registers 2 webhook event types. Configure the provider to POST to your Corsair HTTP handler, then use webhookHooks on the plugin factory. See Webhooks for every event path and payload shape, and Webhooks concept for routing.

What’s next

API reference

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

Webhooks

Event paths, payloads, and webhookHooks examples.

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.

​Setup

​Example API calls

​Webhooks

​What’s next

API reference

Webhooks

Connect / OAuth

Use with agents

Setup

Example API calls

Webhooks

What’s next