Renders

Render PDFs, images and Word or PowerPoint files from templates, HTML or URLs, one at a time or as a batch, and read the renders back.

📄️Create a render

Renders a PDF, an image, or a Word or PowerPoint file from a stored template, from ad-hoc HTML

📄️List renders

The renders of the key's workspace, newest first, failed ones and PDF tool results included, a page at a time. The render log keeps a render for 13 months, longer only while its file is stored; after that, it and its batch answer 404. Needs `render:read`.

📄️Get a render

One render of the key's workspace. While the output is stored the answer carries a fresh `download_url`, so read the render again for a new signed link. The SDKs poll this until `status` is `succeeded` or `failed`. Needs `render:read`.

📄️Wait for the result of a render

The URL in the `Location` of a `202` from `POST /renders`. While the render is queued or rendering, the answer is `202` with the render, the same `Location` and a `Retry-After`. Once it has finished, the answer is what the synchronous request would have returned: the render, the file with `output=binary`, or the render's error as a problem with its `render_id` and the HTTP status of that error. Clients that follow a `202` on their own, such as Power Automate and Logic Apps, therefore wait for the document. The SDKs wait by polling `GET /renders/{id}` instead. Needs `render:read`.

📄️Get the request of a render

The stored request of a render, as what renders it again: the template and version (or the HTML and engine, or the URL), the data, the locale and the options. Requests are kept only when the workspace turns on 'Keep render requests' (off by default; 24 hours from Starter, 7 days from Pro); otherwise, and after the period, the answer is 410 `render_input_expired`. Passwords are never kept. Needs the `render:input` scope, which new keys do not have by default; every read is written to the audit log.

📄️Delete stored outputs of a render

Deletes every stored file of a render before it expires: the document, the XML an e-invoice

📄️Create a batch of renders

Up to 1,000 renders in one job, always asynchronous: the answer is `202` with the job, and

📄️Get a batch job

A batch with its counts, every item as a render, and the zip's link once a batch with `zip` has finished. Needs `render:read`.