Skip to main content
Carbone logo
  • Category: documents
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 11
  • Triggers: 0
  • Slug: CARBONE
  • Version: 20261101_00

Tools

Slug: CARBONE_DELETE_TEMPLATEDelete 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

string
required
The 64-character hexadecimal template ID (SHA-256 hash) to delete. Obtain this from the upload_template action response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARBONE_DOWNLOAD_TEMPLATETool to download a template from Carbone by template ID. Use when you need to retrieve the original template file.

Input Parameters

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARBONE_GENERATE_REPORTGenerate 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

string
required
Data to merge into the template as a JSON object or an array of objects
object
Enumerations to use with convEnum formatter, e.g. {‘ORDER_STATUS’: [‘open’, ‘close’]}
string
Locale of the generated document, e.g. ‘en-us’
string
Convert document dates to this timezone, e.g. ‘Europe/Paris’
string
Output file format as a string, e.g. ‘pdf’, or an object with formatName and formatOptions
object
Extra data object merged into the template with tags {c.}
string
Static or dynamic file name returned in the content-disposition header, e.g. ‘{d.date}.odt’
string
required
Unique identifier of the Carbone template used to generate the report
string ("zip" | "pdf")
Output type for batch processing: ‘zip’ or ‘pdf’
boolean
Force recompute pagination and table of contents
string
Predefined alias for template variables, e.g. ’{#def = d.id}’
string
Batch processing split key, e.g. ‘d.items’
object
Localization dictionary for translations formatter, e.g. {‘fr-ca’: {‘one’: ‘un’}}
object
Mapping of currency codes to exchange rates
string
Currency source code for conversions, e.g. ‘EUR’
string
Target currency code for conversions, e.g. ‘USD’
string
Webhook URL for asynchronous report generation. Include to enable async jobs.
object
Custom headers for webhook calls, as a map of header name to value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARBONE_GET_STATUSTool to retrieve the current status and health of the Carbone server. Use before generating reports to ensure the service is operational.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARBONE_LIST_TEMPLATE_CATEGORIESList categories used in deployed Carbone templates. Categories function like folders for organizing templates.

Input Parameters

integer
Carbone API version to use.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARBONE_LIST_TEMPLATESTool 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

string
Filter by Template ID (64-bit format). Providing a Version ID (SHA256 format) is not allowed and will result in an API error.
integer
Limit the number of items (100 by default).
string
A cursor to use in pagination. The cursor defines your place in the list for fetching the next set of results.
integer ("0" | "1")
Template upload origin.
Search in template name (fuzzy search), Version ID (exact match), or Template ID (exact match).
string
Filter by category.
string
Filter by Version ID (SHA256 format).
integer
Carbone API version to use.
boolean
By default equals to false. Use true to list all versions for a specific template ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARBONE_LIST_TEMPLATE_TAGSList tags currently used in deployed Carbone templates, for discovering labels used to categorize documents or versions.

Input Parameters

integer
Carbone API version to use for this request. Defaults to 5.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARBONE_RENDER_TEMPLATE_DIRECTRender 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

string
required
Data to merge into the template as a JSON object or an array of objects. Use {d.fieldname} placeholders in the template.
object
Enumerations to use with convEnum formatter, e.g., {‘ORDER_STATUS’: [‘open’, ‘close’]}
string
Locale of the generated document, e.g., ‘en-us’
boolean
If true, returns the generated file directly. If false, returns a JSON response with renderId for async generation.
string
required
Base64-encoded template content. Supported formats: DOCX, XLSX, PPTX, ODT, ODS, ODP, ODG, XHTML, IDML, HTML, or XML files.
string
Convert document dates to this timezone, e.g., ‘Europe/Paris’
string
Output file format as a string (e.g., ‘pdf’, ‘docx’), or an object with formatName and formatOptions
object
Extra data object merged into the template with tags {c.}
string
Static or dynamic file name returned in the content-disposition header, e.g., ‘{d.date}.odt’
string ("zip" | "pdf")
Output type for batch processing: ‘zip’ or ‘pdf’
boolean
Force recompute pagination and table of contents
string
Predefined alias for template variables, e.g., ’{#def = d.id}’
string
Batch processing split key, e.g., ‘d.items’
object
Localization dictionary for translations formatter, e.g., {‘fr-ca’: {‘one’: ‘un’}}
object
Mapping of currency codes to exchange rates
string
Currency source code for conversions, e.g., ‘EUR’
string
Target currency code for conversions, e.g., ‘USD’
string
API version to use (3, 4, or 5). Specify this to override the default API version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARBONE_SET_API_VERSIONTool 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

integer
required
Major Carbone API version (e.g., 4)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARBONE_UPDATE_TEMPLATETool 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

string
Template name to set or update.
array
List of tags for organizing and filtering templates.
string
Template comment or description for documentation purposes.
string
Group multiple templates into categories, similar to folders.
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.
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.
string
required
Unique identifier of the template or version ID to update. This is the 64-character hexadecimal template ID (SHA-256 hash).
integer
Carbone API version to use for this request. Defaults to 5.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CARBONE_UPLOAD_TEMPLATEUpload 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

string
required
Template file to upload. Supported formats: DOCX, XLSX, PPTX, ODT, ODS, ODP, ODG, XHTML, IDML, HTML, or XML files.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not