v31

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-28124212862.9 KB
Live Streams

Create a live stream simulcast target

Create a simulcast target for the parent live stream. Simulcast target can only be created when the parent live stream is in idle state. Only one simulcast target can be created at a time with this API.

post/video/v1/live-streams/{LIVE_STREAM_ID}/simulcast-targets

Path parameters

LIVE_STREAM_IDstring required

The live stream ID

Request body

passthroughstring

Arbitrary user-supplied metadata set by you when creating a simulcast target.

stream_keystring

Stream Key represents a stream identifier on the third party live streaming service to send the parent live stream to. Only used for RTMP(s) simulcast destinations.

urlstring required

The RTMP(s) or SRT endpoint for a simulcast destination.

  • For RTMP(s) destinations, this should include the application name for the third party live streaming service, for example: rtmp://live.example.com/app.
  • For SRT destinations, this should be a fully formed SRT connection string, for example: srt://srt-live.example.com:1234?streamid={stream_key}&passphrase={srt_passphrase}.

Note: SRT simulcast targets can only be used when an source is connected over SRT.

Response

Created