> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Ask Jev, TypeSafe's System One model, typed questions about text, JSON or images and get calibrated probabilities back for code to act on.

Use **TypeSafe** through Corsair: one client, typed API calls.

**What you get:**

* 2 typed API operations

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/typesafe
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/typesafe
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/typesafe
```

```bash bun theme={null}
bun add corsair @corsair-dev/typesafe
```

**2. Add the plugin**

```ts corsair.ts theme={null}
import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { typesafe } from '@corsair-dev/typesafe';

export const corsair = createCorsair({
	plugins: [
		typesafe(),
	],
	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](https://docs.corsair.dev/quick-start.md) for KEK + Hub keys, and [Multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md) 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.

```ts theme={null}
typesafe()
```

More: [API Key](https://docs.corsair.dev/concepts/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](https://docs.corsair.dev/management/connect).

```ts theme={null}
const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'typesafe',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**Check a lead against your ICP**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.typesafe.api.systemOne.ask({
	state: {
		lead: { title: 'VP Platform', company: 'Outerbounds', headcount: 60 },
		icp: 'Software companies with 20 to 200 staff where the buyer leads engineering',
	},
	questions: {
		fits_icp: { type: 'noul', instructions: 'Does `lead` fit `icp`?' },
		seniority: {
			type: 'choice',
			instructions: 'How senior is `lead`?',
			criteria: {
				individual_contributor: null,
				manager: null,
				director_or_vp: null,
				c_level_or_founder: null,
			},
		},
	},
});
```

**Write**

*No write-style endpoint inferred; pick any operation from the [API](https://docs.corsair.dev/plugins/typesafe/api.md) reference.*

See the full list on the [API](https://docs.corsair.dev/plugins/typesafe/api.md) page.

## What's next

> **[API reference](https://docs.corsair.dev/plugins/typesafe/api.md)**
>
> Every `typesafe.api.*` operation with input and output types.

> **[Connect / OAuth](https://docs.corsair.dev/management/connect)**
>
> createLink, Hub delivery, and tenant connect flows.

> **[Use with agents](https://docs.corsair.dev/mcp-adapters/mcp-adapters)**
>
> Expose this plugin's operations as MCP tools.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.