Grist plugin

Use Grist through Corsair: one client, typed API calls. Grist API calls authenticate with an API key via the Authorization: Bearer <api_key> header. Each connected account also stores base_url, the Grist site the key belongs to: https://docs.getgrist.com for a personal site, https://<team>.getgrist.com for a team site, or the HTTPS URL of a self-hosted instance. /api is added when missing. The URL must use https and may not contain credentials, a query string or a fragment. Calls fail with a connect prompt until it is set. SDK users can pass baseUrl in the plugin options instead. What you get:

71 typed API operations

Setup

Install

npm install corsair @corsair-dev/grist better-sqlite3
npm install --save-dev @types/better-sqlite3

yarn add corsair @corsair-dev/grist better-sqlite3
yarn add --dev @types/better-sqlite3

pnpm install corsair @corsair-dev/grist better-sqlite3
pnpm install --save-dev @types/better-sqlite3

bun add corsair @corsair-dev/grist better-sqlite3
bun add --dev @types/better-sqlite3

Add the plugin

corsair.ts

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

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

Store the Grist API key before the first call: pnpm corsair setup --plugin=grist --tenant=acme api_key=<your-key> (leave out --tenant without multiTenancy), or pass it as key in the plugin options. With Hub, each tenant enters their own key on the connect page. See API key auth.

grist()

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

Example API calls

List organizations

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

Add records to a table

const tenant = corsair.withTenant('acme');
await tenant.grist.api.records.add({
	docId: 'doc123example',
	tableId: 'Table1',
	records: [{
		fields: { Name: 'Alice', Role: 'Admin' },
	}],
});

See the full list on the API page.

What’s next

API reference

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

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.

Overview

Plugins