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

# Linkup plugin

> Web search for AI agents with Linkup - search results with page text, sourced answers, structured JSON, page fetch, and async research tasks.

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

Create an API key under API keys in the Linkup app; it is sent as a Bearer token. Accounts made with a professional email address get $20 of credit, topped back up to $20 each month. Every call except `credits.get`, `research.get/list` and `tasks.get/list` is billed per call: searches $0.005 to $0.055 by depth, page fetches $0.001 to $0.011, research $0.25 to $2.50 by `reasoningDepth` (the plugin defaults to S, \$0.25; Linkup's own default is L).
`search.run`, `answers.get`, `search.structured` and `pages.fetch` are metered lookups (read). `responses.create`, `research.create` and `tasks.create` are paid generation jobs and are destructive.
`depth`: flash, fast (default here) and standard cost the same; deep runs several searches and costs 10x. `fromDate`/`toDate` take YYYY-MM-DD and the domain filters take bare domains such as example.com.
Research and batch tasks run in the background: create them, then poll `research.get` or `tasks.get` until `status` is `completed` (or `failed`); `output` holds the answer, results or data.
Only the credit balance, source URLs with name, type and date, and response ids are stored. Page text, generated text and queries are not stored or put in events.

**What you get:**

* 12 typed API operations
* 3 synced entities (`credits`, `responses`, `sources`) for fast `.search()` / `.list()`

## Setup

**1. Install**

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

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

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

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

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

## Example API calls

**Search recent news on a domain**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.linkup.api.search.run({
	q: 'Corsair integrations for AI agents',
	includeDomains: ['corsair.dev'],
});
```

**Start a short research task**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.linkup.api.research.create({ q: 'When did the Oslo Opera House open, and who designed it?' });
```

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

## Query synced data

Synced entities support `tenant.linkup.db.<entity>.search()` and `.list()`: `credits`, `responses`, `sources`.

See [Database](https://docs.corsair.dev/plugins/linkup/database.md) for filters and operators.

## What's next

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

> [card] [Database](https://docs.corsair.dev/plugins/linkup/database.md)
>
> Synced entities, search filters, and operators.

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