Carbone icon

Carbone

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

Render Document → Download Document

AI-generated

Summary

Downloads a previously generated Carbone document using its Render ID and returns the file as binary data.

Inputs

  • Render ID (required) — The ID of the generated document. Use an ID from Generate with Return Render ID enabled or from asynchronous generation via a webhook.

Output shape

A single item containing binary document data and JSON metadata.

Binary data is stored in the data property. JSON includes success, renderId, fileName, and size in bytes. The filename comes from the response headers when available, otherwise it is document. The generated document is available for one hour and can be downloaded once.

Examples

Example 1: Use a Render ID returned by Generate or sent to the configured webhook, then pass it to this operation to retrieve the generated document.

Set Render ID to the generated document's ID.

Links

Discussion