Skip to main content
GET
Get a template render and its output artifacts

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

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

render_id
string
required
Minimum string length: 1

Response

Template render

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