Overview - Corsair

Use Campaign Cleaner through Corsair: one client, typed API calls, local DB sync. What you get:

5 typed API operations
2 synced entities (campaigns, credits) for fast .search() / .list()

Setup

Install

npm install corsair @corsair-dev/campaigncleaner

yarn add corsair @corsair-dev/campaigncleaner

pnpm install corsair @corsair-dev/campaigncleaner

bun add corsair @corsair-dev/campaigncleaner

Add the plugin

corsair.ts

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

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

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

campaigncleaner()

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

Example API calls

List campaigns

const tenant = corsair.withTenant('acme');
await tenant.campaigncleaner.api.campaign.list({});

Get a campaign PDF analysis

const tenant = corsair.withTenant('acme');
await tenant.campaigncleaner.api.campaign.pdfAnalysis({ campaignId: '12345' });

See the full list on the API page.

Query synced data

These tables exist, but Campaign Cleaner calls don’t fill them yet. This returns only rows you have written yourself.

const tenant = corsair.withTenant('acme');
const rows = await tenant.campaigncleaner.db.campaigns.search({
	data: {},
	limit: 50,
});

Synced entities: campaigns, credits. See Database for filters and operators.

What’s next

API reference

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

Database

Synced entities, search filters, and operators.

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

​What’s next