Carbone

Carbone is a document generation engine that uses Word, Excel, PowerPoint and ODF templates with JSON data to produce PDFs or office documents. The Carbone HTTP API offers a template-then-render workflow with both cloud (api.carbone.io) and on-prem deployments. The Carbone JS rendering engine is open-source and embeddable.

3 APIs 0 Features

Document GenerationPDFTemplatesOpen SourceOfficeDOCXXLSX

APIs

Carbone Cloud HTTP API

Cloud-hosted Carbone API. Two flows — upload-once via POST /template then render with a template ID; or single-request inline-base64 render. Bearer-token auth (Authorization hea...

Carbone On-Premises

Self-hosted Carbone deployment exposing the same HTTP API. Auth disabled by default; enable via configuration. 30-day free trial of paid features.

Carbone Render Engine (Open Source)

Open-source Node.js library that powers the rendering engine. Embed directly in your application; render templates with JSON data without hitting the cloud API.

Collections

Carbone Cloud HTTP API

OPEN

Pricing Plans

Carbone Plans Pricing

11 plans

PLANS

Rate Limits

Carbone Rate Limits

4 limits

RATE LIMITS

FinOps

Carbone Finops

FINOPS

Resources

Sources

opencollection: 1.0.0
info:
  name: Carbone Cloud HTTP API
  version: '4'
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Template
    type: folder
  items:
  - info:
      name: Upload a template
      type: http
    http:
      method: POST
      url: https://api.carbone.io/template
      body:
        type: json
        data: '{}'
    docs: Upload a template
  - info:
      name: Download a template
      type: http
    http:
      method: GET
      url: https://api.carbone.io/template/:templateId
      params:
      - name: templateId
        value: ''
        type: path
    docs: Download a template
  - info:
      name: Delete a template
      type: http
    http:
      method: DELETE
      url: https://api.carbone.io/template/:templateId
      params:
      - name: templateId
        value: ''
        type: path
    docs: Delete a template
- info:
    name: Render
    type: folder
  items:
  - info:
      name: Render a document from a stored template
      type: http
    http:
      method: POST
      url: https://api.carbone.io/render/:templateId
      headers:
      - name: carbone-version
        value: ''
      - name: carbone-webhook-url
        value: ''
      params:
      - name: templateId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Render a document from a stored template
  - info:
      name: Inline template-and-render in a single call
      type: http
    http:
      method: POST
      url: https://api.carbone.io/render/template
      params:
      - name: download
        value: ''
        type: query
      body:
        type: json
        data: '{}'
    docs: Inline template-and-render in a single call
  - info:
      name: Download a rendered document
      type: http
    http:
      method: GET
      url: https://api.carbone.io/render/:renderId
      params:
      - name: renderId
        value: ''
        type: path
    docs: Download a rendered document
- info:
    name: Status
    type: folder
  items:
  - info:
      name: Get API status
      type: http
    http:
      method: GET
      url: https://api.carbone.io/status
    docs: Get API status
bundled: true