Enqueue a render for asynchronous processing. Returns immediately with a job id you can poll or receive via webhook.

POST/v1/rendersAuth required

Body parameters

template_idrequired

string (uuid)

ID of a template in your workspace.

actionrequired

string

What to render.

pdfpreview

format

string

Output format.

pdfpngwebp

datarequired

object

Field values (same shape as /v1/render).

scale

number

default: 1

Output scale multiplier for raster formats. Ignored for PDF.

Response

202 Accepted — the job is queued, not finished. Every response also carries a request_id; quote it if you ever ask us what happened to a call.

json

{
  "id": "d1e2f3a4-5b6c-7d8e-9f0a-b1c2d3e4f5a6",
  "render_id": "0a9b8c7d-6e5f-4a3b-8c7d-6e5f4a3b2c1d",
  "status": "queued",
  "request_id": "761263c5-0f4f-4dc9-b79d-86efc0a8b074"
}

id is the job id used with GET /v1/renders/:id. render_id is the row created in your Renders history — you can watch it in real time from the Renders page in the dashboard.

Poll the job with GET /v1/renders/:id, or configure a webhook endpoint for your workspace to receive push notifications.