---
title: "Retrieve a generated document."
method: GET
path: "/render/{renderId}"
tags: ["Document"]
---

# Retrieve a generated document.

`GET /render/{renderId}`

## Request

- Base URL: `https://api.carbone.io`
- URL: `https://api.carbone.io/render/{renderId}`
- Auth: none required
- TypeScript: <https://skmtc.dev/carbone/apis/carbone-api/docs/render/:renderId/get.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Path parameters

- `renderId` string, required

## Query parameters

- `download` boolean

## Headers

- `carbone-version` string

## Response `200`

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.

## Other responses

- `400`: The `render ID` is not valid
- `404`: Document not found, typically already retrieved and deleted.

## Changes

- **2026-11-06** `c06cc573e3b0`: 4 info
  - the `header` request parameter `carbone-version` became optional
  - for the `header` request parameter `carbone-version`, the type was generalized from `integer` to `string`, and format from `int32` to no format
  - removed the non-success response with the status `401`
  - added the optional property `code` to the response with the `404` status
- **2026-06-13** `fb25492a25ce`: 1 info
  - added the media type `image/webp` for the response with the status `200`

[Operation history](https://skmtc.dev/carbone/apis/carbone-api/changes/render/:renderId/get.md)

---

[API](https://skmtc.dev/carbone/apis/carbone-api.md) - [All operations](https://skmtc.dev/carbone/apis/carbone-api/llms.txt) - [OpenAPI document](https://skmtc.dev/carbone/apis/carbone-api/revisions/c06cc573e3b0?raw)