Overview - Corsair

Use GMI Cloud through Corsair: one client, typed API calls, local DB sync. GMI Cloud API keys have a scope. An ie_model key calls inference (models, chat, router, media requests, uploads) and apiKeys.getCurrent. A ce_resource key calls GPU compute (containers, bare metal, elastic IPs, firewalls, images, templates, VPCs) and sandboxes. idcs.list works with either. Create the key that matches what you need under Organization Settings, API Keys. What you get:

72 typed API operations
8 synced entities (baremetals, containers, elasticIps, firewalls, mediaRequests, models, and 2 more) for fast .search() / .list()

Setup

Install

npm install corsair @corsair-dev/gmicloud

yarn add corsair @corsair-dev/gmicloud

pnpm install corsair @corsair-dev/gmicloud

bun add corsair @corsair-dev/gmicloud

Add the plugin

corsair.ts

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

export const corsair = createCorsair({
	plugins: [
		gmicloud(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_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.

gmicloud()

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

Example API calls

List LLMs

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

Create a chat completion

const tenant = corsair.withTenant('acme');
await tenant.gmicloud.api.chat.createCompletion({
	model: 'deepseek-ai/DeepSeek-V4-Flash',
	messages: [{ role: 'user', content: 'Summarize this ticket in one sentence.' }],
});

See the full list on the API page.

Query synced data

Look up queued and finished media jobs without calling GMI Cloud.

const tenant = corsair.withTenant('acme');
const rows = await tenant.gmicloud.db.mediaRequests.search({
	data: { status: 'success' },
	limit: 20,
});

Synced entities: baremetals, containers, elasticIps, firewalls, mediaRequests, models, sandboxes, sandboxTemplates. See Database for filters and operators.

What’s next

API reference

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