Skip to main content
POST
Create a render from a published template

Authorizations

Authorization
string
header
required

Batch Relay scoped API key, not OAuth. Scope names document required key capabilities.

Headers

Idempotency-Key
string
required

Retries with the same key return the durable render job; reuse with a different request returns idempotency_conflict.

Required string length: 1 - 200

Path Parameters

template_id
string
required
Minimum string length: 1

Body

application/json
output_id
string
required

A published one- or multi-surface output selector, such as print-8x10-portrait or trader-card-double-sided. It owns the selected surface variants.

inputs
object
required

Explicit stable slot ID to value mapping. Labels and positional order are never interpreted by the API.

revision_id
string

Optional immutable template revision. When omitted, Batch Relay resolves the latest published revision and returns it in template.revision_id.

Response

Render queued, running, succeeded, or failed. Artifacts are always an array so multi-surface output is representable.

render_id
string
required
status
enum<string>
required
Available options:
queued,
running,
succeeded,
failed,
cancelled
template
object
required
output_id
string
required
artifacts
object[]
required
created_at
string<date-time>
required
updated_at
string<date-time>
required