Skip to main content
POST
Stop a stream

Authorizations

Authorization
string
header
required

OAuth 2.1 authorization-code flow with PKCE.

Headers

Idempotency-Key
string

Optional client-generated key. A repeated request with the same key replays the original response (within 24h) instead of re-executing — safe retries.

Path Parameters

id
string
required

Resource identifier.

Response

Successful response.

createdAt
string<date-time>
required
id
string
required
framerate
enum<string> | null
Available options:
f_24,
f_25,
f_30,
f_60
name
string | null
quality
enum<string> | null
Available options:
q_720p,
q_1080p,
q_1440p,
q_2160p
state
enum<string> | null
Available options:
draft,
invalid,
scheduled,
preparing,
activating,
active,
failing,
failed,
stopping,
stopped