Rendering

Render PDF

Validates data against the template's schema, compiles the template, and returns the PDF. Requires a published template and a plan with REST API access (Starter and higher).

Send "async": true to render in the background instead: the response is 202 with a job handle; poll the job or wait for the render.completed / render.failed webhook. Async renders count toward the same monthly quota as synchronous ones.

Webhook events for this render go to every enabled endpoint of the organization, or only to the endpoints in webhookIds when provided (an empty list sends nowhere).

post/v2/organizations/{organizationId}/templates/{externalId}/render

Request

  • Base URL: https://api.pdfs.build
  • URL: https://api.pdfs.build/v2/organizations/{organizationId}/templates/{externalId}/render
  • Auth: HTTP bearer

Request body

dataobject

Key-value pairs matching the template's schema. Defaults to {}.

asyncboolean

Render in the background and return 202 with a job handle. version is resolved when the job is queued, as for a batch: one that does not exist is a 400, and a channel is held to the version it named then.

webhookIdsstring[]

Restrict this render's webhook events to these endpoint ids (whe_...). Unknown ids fail with 422 unknown_webhook_ids. Omitted: all enabled endpoints. []: none.

Example request

{
  "version": "latest"
}

Response

The rendered PDF.

Changes

No recorded changes to this operation across all 1 revision of this API.