Rendering

Render a batch

Queues one async render per entry in items, up to 500, against one template and one version. The version is resolved when the batch is submitted, so promoting a channel mid-batch does not mix versions. The exception is a template that renders its live draft (nothing promoted yet, or a legacy auto-publish template): the draft is not pinned, so edits made mid-batch can reach later items. The whole batch is admitted against your monthly quota or rejected with 429; a batch is never partially queued.

Items emit no per-render webhooks. On plans with webhooks (every paid plan), one batch.completed event goes to every enabled endpoint (or the webhookIds given) once every item has succeeded or failed. Poll statusUrl for per-item status and download links.

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

Request

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

Request body

webhookIdsstring[]

Endpoints to notify with batch.completed. Omitted: every enabled endpoint. Empty: none.

Example request

{
  "version": "latest"
}

Response

Batch accepted and queued.

idstring required
status'processing' required
totalinteger required
statusUrlstring uri required

Example response

{
  "id": "batch_3f6a0c1e",
  "total": 2,
  "statusUrl": "https://api.pdfs.build/v2/organizations/org_abc/batches/batch_3f6a0c1e"
}

Changes

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