Carbone Document API

Generate Documents

GitHub OpenAPI

Operations 1

POST /render/{templateId-or-versionId} Generate a document #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/carbone:carbone-document-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

carbone-document-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: 'Carbone Open API reference.


    Carbone is a document generation and conversion API, trusted by thousands of companies across finance, legal, healthcare, HR, e-commerce, and government to automate their document workflows at scale.


    The core idea is simple: design a template (DOCX, XLSX, PPTX, ODT, HTML, Markdown, and more), provide a JSON dataset, and Carbone automatically merges them to produce a ready-to-use document: PDF, Word, Excel, Markdown, HTML, CSV, or any other supported format. Common use cases include:

    - **Finance and Accounting**: Invoices, purchase orders, financial reports, tax statements, bank statements, and audit reports.

    - **Legal**: Contracts, NDAs, legal agreements, court filings, and case summaries.

    - **Healthcare**: Patient records, medical reports, prescriptions, discharge summaries, and insurance claim forms.

    - **Government and Public Sector**: Administrative forms, public service notices, permits, official certificates, identity documents, tax declarations, and compliance reports.

    - **Human Resources**: Employment contracts, onboarding packs, payslips, performance reviews, and internal communications.

    - **Retail and E-commerce**: Receipts, shipping labels, delivery notes, product catalogues, and promotional materials.

    - **Education**: Diplomas, certificates, transcripts, report cards, and admission letters.

    - **Insurance**: Policy documents, claim reports, renewal notices, and coverage summaries.

    - **Real Estate**: Lease agreements, property reports, sale contracts, and inspection certificates.

    - **Logistics and Supply Chain**: Packing lists, bills of lading, customs declarations, and delivery confirmations.

    - **SaaS and Technology**: Usage reports, audit logs, billing statements, and client-facing data exports.


    Carbone provides the fastest **document converter**:

    - **Office to PDF** - Convert DOCX, XLSX, PPTX, ODT, ODS, ODP, and ODG files to PDF.

    - **HTML to PDF** - Convert raw HTML pages or web-based content to pixel perfect PDF.

    - **HTML to Images** - Convert raw HTML pages or web-based content to PNG, JPG, or WEBP.

    - **PDF to Office** - Convert PDF to DOCX, ODT, HTML, TXT (plain text extraction).

    - **PDF to Image** - Convert PDF to PNG, JPG, or WEBP.

    - **Office to Office** - DOCX ↔ ODT, XLSX ↔ CSV ↔ ODS, PPTX ↔ ODP.

    - **Office to Image** - Convert DOCX / PPTX / XLSX to PNG, JPG, TIFF, SVG, WEBP.

    - **Office to MD** - Convert DOCX/ODT to Markdown.

    - **MD to PDF, Office, or Images** - Convert Markdown documents to PDF, DOCX, ODT, PNG or JPG.

    - **PDF processing** - Apply password protection, watermarks, compliance settings, and more to any existing PDF.

    - **Any supported format to any other supported format** - Spreadsheets, presentations, graphics, and more (see the full conversion matrix).


    To get started:

    - **Carbone Cloud API**: find your API key on your Carbone account. Home page > Copy the `production` or `test` API key.

    - **Carbone Docker**: Update the `servers.url` field on the Open API specification.

    - **Carbone On-premise**: Update the `servers.url` field on the Open API specification.

    - **Carbone On-AWS**: Update the `servers.url` field on the Open API specification.


    Documentation:

    - Authentication

    - API Flow

    - API Timeout

    - API Webhooks

    - API Versions

    - Template Storage

    - Document Storage

    - SDKs: Node, Javascript, Golang, PHP, Python, Rust, and Java.

    - Integrations: Bubble, Make, Zapier, N8N, Odoo, Salesforce and Hubspot (Coming soon)'
  version: V5.15.0
  title: Carbone Document API
  contact:
    name: Carbone Support
    email: support@carbone.io
    url: https://help.carbone.io
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://api.carbone.io
tags:


# --- truncated at 32 KB (48 KB total) ---
# Full source: https://artifacts.apis.io/carbone/openapi/carbone-document-api-openapi.yml