Create Stream
create_streamCreate a stream. Required: name and platform (e.g. none, youtube, twitch, kick, custom, customsrt). A key is required unless platform is none; for custom, instagram or rumble it must start rtmp:// or rtmps://, and for customsrt srt://. Optional settings groups (encoding, volumes, playback, transitions, video_fit, recording) and tags default sensibly. Status is managed by start_stream/stop_stream. Mirrors POST /api/v1/streams.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | No | Stream key. Required unless platform is none. custom, instagram or rumble: must start rtmp:// or rtmps://; customsrt: srt://. | |
| url | No | Optional ingest URL override. | |
| name | Yes | Stream name, max 100 chars. | |
| tags | No | Tag names to attach. Missing names are created for this account. | |
| type | No | Stream type (set at creation only). | |
| volumes | No | Volumes 0-100: main, secondary, video. | |
| encoding | No | Encoding settings: resolution, frame_rate, bitrate, audio_bitrate (128-328). | |
| platform | Yes | Target platform, e.g. none, youtube, twitch, kick, custom, customsrt. Use none to add a destination later. | |
| playback | No | Playback: mode (loop|single), video_order (loop|shuffle), audio_order (loop|shuffle), default_image_duration (1-3600s). | |
| schedule | No | Schedule: is_scheduled/scheduled_at (start), is_scheduled_end/scheduled_end_at (end), repeat_schedule (boolean), mode (null|continuous), continuous_start_type (now|scheduled), continuous_stop_type (never|scheduled), continuous_stop_at, stream_duration_hours/stream_duration_minutes and break_duration_hours/break_duration_minutes (continuous mode active/break time per cycle, each combo >=5min), preserve_state (resume playback after a continuous-mode cycle restart). | |
| recording | No | Recording: enabled (boolean). | |
| video_fit | No | Video fit: object_fit (cover|contain), style, background_color. | |
| description | No | Optional description. | |
| transitions | No | Transitions: fade_duration (0-20), animation_type (random|fade|slide|scale|swipeAway), animation_duration (0-20). |