Sign in

v2

latestOpenAPI 3.1.02026-08-013435189.7 KB
streams

Schedule a stream

Move the stream into Scheduled with a future start via streamlifecycle.Transition(_, CmdSchedule{StartAt, EndAt}). scheduleEndAt is optional; open-ended schedules are supported.

post/streams/{id}/schedule

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.

Request body

scheduleEndAtstring date-time nullable
scheduleStartAtstring date-time required

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