Live Streams

Create a live stream

Creates a new live stream. Once created, an encoder can connect to Mux via the specified stream key and begin streaming to an audience.

post/video/v1/live-streams

Request body

playback_policyPlaybackPolicy[]

Deprecated. Use playback_policies instead, which accepts an identical type.

playback_policiesPlaybackPolicy[]

An array of playback policy names that you want applied to this live stream and available through playback_ids. Options include:

"public" (anyone with the playback URL can stream the live stream).
"signed" (an additional access token is required to play the live stream).

If no playback_policies is set, the live stream will have no playback IDs and will therefore not be playable. For simplicity, a single string name can be used in place of the array in the case of only one playback policy.

reconnect_windownumber float

When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to reconnect before considering the live stream finished and completing the recorded asset. Defaults to 60 seconds on the API if not specified.

If not specified directly, Standard Latency streams have a Reconnect Window of 60 seconds; Reduced and Low Latency streams have a default of 0 seconds, or no Reconnect Window. For that reason, we suggest specifying a value other than zero for Reduced and Low Latency streams.

Reduced and Low Latency streams with a Reconnect Window greater than zero will insert slate media into the recorded asset while waiting for the streaming software to reconnect or when there are brief interruptions in the live stream media. When using a Reconnect Window setting higher than 60 seconds with a Standard Latency stream, we highly recommend enabling slate with the use_slate_for_standard_latency option.

use_slate_for_standard_latencyboolean

By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream.

reconnect_slate_urlstring

The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. If this is not set, the default slate media will be used.

passthroughstring

audio_onlyboolean

Force the live stream to only process the audio track when the value is set to true. Mux drops the video track if broadcasted.

reduced_latencyboolean

This field is deprecated. Please use latency_mode instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this if you want lower latency for your live stream. Read more here: https://mux.com/blog/reduced-latency-for-mux-live-streaming-now-available/

low_latencyboolean

This field is deprecated. Please use latency_mode instead. Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This typically has lower latency than Reduced Latency streams, and cannot be combined with Reduced Latency.

latency_mode'low' | 'reduced' | 'standard'

Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags.

testboolean

Marks the live stream as a test live stream when the value is set to true. A test live stream can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test live streams created. Test live streams are watermarked with the Mux logo and limited to 5 minutes. The test live stream is disabled after the stream is active for 5 mins and the recorded asset also deleted after 24 hours.

max_continuous_durationinteger

The time in seconds a live stream may be continuously active before being disconnected. Defaults to 12 hours.

Response

Created

Changes

Changed in 13 of the 28 revisions of this API.21649

Jan 7, 202683dc80cce4d622See the full diff
- ●
  added the new auto enum value to the data/new_asset_settings/input/items/generated_subtitles/items/language_code response property for the response status 201
  response-property-enum-value-added
- ●
  added the new auto enum value to the data/new_asset_settings/inputs/items/generated_subtitles/items/language_code response property for the response status 201
  response-property-enum-value-added
- ○
  added the new auto enum value to the request property new_asset_settings/input/items/generated_subtitles/items/language_code
  request-property-enum-value-added
- ○
  added the new auto enum value to the request property new_asset_settings/inputs/items/generated_subtitles/items/language_code
  request-property-enum-value-added
Aug 5, 2025ba7ebfd893a11See the full diff
- ○
  the endpoint scheme security authorizationToken was added to the API
  api-security-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 24, 2025323c1dc63b7a55See the full diff
- ●
  added the new de enum value to the data/generated_subtitles/items/language_code response property for the response status 201
  response-property-enum-value-added
- ●
  added the new es enum value to the data/generated_subtitles/items/language_code response property for the response status 201
  response-property-enum-value-added
- ●
  added the new fr enum value to the data/generated_subtitles/items/language_code response property for the response status 201
  response-property-enum-value-added
- ●
  added the new it enum value to the data/generated_subtitles/items/language_code response property for the response status 201
  response-property-enum-value-added
- ●
  added the new pt enum value to the data/generated_subtitles/items/language_code response property for the response status 201
  response-property-enum-value-added
- ○
  added the new de enum value to the request property generated_subtitles/items/language_code
  request-property-enum-value-added
- ○
  added the new es enum value to the request property generated_subtitles/items/language_code
  request-property-enum-value-added
- ○
  added the new fr enum value to the request property generated_subtitles/items/language_code
  request-property-enum-value-added
- ○
  added the new it enum value to the request property generated_subtitles/items/language_code
  request-property-enum-value-added
- ○
  added the new pt enum value to the request property generated_subtitles/items/language_code
  request-property-enum-value-added
Jul 16, 2025211713a01eb01See the full diff
- ○
  request property playback_policies reactivated
  request-property-reactivated
Jul 2, 2025d4d7fca3b7385See the full diff
- ○
  the endpoint scheme security accessToken was added to the API
  api-security-added
- ○
  added the new optional request property meta
  new-optional-request-property
- ○
  added the new optional request property new_asset_settings/copy_overlays
  new-optional-request-property
- ○
  added the optional property data/meta to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property data/new_asset_settings/copy_overlays to the response with the 201 status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Mar 31, 20252689f5dc4d2610See the full diff
- ○
  added the new optional request property new_asset_settings/inputs
  new-optional-request-property
- ○
  added the new optional request property new_asset_settings/playback_policies
  new-optional-request-property
- ○
  added the new optional request property playback_policies
  new-optional-request-property
- ○
  request property new_asset_settings/input deprecated
  request-property-deprecated
- ○
  request property new_asset_settings/playback_policy deprecated
  request-property-deprecated
- ○
  request property playback_policy deprecated
  request-property-deprecated
- ○
  added the optional property data/new_asset_settings/inputs to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property data/new_asset_settings/playback_policies to the response with the 201 status
  response-optional-property-added
- ○
  response property data/new_asset_settings/input deprecated
  response-property-deprecated
- ○
  response property data/new_asset_settings/playback_policy deprecated
  response-property-deprecated
Mar 6, 20255f3a1cefec232See the full diff
- ○
  added the new optional request property new_asset_settings/meta
  new-optional-request-property
- ○
  added the optional property data/new_asset_settings/meta to the response with the 201 status
  response-optional-property-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 25, 20252eec862e75144See the full diff
- ○
  added the new optional request property new_asset_settings/static_renditions
  new-optional-request-property
- ○
  request property new_asset_settings/mp4_support deprecated
  request-property-deprecated
- ○
  added the optional property data/new_asset_settings/static_renditions to the response with the 201 status
  response-optional-property-added
- ○
  response property data/new_asset_settings/mp4_support deprecated
  response-property-deprecated
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 15, 20245bc9dec57cc448See the full diff
- ●
  removed the request property advanced_playback_policy
  request-property-removed
- ●
  removed the request property new_asset_settings/advanced_playback_policy
  request-property-removed
- ●
  removed the optional property data/new_asset_settings/advanced_playback_policy from the response with the 201 status
  response-optional-property-removed
- ●
  added the new premium enum value to the data/new_asset_settings/encoding_tier response property for the response status 201
  response-property-enum-value-added
- ○
  added the new optional request property advanced_playback_policies
  new-optional-request-property
- ○
  added the new optional request property new_asset_settings/advanced_playback_policies
  new-optional-request-property
- ○
  added the new optional request property new_asset_settings/video_quality
  new-optional-request-property
- ○
  request property new_asset_settings/encoding_tier deprecated
  request-property-deprecated
- ○
  added the new premium enum value to the request property new_asset_settings/encoding_tier
  request-property-enum-value-added
- ○
  added the optional property data/new_asset_settings/advanced_playback_policies to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property data/new_asset_settings/video_quality to the response with the 201 status
  response-optional-property-added
- ○
  response property data/new_asset_settings/encoding_tier deprecated
  response-property-deprecated
This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 13, 2024b1c7a231d9083See the full diff
- ○
  added the new optional request property advanced_playback_policy
  new-optional-request-property
- ○
  added the new optional request property new_asset_settings/advanced_playback_policy
  new-optional-request-property
- ○
  added the optional property data/new_asset_settings/advanced_playback_policy to the response with the 201 status
  response-optional-property-added

Full history (13 revisions)