Tools

Carbone

Learn how to use Carbone with Composio

Overview

Enum

CARBONE

Description

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.

Authentication Details

api_key
stringRequired

Actions

Tool to delete a template from the carbone server. use after confirming you have the correct template id.

Action Parameters

templateId
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to download a template from carbone by template id. use when you need to retrieve the original template file.

Action Parameters

template_id
stringRequired

Action Response

data
object
error
string
successful
boolean
Tool to generate a carbone report from a template and json data. use when you need to render documents in various formats.

Action Parameters

batchOutput
string
batchSplitBy
string
carbone-webhook-headers
object
carbone-webhook-url
string
complement
object
convertTo
string
currencyRates
object
currencySource
string
currencyTarget
string
data
objectRequired
enum
object
hardRefresh
boolean
lang
string
reportName
string
templateId
stringRequired
timezone
string
translations
object
variableStr
string

Action Response

data
object
error
string
success
boolean
successful
boolean
Tool to generate a unique template id for a new template. use when you need the template identifier before uploading.

Action Parameters

template
stringRequired

Action Response

data
object
error
string
success
boolean
successful
boolean
Tool to retrieve the current status and health of the carbone server. use before generating reports to ensure the service is operational.

Action Parameters

Action Response

data
object
error
string
successful
boolean
Tool to upload a template to the carbone server. use when you need to add or replace a template by providing its content.

Action Parameters

template
stringRequired

Action Response

data
object
error
string
success
boolean
successful
boolean
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.

Action Parameters

version
integerRequired

Action Response

data
object
error
string
successful
boolean