- Category: documents
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 11
- Triggers: 0
- Slug:
CARBONE - Version: 20261101_00
Tools
Delete Carbone Template
Delete Carbone Template
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
The 64-character hexadecimal template ID (SHA-256 hash) to delete. Obtain this from the upload_template action response.
Output
Download Template
Download Template
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
The unique identifier (SHA256 hash) of the template to download. Obtain this from the upload template action or generate template ID action.
Output
Generate Carbone Report
Generate Carbone Report
Get Carbone Server Status
Get Carbone Server Status
List Template Categories
List Template Categories
List Templates
List Templates
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
Filter by Template ID (64-bit format). Providing a Version ID (SHA256 format) is not allowed and will result in an API error.
A cursor to use in pagination. The cursor defines your place in the list for fetching the next set of results.
Search in template name (fuzzy search), Version ID (exact match), or Template ID (exact match).
Output
Render Template Direct
Render Template Direct
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
Data to merge into the template as a JSON object or an array of objects. Use {d.fieldname} placeholders in the template.
If true, returns the generated file directly. If false, returns a JSON response with renderId for async generation.
Base64-encoded template content. Supported formats: DOCX, XLSX, PPTX, ODT, ODS, ODP, ODG, XHTML, IDML, HTML, or XML files.
Output file format as a string (e.g., ‘pdf’, ‘docx’), or an object with formatName and formatOptions
Output
Set Carbone API Version
Set Carbone API Version
Update Template Metadata
Update Template Metadata
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
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.
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.
Unique identifier of the template or version ID to update. This is the 64-character hexadecimal template ID (SHA-256 hash).
Output
Upload a template
Upload a template
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
Template file to upload. Supported formats: DOCX, XLSX, PPTX, ODT, ODS, ODP, ODG, XHTML, IDML, HTML, or XML files.