Wait for the result of a render

GET 
/renders/:id/result

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.

Request

Responses

200

The render has succeeded.

202

The render is still queued or rendering.

Response Headers

Location

This URL again.

Retry-After

Seconds to wait before asking again.

404

Not found in the workspace of the key: not_found, or template_not_found for a template or version.

422

The request was understood but cannot be rendered: data that does not fit the schema (data_validation_error), a template error (template_syntax_error, template_runtime_error, with location), a page that does not load (navigation_failed), a page or size limit of the plan (page_limit_exceeded, output_too_large), a source a PDF step cannot use (source_not_found, source_invalid, source_encrypted), or an e-invoice or PDF/UA failure.

default

Error (RFC 9457 problem details).