← All integrations

Carbone

11 operations0 webhooks

Document generation and template rendering API for creating files from data-driven templates.

Supported operations

  • Generate ReportWrite

    Tool to generate a Carbone report from a template and JSON data. Use when you need to render documents in various formats.

  • Render DirectWrite

    Tool to generate a document by uploading a base64-encoded template and data in a single API call. Use when you need to render documents without uploading templates separately.

FAQ

Install corsair and @corsair-dev/carbone, add the Carbone plugin, and connect with an API key. Then call methods like corsair.carbone.api.render.generateReport() from your app. Corsair syncs data per tenant.

Yes. Carbone requires an API key from your Carbone account or developer dashboard. Create credentials with access that matches what you automate, then paste them into Corsair or connect through managed auth in Hub.

Yes. One Corsair client can hit Carbone, GitHub, Notion, Stripe, and the rest. Trigger Carbone from a webhook, push updates to Slack, or chain actions across plugins. Same tenant context across integrations, plain TypeScript.

Teams use Corsair for document generation and template rendering api for creating files from data-driven templates. Common builds include sync jobs, admin tooling, and agents that call Carbone APIs from your backend. Local DB entities let you query synced Carbone records without hitting the API on every read.

The SDK is open source. Self-host and you pay Corsair nothing for the integration layer. Hub bills for hosted auth and execution, not per Carbone API call. Hub has a generous free tier. For hobby projects you can probably run the whole thing on free. Paid plans start to matter with more tenants or heavier traffic.

We maintain @corsair-dev/carbone in the open repo. When Carbone ships API changes, upgrade the package. Your call sites stay typed. You should not need to rewrite the integration layer each time.

No. Corsair does not read your Carbone data or hold individual access credentials. Credentials stay in your database. API calls run on your instance. We do not store Carbone data on your behalf.