Sign in

v2

latestOpenAPI 3.1.02026-08-013435189.7 KB
streams

Start a stream

Move the stream into Activating via streamlifecycle.Transition(_, CmdStart). Returns the loaded stream after the lifecycle owner accepted the command. The resolver does not block on the orchestrator/agent observing the change.

Typed errors (extensions.code):

  • STREAM_ILLEGAL_TRANSITION when the current state forbids start
  • STREAM_GUARD_FAILED when a pre-flight guard rejected start (Extensions carries reason + cause).
post/streams/{id}/start

Path parameters

idstring required

Resource identifier.

Headers

Idempotency-Keystring

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

Response

Successful response.

createdAtstring date-time required
framerate'f_24' | 'f_25' | 'f_30' | 'f_60' nullable
idstring required
namestring nullable
quality'q_720p' | 'q_1080p' | 'q_1440p' | 'q_2160p' nullable
state'draft' | 'invalid' | 'scheduled' | 'preparing' | 'activating' | 'active' | 'failing' | 'failed' | 'stopping' | 'stopped' nullable