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

# HoneyHive plugin

> AI agent observability and evaluation platform for tracing, evaluating, monitoring, and improving LLM applications.

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

HoneyHive provides AI agent observability and evaluation across development and production:

* **Authentication**: HoneyHive routes accept different key types, so the connection holds up to three keys, each sent as `Authorization: Bearer <key>`:
  * `api_key`: a classic project API key (`hh_...`, Settings > Project > API Keys > Project). Used by sessions, event ingestion and updates, metrics, configurations and the legacy (non-project-scoped) dataset, run and event routes.
  * `data_plane_api_key` (account field, optional): a data plane fine-grained key (`hh_fgdp_...`). Required by the project-scoped operations that take a `project_id` (`datasets.list`, `experiments.getRun`, `events.search` and the rest); HoneyHive rejects a classic key there.
  * `control_plane_api_key` (account field, optional): a control plane fine-grained key (`hh_fgcp_...`, Settings > Workspace > API Keys > Control Plane). Required by `projects.*`, which run on `https://api.cp.us.honeyhive.ai`.
  * A connection with only fine-grained keys works for the operations those keys cover; operations that need the classic key raise `AuthMissingError` instead of sending a fine-grained key.
* **Dedicated or self-hosted data plane**: set the `base_url` account field to your project's Data plane URL (default `https://api.dp1.us.honeyhive.ai`, shown under Settings > Project > API Keys).
* **Tracing & Sessions**: Group multi-step agent and tool spans into sessions with `sessions.create` and stream event batches with `sessions.createEventBatch` or `events.createBatch`.
* **Datasets & Experiments**: Curate evaluation datasets and run automated test suites across prompts, configurations, and models.
* **Evaluators & Metrics**: Define custom metrics, deploy metric version snapshots, and run automated evaluations against trace events.

**What you get:**

* 49 typed API operations

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/honeyhive better-sqlite3
npm install --save-dev @types/better-sqlite3
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/honeyhive better-sqlite3
yarn add --dev @types/better-sqlite3
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/honeyhive better-sqlite3
pnpm install --save-dev @types/better-sqlite3
```

```bash bun theme={null}
bun add corsair @corsair-dev/honeyhive better-sqlite3
bun add --dev @types/better-sqlite3
```

**2. Add the plugin**

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

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

> [tab] API Key (Recommended)
>
> Store the HoneyHive API key before the first call: `pnpm corsair setup --plugin=honeyhive --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](https://docs.corsair.dev/concepts/api-key).
>
> ```ts theme={null}
> honeyhive()
> ```
>
> 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: 'honeyhive',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**List evaluators and metrics**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.honeyhive.api.metrics.list({});
```

**Start a new tracing session**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.honeyhive.api.sessions.create({ session_name: 'customer-support-agent' });
```

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

## What's next

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

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

> [card] [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.