Skip to main content
POST
Render a template

Authorizations

Authorization
string
header
required

Project API key (ck_live_… or ck_test_…) presented as a bearer token. For embed partner endpoints this is the partner secret key, which is the same credential type.

Headers

Idempotency-Key
string

Make retries safe — a repeated request with the same key returns the original resource.

Path Parameters

slug
string
required

The template slug (canonical identifier within the project).

Body

application/json
data
object
required

Variable values keyed by VariableDefinition.key. Loop arrays capped at 10,000 items.

jobId
string

Optional idempotency key (the Idempotency-Key header takes precedence).

Required string length: 1 - 200
options
object

Response

Idempotent replay of an existing render.

Render shape returned by render/idempotent-replay and embed form-submit.

id
string<uuid>
required
status
enum<string>
required
Available options:
queued,
rendering,
succeeded,
failed,
cancelled
pollUrl
string<uri>
required
downloadUrl
string<uri> | null
required
errorMessage
string | null
required
createdAt
string<date-time>
required