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

# Perigon plugin

> Perigon is a news intelligence API over a large article index. This plugin searches articles (one result per published URL), lists story clusters, journalists and resolved people and company entities, and reads the account's usage and limits.

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

Authenticate with the API key from the Developers section of your Perigon account; the plugin sends it in the x-api-key header (the docs also allow a query parameter and a Bearer header — the header keeps the key out of URLs). Every route here is a GET.
Articles API returns one result per published article URL; Stories API returns clustered narratives. The limits endpoint is free to poll — it does not count against your quota — and reports requestsUsed, requestLimit and resetAt. Article body text may be truncated on some plans; check articleContentTruncation in limits.get.
Lists answer \{ status, numResults, articles } (articles) or \{ status, numResults, results } (the rest); numResults is the total match count and pages are numbered from 0. Filters that take several values (source, topic, country, ...) accept a list and OR them. This plugin exposes the common filters from Perigon's OpenAPI. Monitors, Social (X, Reddit, LinkedIn), vector search and the summarizer are documented by Perigon but not part of this plugin.
Every operation is described in the official docs: [https://docs.perigon.io/openapi.json](https://docs.perigon.io/openapi.json)

**What you get:**

* 6 typed API operations

## Setup

**1. Install**

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

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

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

```bash bun theme={null}
bun add corsair @corsair-dev/perigon 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 { perigon } from '@corsair-dev/perigon';

export const corsair = createCorsair({
	plugins: [
		perigon(),
	],
	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 Perigon API key before the first call: `pnpm corsair setup --plugin=perigon --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}
> perigon()
> ```
>
> 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: 'perigon',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**Search articles**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.perigon.api.articles.list({
	q: 'climate AND policy',
	from: '2025-11-01',
	size: 25,
	page: 0,
});
```

**Write**

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

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

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/perigon/api.md)
>
> Every `perigon.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.