File and Document Management
Carbone
14 min
carbone is a document generation api that creates pdf, docx, and other files from templates and data integrating carbone with make com allows users to automate document creation and delivery from their workflows using dynamic data this is ai generated content based on official carbone documentation the content may contain mistakes please verify important information if you have questions on vendor documentation, contact https //status carbone io/ directly requirements to use the carbone app in make, you must have a carbone cloud account and an api token or access to a running carbone onpremise instance, https //carbone io for subscription, refer to the https //carbone io connect carbone and {{product name}} to get started, you must first create a connection between carbone and {{product name}} , allowing the two services to communicate obtain your api key in your carbone account create the connection in make obtain your api key in your carbone account before you create the connection in {{product name}} , you should first obtain your api key in your carbone account to obtain your api key navigate to your account dashboard copy the api key displayed on screen you will use this value while creating a connection in {{product name}} because the ui might have changed, the steps you see on your screen might be different, https //carbone io/documentation/developer/http api/introduction html create the connection in {{product name}} https //www make com/en/register , add the carbone module to your {{scenario singular lowercase}} , and click create a connection if you add a module with an instant tag, click create a webhook , then create a connection optional in the connection name field, enter a name for the connection enter the authentication credentials you copied from your carbone account or follow the on screen instructions to create the connection for detailed information on connecting an application, see docid\ so88fm6pkt0g adkddfzz page carbone modules after connecting to the carbone app, you can choose from a list of available modules to build your {{scenario plural lowercase}} add a template uploads a new document template file to your carbone account storage for future report generation delete a template deletes an entire template along with all its versions when provided with a template id, or removes a specific template version when given a version id download a document downloads a generated document file using a specific render id, which you receive after successfully creating the document download a template retrieves and downloads a selected template or a particular version of a template from your carbone account storage generate & download a document ⚡️ creates and downloads a customized document by combining a chosen template with data from a provided json file generate a document creates a new document by combining your chosen template with data from a provided json dataset, and returns a unique render id that you can use to download the generated document get a status retrieves the current operational status of the carbone cloud api list categories retrieve a comprehensive list of all template categories, which act like folders to help you group and organize your templates for easier management list tags retrieve a list of all tags that are currently assigned to your templates, helping you organize and categorize them more effectively list templates fetches a list of available templates stored in carbone, allowing you to filter and paginate results for easier management of large template collections by default, it returns all active (non expired) deployed templates, sorted from newest to oldest based on their creation date make an api call executes a custom api request to the connected service using your authorized credentials update a template updates selected metadata and attributes for an existing template, using either its template id or version id to identify the template templates you can look for more templates in https //www make com/en/templates , where you'll find thousands of pre created {{scenario plural lowercase}} carbone resources you can have access to more resources related to this app on the following links https //community make com/search?q=carbone https //carbone io https //carbone io/documentation/developer/http api/introduction html https //www make com/en/integrations/carbone