> ## 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

> Agent-native people API for evidence-backed people search, identity resolution, deep profiles, and contact enrichment.

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

**What you get:**

* 9 typed API operations
* 1 synced entity (`people`) for fast `.search()` / `.list()`

## Setup

**1. Install**

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

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

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

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

**2. Add the plugin**

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

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

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

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

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

## Example API calls

**Read the workspace ACU balance**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.ploid.api.account.credits({});
```

**Resolve a person to a permanent person\_id**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.ploid.api.person.resolve({ name: 'Jane Doe', company: 'acme.com' });
```

See the full list on the [API](/plugins/ploid/api) page.

## Query synced data

Read a previously resolved or enriched person without calling the API.

```ts theme={null}
const tenant = corsair.withTenant('acme');
const rows = await tenant.ploid.db.people.search({
	data: { personId: 'per_abc123', name: 'Jane Doe', company: 'Acme' },
	limit: 10,
});
```

Synced entities: `people`. See [Database](/plugins/ploid/database) for filters and operators.

## What's next

> **[API reference](/plugins/ploid/api)**
>
> Every `ploid.api.*` operation with input and output types.

> **[Database](/plugins/ploid/database)**
>
> Synced entities, search filters, and operators.

> **[Connect / OAuth](/management/connect)**
>
> createLink, Hub delivery, and tenant connect flows.

> **[Use with agents](/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.