Skip to main content
GET
Watch render state through Server-Sent Events
The server sends a snapshot first, emits a heartbeat every 10 to 15 seconds, and closes the stream after ready, failed, or cancelled. Reconnect with Last-Event-ID to resume after a snapshot. If the event history has expired, call Get Video (GET /v1/videos/{render_id}) and reconnect from the current state.

Request parameters

Response

Returns 200 OK with a text/event-stream body. Business events carry a JSON data payload; heartbeats may omit data. Each Render event’s data field:

Examples

Prefer this endpoint over polling Get Video when you can hold a long-lived connection — it removes polling latency and load without changing how you interpret render state.

Next step

Once a ready event arrives, use Download Render or the event’s own video_url/alpha_url to fetch the result.

Authorizations

Authorization
string
header
required

Server-side SDK clients use a project API key. Remote MCP clients use an OAuth access token. Never expose a project API key in browser code.

Headers

Last-Event-ID
string

ID of the last SSE event the client processed completely. Send it on reconnection so the server can resume after that event when retained history is available.

Minimum string length: 1
X-Request-Id
string

Optional caller-supplied correlation ID, up to 128 characters. The service returns the effective value in the response header for tracing and support.

Required string length: 1 - 128
X-Viggle-Source
string

Optional source-channel label, up to 128 characters, used to attribute traffic to an SDK, integration, product surface, or internal workflow.

Required string length: 1 - 128

Path Parameters

render_id
string
required

Public Render ID returned by render creation or listing. It normally begins with render_ and must identify a render owned by the caller.

Minimum string length: 1

Response

Server-Sent Events stream. Business event data fields contain a JSON RenderEventData value. Heartbeats may omit data.

UTF-8 Server-Sent Events stream.