Overview

AimlApi plugin for Corsair

Use AimlApi through Corsair: one client, typed API calls, local DB sync.

What you get:

• 29 typed API operations
• 4 synced entities (assistants, batches, models, threads) for fast .search() / .list()

Setup

1. Install

   npm

   npm install corsair @corsair-dev/aimlapi
   
2. Add the plugin

   corsair.ts

   import Database from 'better-sqlite3';
   import { createCorsair } from 'corsair';
   import { aimlapi } from '@corsair-dev/aimlapi';
   
   export const corsair = createCorsair({
   	plugins: [
   		aimlapi(),
   	],
   	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.

3. Choose authentication

   API Key (Recommended)

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

   aimlapi()
   

   More: API Key

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

Example API calls

assistants.get

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

assistants.create

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

See the full list on the API page.

Query synced data

Synced entities support tenant.aimlapi.db.<entity>.search() and .list(): assistants, batches, models, threads.

See Database for filters and operators.

What’s next

API reference

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