Corsair Documentation

Choose the correct setup based on where you want the Corsair logic and data to reside:

Note: The /api/corsair route requires a server-side environment. Pure client-side SPAs (Angular/Vue/Svelte) must wire this route into a backend (SSR server, Express, etc.).

Corsair is designed to prevent agents from accessing sensitive credentials:

• Credential Isolation: Agents only see method names and results. Credentials are resolved internally by Corsair at call time. The agent cannot read, log, or exfiltrate them.
• Storage: Credentials are stored in an encrypted database using envelope encryption. A Key Encryption Key (KEK) that you control encrypts per-tenant data keys, which in turn encrypt the actual secrets.
• Manual Key Management: If you prefer to manage your own keys instead of using the built-in key manager, you can pass them directly to Corsair.

When setting up Corsair, understand the following terminology:

• Tenant: Represents one of your users.
• Plugin: Represents a single service integration (e.g., Slack, GitHub).
• Hub: The hosted component that manages public-facing surfaces like OAuth connect pages, callbacks, and approvals. It relays data but does not store your credentials.
• Delivery URL: The endpoint where Hub sends results. This URL self-registers upon the first request.
• Multi-tenant: The standard mode where the integration connects to your end users' accounts rather than just your own app's tools.
• Permission Modes: You can choose between using Corsair Hub (preferred) or a manual, self-hosted mode.

After installing the plugin, you must store your credentials using the Corsair CLI. Use the specific key names required by Reddit (e.g., api_key=, bot_token=, or OAuth client fields).

For Solo Mode:

pnpm corsair setup --plugin=reddit

For Multi-Tenant Mode: Store secrets per-tenant after creating the tenant record:

pnpm corsair setup --plugin=reddit --tenant=<tenantId>

Initialize Corsair by calling createCorsair and providing an array of plugins for the integrations you wish to use (e.g., slack(), github(), gmail(), linear(), googlecalendar()).

// corsair.ts
export const corsair = createCorsair({
  plugins: [slack(), github(), gmail(), linear(), googlecalendar()],
});

You can add logging, approvals, or side effects to OpenWeatherMap interactions using Corsair's hook system:

• Hooks: Use these on API calls to intercept or modify requests/responses.
• WebhookHooks: Use these on incoming events to handle asynchronous data or notifications.

Refer to the general Corsair Hooks and Webhooks documentation for routing and payload patterns.

Use pnpm to run tests for the Gemini package.

• Offline unit tests: Always run and do not require an API key.
• Live API tests: Only run if GEMINI_API_KEY is set. Image/Veo live tests will soft-skip on 429/404 errors to prevent CI failures due to free-tier quotas.

pnpm --filter @corsair-dev/gemini test

To use Jira with Corsair, install the @corsair-dev/jira package and add it to your createCorsair configuration. You can use the plugin in either Solo or Multi-Tenant mode depending on your multiTenancy setting.

Installation

pnpm install @corsair-dev/jira

Configuration

Solo Mode:

import { createCorsair } from 'corsair';
import { jira } from '@corsair-dev/jira';

export const corsair = createCorsair({
	// ... other config options,
	multiTenancy: false,
    plugins: [jira()],
});

Multi-Tenant Mode:

import { createCorsair } from 'corsair';
import { jira } from '@corsair-dev/jira';

export const corsair = createCorsair({
	// ... other config options,
    multiTenancy: true,
    plugins: [jira()],
});

To handle incoming Razorpay webhooks, point your provider's subscription URL to a Corsair HTTP handler. You must use the processWebhook function from corsair, passing your corsair instance, the request headers, and the request body.

import { processWebhook } from "corsair";
import { corsair } from "@/server/corsair";

export async function POST(request: Request) {
    const headers = Object.fromEntries(request.headers);
    const body = await request.json();
    const result = await processWebhook(corsair, headers, body);
    return result.response;
}

After installing the plugin, you must store the required credentials using the Corsair CLI. The specific key names (e.g., api_key, bot_token, or OAuth client fields) can be found in the Get Credentials guide.

For Solo mode:

pnpm corsair setup --plugin=figma

For Multi-Tenant mode:

pnpm corsair setup --plugin=figma --tenant=<tenantId>