X-API-Key header. Mailbox ids look like 6xxxxxxxxxxxxxxx and are visible in the app URL when a mailbox is open.
Synchronous imports (documents.createSync, documents.uploadSync) return the parsed document in the same response whenever parsing finishes within the timeout; asynchronous imports (documents.createAsync, documents.uploadAsync) return parsing_in_progress true and are followed with documents.get, which the plugin declares as a job so the agent can wait on it. doc-sync is supported only by the template-based and GPT parsers; uploads work with all parser types (sync: one file up to 20MB and no ZIP; async: one file up to 50MB, ZIPs included). Parsing consumes credits.
Webhook deliveries carry the parsed document and are signed in the parsio-signature header (base64 HMAC-SHA256 of the raw payload with the signing secret the Parsio app shows per webhook). Store that secret with keys.set_webhook_signature so deliveries can be verified.
Template management (list, get, enable, disable, clone, delete) is documented by Parsio but not part of this plugin; the docs publish its parameters but not the response shapes.
Every operation is described in the official docs: https://help.parsio.io/public-api/parsio-public-api
What you get:
- 21 typed API operations
- 1 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 Parsio API key before the first call: More: API Key
pnpm corsair setup --plugin=parsio --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
Read a parsed documentWebhooks
This plugin registers 1 webhook event type. Configure the provider to POST to your Corsair HTTP handler, then usewebhookHooks on the plugin factory.
See Webhooks for every event path and payload shape, and Webhooks concept for routing.
What’s next
API reference
Every
parsio.api.* operation with input and output types.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.