streams

Create a stream

post/streams

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

agentModeEnabledboolean nullable

Feature flag: run stream in agent mode (/agent) with replica-based orchestration.

audioUploadObjectIDstring nullable

destinationIDstring nullable

framerate'f_24' | 'f_25' | 'f_30' | 'f_60' nullable

namestring nullable

playlistIDsstring[]

preparedPlaylistIDsstring[]

quality'q_720p' | 'q_1080p' | 'q_1440p' | 'q_2160p' nullable

runBackupStreamboolean nullable

Stream preference: enable backup destination streaming in agent mode.

scheduleEndAtstring date-time nullable

scheduleStartAtstring date-time nullable

storageBackend'standard' | 'large' nullable

Storage tier for this stream's media. 'standard' suits typical playlists and is included. 'large' is for big playlists: storage is provisioned to fit your content and grows as you add to it, billed per GiB-month. Takes effect at the next stream start.

streamBackend'ffmpeg' | 'manifest' nullable

RTMP publisher backend. Editing is restricted.

streamDestination'youtube' nullable

streamDurationinteger nullable

Stream duration in seconds. 0 = never expires. Copied from user default on creation.

streamKeystring nullable

DEPRECATED: use destination_id. Kept for backward-compat during destination migration.

streamStateIDstring nullable

videoUploadObjectIDstring nullable

youtubeSettingsIDstring nullable

Response

Created.

createdAtstring date-time required