Carbone Render API

The Render API from Carbone — 3 operation(s) for render.

Operations 3

POST /render/{templateId} Render a document from a stored template #
POST /render/template Inline template-and-render in a single call #
GET /render/{renderId} Download a rendered 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-render-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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-render-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Carbone Cloud HTTP Render API
  description: Carbone is a document generation engine that uses Word, Excel, PowerPoint and ODF templates with JSON data to produce PDFs or office documents. The HTTP API offers a template-then-render workflow with bearer-token auth.
  version: '4'
  contact:
    name: Carbone API
    url: https://carbone.io/api-reference.html
servers:
- url: https://api.carbone.io
  description: Production
security:
- bearerAuth: []
tags:
- name: Render
paths:
  /render/{templateId}:
    parameters:
    - in: path
      name: templateId
      required: true
      schema:
        type: string
    post:
      tags:
      - Render
      summary: Render a document from a stored template
      operationId: renderTemplate
      parameters:
      - in: header
        name: carbone-version
        required: false
        schema:
          type: string
      - in: header
        name: carbone-webhook-url
        required: false
        schema:
          type: string
          format: uri
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                data:
                  type: object
                convertTo:
                  type: string
                  example: pdf
                reportName:
                  type: string
                lang:
                  type: string
      responses:
        '200':
          description: Render initiated
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    properties:
                      renderId:
                        type: string
  /render/template:
    post:
      tags:
      - Render
      summary: Inline template-and-render in a single call
      operationId: renderInline
      parameters:
      - in: query
        name: download
        schema:
          type: boolean
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - template
              - data
              properties:
                template:
                  type: string
                  description: Base64-encoded template
                data:
                  type: object
                convertTo:
                  type: string
      responses:
        '200':
          description: Rendered file
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
  /render/{renderId}:
    parameters:
    - in: path
      name: renderId
      required: true
      schema:
        type: string
    get:
      tags:
      - Render
      summary: Download a rendered document
      operationId: downloadRender
      security: []
      responses:
        '200':
          description: Rendered file
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Carbone Cloud API token