---
title: "Changes to Generate a document."
method: POST
path: "/render/{templateId-or-versionId}"
---

# Changes to Generate a document.

`POST /render/{templateId-or-versionId}`

> Every recorded change to this operation, newest first.

## Timeline

Changed in 2 of 4 revisions.

- **2026-11-06** `c06cc573e3b0`: 11 breaking, 2 warning, 77 info
- **2026-06-13** `fb25492a25ce`: 2 breaking, 18 info

## Changes

- **2026-11-06** `c06cc573e3b0`: 11 breaking, 2 warning, 77 info
  - the `carbone-version` request header's property undefined was restricted to a list of enum values
  - the `header` request parameter `carbone-version` was restricted to a list of enum values
  - for the `query` request parameter `download`, default value was changed from `true` to `false`
  - request property `batchOutput` was restricted to a list of enum values
  - request property `convertTo/oneOf[subschema #2]/formatOptions/Changes` was restricted to a list of enum values
  - request property `convertTo/oneOf[subschema #2]/formatOptions/MaxImageResolution` was restricted to a list of enum values
  - request property `convertTo/oneOf[subschema #2]/formatOptions/Printing` was restricted to a list of enum values
  - request property `convertTo/oneOf[subschema #2]/formatOptions/SelectPdfVersion` was restricted to a list of enum values
  - request property `converter` was restricted to a list of enum values
  - the `convertTo/oneOf[subschema #2]/formatOptions/PixelHeight` request property type changed from `number` to `integer`
  - the `convertTo/oneOf[subschema #2]/formatOptions/PixelWidth` request property type changed from `number` to `integer`
  - the `convertTo/oneOf[subschema #2]/formatOptions/Quality` request property's max was set to `100.00`
  - the `convertTo/oneOf[subschema #2]/formatOptions/Quality` request property's min was set to `0.00`
  - added the new optional `header` request parameter `carbone-egress-header-authorization`
  - added the new optional `header` request parameter `carbone-webhook-header-authorization`
  - added the new optional `header` request parameter `carbone-webhook-url`
  - added the new optional request property `convertTo/oneOf[subschema #2]/formatOptions/AllowDuplicateFieldNames`
  - added the new optional request property `convertTo/oneOf[subschema #2]/formatOptions/CenterWindow`
  - added the new optional request property `convertTo/oneOf[subschema #2]/formatOptions/ConvertOOoTargetToPDFTarget`
  - added the new optional request property `convertTo/oneOf[subschema #2]/formatOptions/DisplayPDFDocumentTitle`
  - added the new optional request property `convertTo/oneOf[subschema #2]/formatOptions/EnableCopyingOfContent`
  - added the new optional request property `convertTo/oneOf[subschema #2]/formatOptions/EnableTextAccessForAccessibilityTools`
  - added the new optional request property `convertTo/oneOf[subschema #2]/formatOptions/ExportBookmarks`
  - added the new optional request property `convertTo/oneOf[subschema #2]/formatOptions/ExportBookmarksToPDFDestination`
  - added the new optional request property `convertTo/oneOf[subschema #2]/formatOptions/ExportFormFields`
  - added the new optional request property `convertTo/oneOf[subschema #2]/formatOptions/ExportLinksRelativeFsys`
  - added the new optional request property `convertTo/oneOf[subschema #2]/formatOptions/ExportNotes`
  - added the new optional request property `convertTo/oneOf[subschema #2]/formatOptions/ExportNotesPages`
  - added the new optional request property `convertTo/oneOf[subschema #2]/formatOptions/FirstPageOnLeft`
  - added the new optional request property `convertTo/oneOf[subschema #2]/formatOptions/FormsType`
  - added the new optional request property `convertTo/oneOf[subschema #2]/formatOptions/FullPage`
  - added the new optional request property `convertTo/oneOf[subschema #2]/formatOptions/HideViewerMenubar`
  - added the new optional request property `convertTo/oneOf[subschema #2]/formatOptions/HideViewerToolbar`
  - added the new optional request property `convertTo/oneOf[subschema #2]/formatOptions/HideViewerWindowControls`
  - added the new optional request property `convertTo/oneOf[subschema #2]/formatOptions/InitialPage`
  - added the new optional request property `convertTo/oneOf[subschema #2]/formatOptions/InitialView`
  - added the new optional request property `convertTo/oneOf[subschema #2]/formatOptions/IsAddStream`
  - added the new optional request property `convertTo/oneOf[subschema #2]/formatOptions/IsSkipEmptyPages`
  - added the new optional request property `convertTo/oneOf[subschema #2]/formatOptions/Magnification`
  - added the new optional request property `convertTo/oneOf[subschema #2]/formatOptions/OpenBookmarkLevels`
  - …50 more
- **2026-06-13** `fb25492a25ce`: 2 breaking, 18 info
  - for the `query` request parameter `download`, default value was changed from `false` to `true`
  - the `convertTo` request property type changed from `string` to no type
  - added the new optional request property `batchReportName`
  - added `subschema #1, subschema #2` to the `convertTo` request property `oneOf` list
  - added the media type `application/msword` for the response with the status `200`
  - added the media type `application/rtf` for the response with the status `200`
  - added the media type `application/vnd.ms-excel` for the response with the status `200`
  - added the media type `application/vnd.ms-excel.sheet.binary.macroenabled.12` for the response with the status `200`
  - added the media type `application/vnd.oasis.opendocument.presentation-template` for the response with the status `200`
  - added the media type `application/vnd.oasis.opendocument.spreadsheet-template` for the response with the status `200`
  - added the media type `application/vnd.oasis.opendocument.text-template` for the response with the status `200`
  - added the media type `application/xhtml+xml` for the response with the status `200`
  - added the media type `application/zip` for the response with the status `200`
  - added the media type `image/webp` for the response with the status `200`
  - added the media type `image/x-portable-bitmap` for the response with the status `200`
  - added the media type `image/x-portable-graymap` for the response with the status `200`
  - added the media type `image/x-portable-pixmap` for the response with the status `200`
  - added the media type `image/x-wmf` for the response with the status `200`
  - added the media type `text/markdown` for the response with the status `200`
  - added the non-success response with the status `413`

---

[Operation](https://skmtc.dev/carbone/apis/carbone-api/docs/render/:templateId-or-versionId/post.md) - [API](https://skmtc.dev/carbone/apis/carbone-api.md) - [Page](https://skmtc.dev/carbone/apis/carbone-api/changes/render/:templateId-or-versionId/post)