Convert Template to PDF
AI-generatedSummary
Convert a PDFBolt template to PDF using provided data.
Inputs
- endpointType — Delivery method: direct, sync, or async.
- templateId (required) — UUID of a published PDFBolt template.
- templateData (required) — JSON data to fill template placeholders.
- webhook (required) — URL to receive async conversion results.
- customS3PresignedUrl — Presigned S3 URL for direct upload.
- retryDelays — Comma-separated retry delays in minutes.
- additionalWebhookHeaders — Custom headers for the async webhook callback.
- additionalOptions — Various PDF generation settings such as format, margins, and scaling.
Output shape
binary PDF file (direct) or JSON response (sync/async)
Direct endpoint returns a binary PDF with success flag and size; sync returns a JSON download URL; async returns JSON result via webhook.
Examples
Example 1: Generate PDF from template via direct response
endpointType=direct, templateId=c2b5f574..., templateData={"invoice":"INV-001"}
Example 2: Get a temporary download URL for a URL-based conversion
endpointType=sync, url=https://example.com, additionalOptions.format=Letter
Example 3: Convert large volume using async webhook
endpointType=async, webhook=https://my.webhook.com, templateId=..., templateData={"customer":"John"}, retryDelays=1,5,15