Autype icon

Autype

Interact with the Autype Developer API for document generation, PDF tools, and more

Actions42

Render → Render Persistent Document

AI-generated

Summary

Render a persistent document by ID, optionally overriding format, merging variables, and conditionally downloading the output as binary data.

Inputs

  • documentId (required) — ID of the persistent document to render
  • waitForCompletion — Whether to wait for the render job to complete before returning
  • downloadOutput — Whether to automatically download the output file as binary data after completion
  • renderDocumentOptions — Options for rendering the persistent document, including format override, variable merging, and webhook URL

Output shape

If waitForCompletion is true and the job completes with downloadOutput true, returns binary data (file download) paired with the current item. Otherwise returns JSON job data paired with the current item. Paired item structure: { item: i }.

Binary download occurs only when waitForCompletion=true, downloadOutput=true, and render job status is COMPLETED. If waitForCompletion is false, returns immediate JSON response after API POST.

Examples

Example 1: Render a persistent document and wait for completion with auto-download

documentId provided, waitForCompletion=true, downloadOutput=true, renderDocumentOptions.format=pdf

Links

Discussion