> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Carbone

> Carbone is a fast and simple report generator that converts JSON data into various document formats such as PDF, DOCX, XLSX, ODT, and more, using templates.

![Carbone logo](https://mintcdn.com/composio-preview/PudKL42NVsy5O-ND/images/toolkits/carbone.svg?fit=max\&auto=format\&n=PudKL42NVsy5O-ND\&q=85\&s=e70b2afaba4038594035e5014be09c62)

* **Category:** documents
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 11
* **Triggers:** 0
* **Slug:** `CARBONE`
* **Version:** 20261101\_00

## Tools

> [accordion] Delete Carbone Template
>
> **Slug:** `CARBONE_DELETE_TEMPLATE`
>
> Delete a Carbone template by template ID, including all its versions, or delete a specific version by version ID. The template stops being returned immediately; the file is removed after the storage retention delay.
>
> #### Input Parameters
>
> **templateId** `string` *required*
>
> The 64-character hexadecimal template ID (SHA-256 hash) to delete. Obtain this from the upload\_template action response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Download Template
>
> **Slug:** `CARBONE_DOWNLOAD_TEMPLATE`
>
> Tool to download a template from Carbone by template ID. Use when you need to retrieve the original template file.
>
> #### Input Parameters
>
> **template\_id** `string` *required*
>
> The unique identifier (SHA256 hash) of the template to download. Obtain this from the upload template action or generate template ID action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Carbone Report
>
> **Slug:** `CARBONE_GENERATE_REPORT`
>
> Generate a Carbone report from a template and JSON data, with optional output format and rendering settings. Returns a render ID for downloading the generated report; webhook-based asynchronous rendering is also supported.
>
> #### Input Parameters
>
> **data** `string` *required*
>
> Data to merge into the template as a JSON object or an array of objects
>
> **enum** `object`
>
> Enumerations to use with convEnum formatter, e.g. \{'ORDER\_STATUS': \['open', 'close']}
>
> **lang** `string`
>
> Locale of the generated document, e.g. 'en-us'
>
> **timezone** `string`
>
> Convert document dates to this timezone, e.g. 'Europe/Paris'
>
> **convertTo** `string`
>
> Output file format as a string, e.g. 'pdf', or an object with formatName and formatOptions
>
> **complement** `object`
>
> Extra data object merged into the template with tags \{c.}
>
> **reportName** `string`
>
> Static or dynamic file name returned in the content-disposition header, e.g. '\{d.date}.odt'
>
> **templateId** `string` *required*
>
> Unique identifier of the Carbone template used to generate the report
>
> **batchOutput** `string ("zip" | "pdf")`
>
> Output type for batch processing: 'zip' or 'pdf'
>
> **hardRefresh** `boolean`
>
> Force recompute pagination and table of contents
>
> **variableStr** `string`
>
> Predefined alias for template variables, e.g. '\{#def = d.id}'
>
> **batchSplitBy** `string`
>
> Batch processing split key, e.g. 'd.items'
>
> **translations** `object`
>
> Localization dictionary for translations formatter, e.g. \{'fr-ca': \{'one': 'un'}}
>
> **currencyRates** `object`
>
> Mapping of currency codes to exchange rates
>
> **currencySource** `string`
>
> Currency source code for conversions, e.g. 'EUR'
>
> **currencyTarget** `string`
>
> Target currency code for conversions, e.g. 'USD'
>
> **carbone-webhook-url** `string`
>
> Webhook URL for asynchronous report generation. Include to enable async jobs.
>
> **carbone-webhook-headers** `object`
>
> Custom headers for webhook calls, as a map of header name to value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Carbone Server Status
>
> **Slug:** `CARBONE_GET_STATUS`
>
> Tool to retrieve the current status and health of the Carbone server. Use before generating reports to ensure the service is operational.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Template Categories
>
> **Slug:** `CARBONE_LIST_TEMPLATE_CATEGORIES`
>
> List categories used in deployed Carbone templates. Categories function like folders for organizing templates.
>
> #### Input Parameters
>
> **carbone\_version** `integer`
>
> Carbone API version to use.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Templates
>
> **Slug:** `CARBONE_LIST_TEMPLATES`
>
> Tool to retrieve a list of templates from Carbone storage with filtering, search, and cursor-based pagination. Use when you need to find templates, search by name or ID, or iterate through all deployed templates.
>
> #### Input Parameters
>
> **id** `string`
>
> Filter by Template ID (64-bit format). Providing a Version ID (SHA256 format) is not allowed and will result in an API error.
>
> **limit** `integer`
>
> Limit the number of items (100 by default).
>
> **cursor** `string`
>
> A cursor to use in pagination. The cursor defines your place in the list for fetching the next set of results.
>
> **origin** `integer ("0" | "1")`
>
> Template upload origin.
>
> **search** `string`
>
> Search in template name (fuzzy search), Version ID (exact match), or Template ID (exact match).
>
> **category** `string`
>
> Filter by category.
>
> **versionId** `string`
>
> Filter by Version ID (SHA256 format).
>
> **carbone\_version** `integer`
>
> Carbone API version to use.
>
> **includeVersions** `boolean`
>
> By default equals to false. Use true to list all versions for a specific template ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Template Tags
>
> **Slug:** `CARBONE_LIST_TEMPLATE_TAGS`
>
> List tags currently used in deployed Carbone templates, for discovering labels used to categorize documents or versions.
>
> #### Input Parameters
>
> **carbone\_version** `integer`
>
> Carbone API version to use for this request. Defaults to 5.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Render Template Direct
>
> **Slug:** `CARBONE_RENDER_TEMPLATE_DIRECT`
>
> Render a document from a base64-encoded template and JSON data without separately uploading the template. The response is wrapped as a downloadable file; when download is disabled, that file contains the JSON render-ID response instead of the generated document.
>
> #### Input Parameters
>
> **data** `string` *required*
>
> Data to merge into the template as a JSON object or an array of objects. Use \{d.fieldname} placeholders in the template.
>
> **enum** `object`
>
> Enumerations to use with convEnum formatter, e.g., \{'ORDER\_STATUS': \['open', 'close']}
>
> **lang** `string`
>
> Locale of the generated document, e.g., 'en-us'
>
> **download** `boolean`
>
> If true, returns the generated file directly. If false, returns a JSON response with renderId for async generation.
>
> **template** `string` *required*
>
> Base64-encoded template content. Supported formats: DOCX, XLSX, PPTX, ODT, ODS, ODP, ODG, XHTML, IDML, HTML, or XML files.
>
> **timezone** `string`
>
> Convert document dates to this timezone, e.g., 'Europe/Paris'
>
> **convertTo** `string`
>
> Output file format as a string (e.g., 'pdf', 'docx'), or an object with formatName and formatOptions
>
> **complement** `object`
>
> Extra data object merged into the template with tags \{c.}
>
> **reportName** `string`
>
> Static or dynamic file name returned in the content-disposition header, e.g., '\{d.date}.odt'
>
> **batchOutput** `string ("zip" | "pdf")`
>
> Output type for batch processing: 'zip' or 'pdf'
>
> **hardRefresh** `boolean`
>
> Force recompute pagination and table of contents
>
> **variableStr** `string`
>
> Predefined alias for template variables, e.g., '\{#def = d.id}'
>
> **batchSplitBy** `string`
>
> Batch processing split key, e.g., 'd.items'
>
> **translations** `object`
>
> Localization dictionary for translations formatter, e.g., \{'fr-ca': \{'one': 'un'}}
>
> **currencyRates** `object`
>
> Mapping of currency codes to exchange rates
>
> **currencySource** `string`
>
> Currency source code for conversions, e.g., 'EUR'
>
> **currencyTarget** `string`
>
> Target currency code for conversions, e.g., 'USD'
>
> **carbone-version** `string`
>
> API version to use (3, 4, or 5). Specify this to override the default API version.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Carbone API Version
>
> **Slug:** `CARBONE_SET_API_VERSION`
>
> Tool to set the Carbone API version to be used for subsequent requests. Use before rendering or managing templates to ensure correct version is applied.
>
> #### Input Parameters
>
> **version** `integer` *required*
>
> Major Carbone API version (e.g., 4)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Template Metadata
>
> **Slug:** `CARBONE_UPDATE_TEMPLATE`
>
> Tool to update metadata and attributes of an existing Carbone template. Use when you need to modify template name, comment, tags, category, or control version deployment and lifecycle.
>
> #### Input Parameters
>
> **name** `string`
>
> Template name to set or update.
>
> **tags** `array`
>
> List of tags for organizing and filtering templates.
>
> **comment** `string`
>
> Template comment or description for documentation purposes.
>
> **category** `string`
>
> Group multiple templates into categories, similar to folders.
>
> **expireAt** `integer`
>
> Delete the template at the specified time. Must be a UTC Unix timestamp. Values >= 42000000000 (year 3300) are treated as 'now'. Future timestamps are not allowed.
>
> **deployedAt** `integer`
>
> When generating a document with a Template ID, Carbone uses the most recent deployedAt version. Must be a UTC Unix timestamp. Values >= 42000000000 (year 3300) are interpreted as 'NOW'. Future values are not allowed.
>
> **templateId** `string` *required*
>
> Unique identifier of the template or version ID to update. This is the 64-character hexadecimal template ID (SHA-256 hash).
>
> **carbone\_version** `integer`
>
> Carbone API version to use for this request. Defaults to 5.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upload a template
>
> **Slug:** `CARBONE_UPLOAD_TEMPLATE`
>
> Upload a template file to the Carbone server to obtain a template ID for document generation. Supported template formats: DOCX, XLSX, PPTX, ODT, ODS, ODP, ODG, XHTML, IDML, HTML, or XML. Templates can contain placeholders like \{d.fieldname} that will be replaced with data during report generation.
>
> #### Input Parameters
>
> **template** `string` *required*
>
> Template file to upload. Supported formats: DOCX, XLSX, PPTX, ODT, ODS, ODP, ODG, XHTML, IDML, HTML, or XML files.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
