Overview - Corsair

Use Abyssale through Corsair: one client, typed API calls, local DB sync, and incoming webhooks. What you get:

7 typed API operations
4 synced entities (banners, designs, fonts, projects) for fast .search() / .list()
4 incoming webhook event types

Setup

Install

npm install corsair @corsair-dev/abyssale

yarn add corsair @corsair-dev/abyssale

pnpm install corsair @corsair-dev/abyssale

bun add corsair @corsair-dev/abyssale

Add the plugin

corsair.ts

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

export const corsair = createCorsair({
	plugins: [
		abyssale(),
	],
	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.

abyssale()

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

Example API calls

auth.test

const tenant = corsair.withTenant('acme');
await tenant.abyssale.api.auth.test({});

generation.batch

const tenant = corsair.withTenant('acme');
await tenant.abyssale.api.generation.batch({});

See the full list on the API page.

Query synced data

Synced entities support tenant.abyssale.db.<entity>.search() and .list(): banners, designs, fonts, projects. See Database for filters and operators.

Webhooks

This plugin registers 4 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 abyssale.api.* operation with input and output types.

Database

Synced entities, search filters, and operators.

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

​Query synced data

​Webhooks

​What’s next

API reference

Database

Webhooks

Connect / OAuth

Use with agents

Setup

Example API calls

Query synced data

Webhooks

What’s next