CAcarbone
Document

Retrieve a generated document.

Changed on

Download a generated document using a unique render ID. This render ID is obtained from a successful call to the POST /render/{templateId-or-versionId} endpoint. The retrieved document is provided as a file stream, which can be directly downloaded or viewed.

Features

  • Document Retrieval: Access generated documents using a unique render ID, ensuring secure and direct retrieval.
  • Single-Use Access: The document is deleted immediately after retrieval, ensuring privacy and reducing server storage usage. Subsequent calls with the same render ID will result in a 404 error, as the document is no longer available.

Authentication

No authentication header is required for this API call, simplifying integration and access for end-users.

get/render/{renderId}

Request

Path parameters

renderIdstring required

Unique identifier of the report

Query parameters

downloadboolean

If set to true, changes Content-Disposition from inline to attachment, for direct download.

Headers

carbone-versionstring

Optional for this endpoint: the Authorization and carbone-version headers are not required to download a generated document.

Response

Stream of the generated document. The content type will correspond to the format of the generated document, which can be any of the supported output file formats.

Changes

  • c06cc573e3b0Revision changes
    • info

      the header request parameter carbone-version became optional

    • info

      for the header request parameter carbone-version, the type was generalized from integer to string, and format from int32 to no format

    • info

      removed the non-success response with the status

    • info

      added the optional property to the response with the status

  • fb25492a25ceRevision changes
    • info

      added the media type image/webp for the response with the status