Skip to main content
GET
Get one published output's render contract

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

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

Query Parameters

revision_id
string

Optional immutable published or superseded revision ID.

Minimum string length: 1

Response

Output-scoped immutable render contract

Published output-scoped render contract for one immutable revision. Slots are limited to the selected output's used runtime bindings; editor node placement and transforms are represented only by the separate browser-preview package.

output
object
required
slots
object[]
required
template
object
required