Carbone icon

Carbone

Interact with Carbone.io API to manage templates and generate documents

Actions11

Render Document → Generate

AI-generated

Summary

Generate a document by merging JSON data into a Carbone template, optionally converting the result to another format. The template can come from Carbone by ID, an incoming binary property, or a base64 string; generation can return the file or a Render ID/JSON response for asynchronous or later download.

Inputs

  • Template Source (required) — Choose a template stored on Carbone, a file from an incoming binary property, or a base64-encoded template string.
  • Template ID (required) — When using a stored template, select or enter its ID.
  • Binary Property Name (required) — When using a file, name the incoming binary field containing the template; defaults to data.
  • Template (Base64) (required) — When using a base64 source, provide the encoded template.
  • Data (required) — JSON merged into the template and referenced with Carbone tags such as {d.firstName}.
  • Convert To — Optionally convert the result to a listed format; the default keeps the template format.
  • Converter — When converting to PDF, choose Carbone ICE, Chromium, LibreOffice, or OnlyOffice. Defaults to LibreOffice.
  • Return Render ID — Return a Render ID/JSON response instead of the generated file. A webhook URL also makes generation asynchronous and causes JSON to be returned regardless of this setting.
  • Format Options — Optional PDF security, watermark, and LibreOffice settings, image settings, or CSV settings, depending on the selected output format.
  • Document Generation Additional Options — Optional settings for batch rendering, complementary data, currency formatting, naming, authorization headers, failure conditions, refresh, locale, feature level, timezone, translations, template variables, and webhook delivery. Batch splitting requires a webhook URL.

Output shape

One output item per input item; normally includes JSON metadata and the generated file in binary property data.

For synchronous file output, JSON contains success, fileName, and size. With Return Render ID or a webhook URL, the output is JSON from the Carbone API rather than the file; webhook mode sends a POST to the configured URL when rendering is ready. Use the Download Document action with the Render ID to retrieve the file.

Links

Discussion