- 28 typed API operations
- 1 synced entity (
agentRuns) for fast.search()/.list() - 3 incoming webhook event types
Setup
1
Install
2
Add the plugin
corsair.ts
multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.3
Choose authentication
- API Key (Recommended)
Store the TinyFish API key before the first call: More: API Key
pnpm corsair setup --plugin=tinyfish --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.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.
Example API calls
Search the webQuery synced data
Runs are stamped into the agentRuns entity by sync runs, async acknowledgements, polls and webhook deliveries, so one run never duplicates rows.agentRuns. See Database for filters and operators.
Webhooks
Fires when a web automation run finishes; the plugin stamps the terminal state into agentRuns.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.