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

# Parsera plugin

> Parsera is an AI web scraper you drive with plain instructions. This plugin extracts structured data from pages or raw content, manages reusable extractor and agentic scrapers, runs them synchronously or as pollable async jobs, and tracks run progress and credits.

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

Authenticate with an API key from the Parsera app; the plugin sends it in the `X-API-KEY` header. One-shot extraction charges credits per call, so extractor.extract and extractor.parse are marked as writes.
Agent extractions and async scraper runs answer 202 with an id: poll agent.getTask (statuses pending, running, completed, failed, stopped) or scrapers.getRun (running, completed, completed\_partial, failed), and stop a running extraction with agent.stopTask. The plugin declares these as jobs, so the agent can follow them with get\_job.
Every extraction result is an open record: its keys are the attribute names you sent, or whatever structure the prompt produced. The docs publish no fixed result schema, so the plugin does not invent one.
Every operation is described in the official docs: [https://parsera.org/docs/api](https://parsera.org/docs/api)

**What you get:**

* 15 typed API operations

## Setup

**1. Install**

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

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

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

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

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

## Example API calls

**Read an extraction task**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.parsera.api.agent.getTask({ taskId: 'agent-extract-abc123' });
```

**Extract attributes from a page**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.parsera.api.extractor.extract({
	url: 'https://news.ycombinator.com/',
	attributes: [{ name: 'title', description: 'News title' }, { name: 'points', description: 'Number of points' }],
});
```

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

## What's next

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