Autype icon

Autype

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

Actions42

Bulk Render → Create From File

AI-generated

Summary

Submit a CSV, Excel, or JSON data file to perform a bulk document render using a persistent template, with options to poll for completion and download the rendered files as a ZIP archive.

Inputs

  • documentId (required) — ID of the persistent document template to render.
  • format (required) — Output file format for generated documents (PDF, DOCX, or ODT).
  • binaryPropertyName (required) — Name of the binary property containing the input CSV, Excel, or JSON file.
  • waitForCompletion — Whether to poll the API and wait for the bulk render job to complete before returning.
  • downloadOutput — Whether to automatically download the resulting ZIP archive as binary data when the job completes.
  • additionalFields — Optional settings, including a Webhook URL to receive a POST callback upon job completion or failure.

Output shape

a JSON object with bulk job metadata, or binary data containing a ZIP archive

When 'Wait for Completion' and 'Download Output' are both true and rendering succeeds, returns binary data under property 'data' along with fileName and mimeType in JSON. Otherwise, returns a JSON object with job status details including bulkJobId.

Examples

Example 1: Start a bulk render job asynchronously using a CSV file

Document ID: 'doc_abc123', Output Format: 'PDF', Input Data Field: 'data', Wait for Completion: false

Example 2: Render documents from a file and download ZIP output immediately

Document ID: 'doc_abc123', Output Format: 'DOCX', Input Data Field: 'data', Wait for Completion: true, Download Output: true

Links

Discussion