Skip to main content
POST
Queue a short-lived browser proof render

Authorizations

Authorization
string
header
required

Batch Relay scoped API key or an anonymous Test Mode session. Scope names document required capabilities. Anonymous sessions are sandbox-only and do not authorize studio, event, billing, or Live Mode operations.

Headers

Idempotency-Key
string
required
Required string length: 1 - 200
X-BatchRelay-Client-Surface
string

Untrusted optional analytics hint naming the calling client surface. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100
X-BatchRelay-Client-Version
string

Untrusted optional analytics hint naming the calling client version. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100
X-BatchRelay-Invocation-Mode
string

Untrusted optional analytics hint naming the invocation mode. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100

Path Parameters

template_id
string
required
Minimum string length: 1
output_id
string
required
Minimum string length: 1

Query Parameters

revision_id
string
Minimum string length: 1

Body

application/json
inputs
object
required

Stable image/text bindings only. Browser pan and zoom are checkpointed into an immutable managed crop asset before submission.

output_id
string
required

Must match output_id on the request URL.

revision_id
string

Optional revision pin; when supplied it must match revision_id on the request URL.

Response

Preview render queued

profile
object
required
render_id
string
required
status
enum<string>
required
Available options:
queued,
running,
succeeded,
failed,
cancelled
artifacts
object[]

Present for succeeded preview renders; every artifact expires shortly and cannot be used for fulfillment.