Overview - Corsair

Use TinyFish through Corsair: one client, typed API calls, local DB sync, and incoming webhooks. What you get:

28 typed API operations
1 synced entity (agentRuns) for fast .search() / .list()
3 incoming webhook event types

Setup

Install

npm install corsair @corsair-dev/tinyfish

yarn add corsair @corsair-dev/tinyfish

pnpm install corsair @corsair-dev/tinyfish

bun add corsair @corsair-dev/tinyfish

Add the plugin

corsair.ts

import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { tinyfish } from '@corsair-dev/tinyfish';

export const corsair = createCorsair({
	plugins: [
		tinyfish(),
	],
	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 for KEK + Hub keys, and Multi-tenancy for account isolation.

Choose authentication

API Key (Recommended)

No setup required yet. When you make your first request as a tenant, Corsair prompts for the API key.

tinyfish()

More: API Key

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.

const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'tinyfish',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl

Example API calls

Search the web

const tenant = corsair.withTenant('acme');
await tenant.tinyfish.api.search.search({ query: 'open source integration layer', location: 'US' });

Queue a web automation run

const tenant = corsair.withTenant('acme');
await tenant.tinyfish.api.agent.runAsync({ url: 'https://example.com', goal: 'Extract the page title' });

See the full list on the API page.

Query synced data

Runs are stamped into the agentRuns entity by sync runs, async acknowledgements, polls and webhook deliveries, so one run never duplicates rows.

const tenant = corsair.withTenant('acme');
const rows = await tenant.tinyfish.db.agentRuns.search({
	data: { status: 'COMPLETED' },
	limit: 50,
});

Synced entities: agentRuns. See Database for filters and operators.

Webhooks

Fires when a web automation run finishes; the plugin stamps the terminal state into agentRuns.

tinyfish({
    webhookHooks: {
        run: {
            completed: {
                after: async (ctx, result) => {
                    console.log('Run finished:', result.data.run_id, result.data.status);
                }
            },
        },
    },
})

Mount your framework handler once (see Frameworks), then point the provider at that URL. Full event list: Webhooks. Concepts: Webhooks, Hooks.

What’s next

API reference

Every tinyfish.api.* operation with input and output types.

Database

Synced entities, search filters, and operators.

Webhooks

Event paths, payloads, and webhookHooks examples.

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.

​Setup

​Example API calls

​Query synced data

​Webhooks

​What’s next

API reference

Database

Webhooks

Connect / OAuth

Use with agents

Setup

Example API calls

Query synced data

Webhooks

What’s next