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

> Search for people and enrich public profiles on the Orbit API.

Use **Orbit** through Corsair: one client, typed API calls, local DB sync, and incoming webhooks.

**What you get:**

* 24 typed API operations
* 3 synced entities (`bulkJobs`, `enrichments`, `searches`) for fast `.search()` / `.list()`
* 1 incoming webhook event types

## Setup

**1. Install**

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

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

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

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

**2. Add the plugin**

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

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

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

## Example API calls

**`bulk.get`**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.orbit.api.bulk.get({});
```

**`bulk.cancel`**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.orbit.api.bulk.cancel({});
```

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

## Query synced data

Synced entities support `tenant.orbit.db.<entity>.search()` and `.list()`: `bulkJobs`, `enrichments`, `searches`.

See [Database](/plugins/orbit/database) for filters and operators.

## Webhooks

This plugin registers **1** webhook event type. Configure the provider to POST to your Corsair HTTP handler, then use `webhookHooks` on the plugin factory.

See [Webhooks](/plugins/orbit/webhooks) for every event path and payload shape, and [Webhooks concept](/concepts/webhooks) for routing.

## What's next

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

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

> **[Webhooks](/plugins/orbit/webhooks)**
>
> Event paths, payloads, and `webhookHooks` examples.

> **[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.