Video API reference

An asset refers to a piece of media content that is stored or is being live streamed through the Mux system. An asset always has a duration and one or more tracks (audio, video, and text data).

The media content of an asset cannot be updated once created, however an asset can be used to create another asset, and can be modified within that process.

Properties

id.

string

Unique identifier for the Asset. Max 255 characters.

created_at.

string

Time the Asset was created, defined as a Unix timestamp (seconds since epoch).

status.

string

Possible values: "preparing" "ready" "errored"

The status of the asset.

duration.

number

The duration of the asset in seconds (max duration for a single asset is 12 hours).

max_stored_resolution.

string

Possible values: "Audio only" "SD" "HD" "FHD" "UHD"

The maximum resolution that has been stored for the asset. The asset may be delivered at lower resolutions depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored.

max_stored_frame_rate.

number

The maximum frame rate that has been stored for the asset. The asset may be delivered at lower frame rates depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. This field may return -1 if the frame rate of the input cannot be reliably determined.

aspect_ratio.

string

The aspect ratio of the asset in the form of width:height, for example 16:9.

playback_ids.

array

An array of Playback ID objects. Use these to create HLS playback URLs. See Play your videos for more details.

playback_ids[].id.

string

Unique identifier for the PlaybackID

playback_ids[].policy.

string

Possible values: "public" "signed"

public playback IDs are accessible by constructing an HLS URL like https://stream.mux.com/${PLAYBACK_ID}
signed playback IDs should be used with tokens https://stream.mux.com/${PLAYBACK_ID}?token={TOKEN}. See Secure video playback for details about creating tokens.

tracks.

array

The individual media tracks that make up an asset.

tracks[].id.

string

Unique identifier for the Track

tracks[].type.

string

Possible values: "video" "audio" "text"

The type of track

tracks[].duration.

number

The duration in seconds of the track media. This parameter is not set for text type tracks. This field is optional and may not be set. The top level duration field of an asset will always be set.

tracks[].max_width.

integer

The maximum width in pixels available for the track. Only set for the video type track.

tracks[].max_height.

integer

The maximum height in pixels available for the track. Only set for the video type track.

tracks[].max_frame_rate.

number

The maximum frame rate available for the track. Only set for the video type track. This field may return -1 if the frame rate of the input cannot be reliably determined.

tracks[].max_channels.

integer

The maximum number of audio channels the track supports. Only set for the audio type track.

tracks[].max_channel_layout.

string

Only set for the audio type track.

tracks[].text_type.

string

Possible values: "subtitles"

This parameter is only set for text type tracks.

tracks[].language_code.

string

The language code value represents BCP 47 specification compliant value. For example, en for English or en-US for the US version of English. This parameter is only set for text type and subtitles text type tracks.

tracks[].name.

string

The name of the track containing a human-readable description. The hls manifest will associate a subtitle text track with this value. For example, the value is "English" for subtitles text track for the language_code value of en-US. This parameter is only set for text type and subtitles text type tracks.

tracks[].closed_captions.

boolean

Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This parameter is only set for text type and subtitles text type tracks.

tracks[].passthrough.

string

Arbitrary user-supplied metadata set for the track either when creating the asset or track. This parameter is only set for text type tracks. Max 255 characters.

tracks[].status.

string

Possible values: "preparing" "ready" "errored"

The status of the track. This parameter is only set for text type tracks.

errors.

object

Object that describes any errors that happened when processing this asset.

errors.type.

string

The type of error that occurred for this asset.

errors.messages.

array

Error messages with more details.

upload_id.

string

Unique identifier for the Direct Upload. This is an optional parameter added when the asset is created from a direct upload.

is_live.

boolean

Indicates whether the live stream that created this asset is currently active and not in idle state. This is an optional parameter added when the asset is created from a live stream.

passthrough.

string

Arbitrary user-supplied metadata set for the asset. Max 255 characters.

live_stream_id.

string

Unique identifier for the live stream. This is an optional parameter added when the asset is created from a live stream.

master.

object

An object containing the current status of Master Access and the link to the Master MP4 file when ready. This object does not exist if master_acess is set to none and when the temporary URL expires.

master.status.

string

Possible values: "ready" "preparing" "errored"

master.url.

string

The temporary URL to the master version of the video, as an MP4 file. This URL will expire after 24 hours.

master_access.

string (default: none)

Possible values: "temporary" "none"

mp4_support.

string (default: none)

Possible values: "standard" "none"

source_asset_id.

string

Asset Identifier of the video used as the source for creating the clip.

normalize_audio.

boolean

Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets.

static_renditions.

object

An object containing the current status of any static renditions (mp4s). The object does not exist if no static renditions have been requested. See Download your videos for more information.

static_renditions.status.

string (default: disabled)

Possible values: "ready" "preparing" "disabled" "errored"

Indicates the status of downloadable MP4 versions of this asset.

static_renditions.files.

array

Array of file objects.

static_renditions.files[].name.

string

Possible values: "low.mp4" "medium.mp4" "high.mp4" "audio.m4a"

static_renditions.files[].ext.

string

Possible values: "mp4" "m4a"

Extension of the static rendition file

static_renditions.files[].height.

integer

The height of the static rendition's file in pixels

static_renditions.files[].width.

integer

The width of the static rendition's file in pixels

static_renditions.files[].bitrate.

integer

The bitrate in bits per second

static_renditions.files[].filesize.

string

The file size in bytes

recording_times.

array

An array of individual live stream recording sessions. A recording session is created on each encoder connection during the live stream. Additionally any time slate media is inserted during brief interruptions in the live stream media or times when the live streaming software disconnects, a recording session representing the slate media will be added with a "slate" type.

recording_times[].started_at.

string

The time at which the recording for the live stream started. The time value is Unix epoch time represented in ISO 8601 format.

recording_times[].duration.

number

The duration of the live stream recorded. The time value is in seconds.

recording_times[].type.

BETA

string

Possible values: "content" "slate"

The type of media represented by the recording session, either content for normal stream content or slate for slate media inserted during stream interruptions.

non_standard_input_reasons.

object

An object containing one or more reasons the input file is non-standard. See the guide on minimizing processing time for more information on what a standard input is defined as. This object only exists on on-demand assets that have non-standard inputs, so if missing you can assume the input qualifies as standard.

non_standard_input_reasons.video_codec.

string

The video codec used on the input file. For example, the input file encoded with hevc video codec is non-standard and the value of this parameter is hevc.

non_standard_input_reasons.audio_codec.

string

The audio codec used on the input file. Non-AAC audio codecs are non-standard.

non_standard_input_reasons.video_gop_size.

string

Possible values: "high"

The video key frame Interval (also called as Group of Picture or GOP) of the input file is high. This parameter is present when the gop is greater than 20 seconds.

non_standard_input_reasons.video_frame_rate.

string

The video frame rate of the input file. Video with average frames per second (fps) less than 5 or greater than 120 is non-standard. A -1 frame rate value indicates Mux could not determine the frame rate of the video track.

non_standard_input_reasons.video_resolution.

string

The video resolution of the input file. Video resolution higher than 2048 pixels on any one dimension (height or width) is considered non-standard, The resolution value is presented as width x height in pixels.

non_standard_input_reasons.video_bitrate.

string

Possible values: "high"

The video bitrate of the input file is high. This parameter is present when the average bitrate of any key frame interval (also known as Group of Pictures or GOP) is higher than what's considered standard which typically is 16 Mbps.

non_standard_input_reasons.pixel_aspect_ratio.

string

The video pixel aspect ratio of the input file.

non_standard_input_reasons.video_edit_list.

string

Possible values: "non-standard"

Video Edit List reason indicates that the input file's video track contains a complex Edit Decision List.

non_standard_input_reasons.audio_edit_list.

string

Possible values: "non-standard"

Audio Edit List reason indicates that the input file's audio track contains a complex Edit Decision List.

non_standard_input_reasons.unexpected_media_file_parameters.

string

Possible values: "non-standard"

A catch-all reason when the input file in created with non-standard encoding parameters.

test.

boolean

True means this live stream is a test asset. A test asset can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test assets created. Test assets are watermarked with the Mux logo, limited to 10 seconds, and deleted after 24 hrs.

Create an asset
post

Create a new Mux Video asset.

curl https://api.mux.com/video/v1/assets \
  -X POST \
  -d '{ "input": "https://muxed.s3.amazonaws.com/leds.mp4", "playback_policy": ["public"] }' \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request body params

input

array

An array of objects that each describe an input file to be used to create the asset. As a shortcut, input can also be a string URL for a file when only one input file is used. See input[].url for requirements.

url

string

The URL of the file that Mux should download and use.

For subtitles text tracks, the URL is the location of subtitle/captions file. Mux supports SubRip Text (SRT) and Web Video Text Tracks format for ingesting Subtitles and Closed Captions.
For Watermarking or Overlay, the URL is the location of the watermark image.
When creating clips from existing Mux assets, the URL is defined with mux://assets/{asset_id} template where asset_id is the Asset Identifier for creating the clip from.

overlay_settings

object

An object that describes how the image file referenced in URL should be placed over the video (i.e. watermarking). Ensure that the URL is active and persists the entire lifespan of the video object.

vertical_align

string

Possible values: "top" "middle" "bottom"

Where the vertical positioning of the overlay/watermark should begin from. Defaults to "top"

vertical_margin

string

The distance from the vertical_align starting point and the image's closest edge. Can be expressed as a percent ("10%") or as a pixel value ("100px"). Negative values will move the overlay offscreen. In the case of 'middle', a positive value will shift the overlay towards the bottom and and a negative value will shift it towards the top.

horizontal_align

string

Possible values: "left" "center" "right"

Where the horizontal positioning of the overlay/watermark should begin from.

horizontal_margin

string

The distance from the horizontal_align starting point and the image's closest edge. Can be expressed as a percent ("10%") or as a pixel value ("100px"). Negative values will move the overlay offscreen. In the case of 'center', a positive value will shift the image towards the right and and a negative value will shift it towards the left.

width

string

How wide the overlay should appear. Can be expressed as a percent ("10%") or as a pixel value ("100px"). If both width and height are left blank the width will be the true pixels of the image, applied as if the video has been scaled to fit a 1920x1080 frame. If height is supplied with no width, the width will scale proportionally to the height.

height

string

How tall the overlay should appear. Can be expressed as a percent ("10%") or as a pixel value ("100px"). If both width and height are left blank the height will be the true pixels of the image, applied as if the video has been scaled to fit a 1920x1080 frame. If width is supplied with no height, the height will scale proportionally to the width.

opacity

string

How opaque the overlay should appear, expressed as a percent. (Default 100%)

start_time

number

The time offset in seconds from the beginning of the video indicating the clip's starting marker. The default value is 0 when not included. This parameter is only applicable for creating clips when input.url has mux://assets/{asset_id} format.

end_time

number

The time offset in seconds from the beginning of the video, indicating the clip's ending marker. The default value is the duration of the video when not included. This parameter is only applicable for creating clips when input.url has mux://assets/{asset_id} format.

type

string

Possible values: "video" "audio" "text"

This parameter is required for text type tracks.

text_type

string

Possible values: "subtitles"

Type of text track. This parameter only supports subtitles value. For more information on Subtitles / Closed Captions, see this blog post. This parameter is required for text type tracks.

language_code

string

The language code value must be a valid BCP 47 specification compliant value. For example, en for English or en-US for the US version of English. This parameter is required for text type and subtitles text type track.

name

string

The name of the track containing a human-readable description. This value must be unique across all text type and subtitles text type tracks. The hls manifest will associate a subtitle text track with this value. For example, the value should be "English" for subtitles text track with language_code as en. This optional parameter should be used only for text type and subtitles text type tracks. If this parameter is not included, Mux will auto-populate based on the input[].language_code value.

closed_captions

boolean

Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This optional parameter should be used for text type and subtitles text type tracks.

passthrough

string

This optional parameter should be used for text type and subtitles text type tracks.

playback_policy

array

An array of playback policy names that you want applied to this asset and available through playback_ids. Options include: "public" (anyone with the playback URL can stream the asset). And "signed" (an additional access token is required to play the asset). If no playback_policy is set, the asset 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.

Possible values: "public" "signed"

public playback IDs are accessible by constructing an HLS URL like https://stream.mux.com/${PLAYBACK_ID}
signed playback IDs should be used with tokens https://stream.mux.com/${PLAYBACK_ID}?token={TOKEN}. See Secure video playback for details about creating tokens.

passthrough

string

Arbitrary user-supplied metadata that will be included in the asset details and related webhooks. Can be used to store your own ID for a video along with the asset. Max: 255 characters.

mp4_support

string

Possible values: "none" "standard"

Specify what level (if any) of support for mp4 playback. In most cases you should use our default HLS-based streaming playback ({playback_id}.m3u8) which can automatically adjust to viewers' connection speeds, but an mp4 can be useful for some legacy devices or downloading for offline playback. See the Download your videos guide for more information.

normalize_audio

boolean

Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets.

master_access

string

Possible values: "none" "temporary"

Specify what level (if any) of support for master access. Master access can be enabled temporarily for your asset to be downloaded. See the Download your videos guide for more information.

test

boolean

Marks the asset as a test asset when the value is set to true. A Test asset can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test assets created. Test asset are watermarked with the Mux logo, limited to 10 seconds, deleted after 24 hrs.

post

201

/video/v1/assets

Request

(application/json)

{
  "input": [
    {
      "url": "https://muxed.s3.amazonaws.com/leds.mp4"
    }
  ],
  "playback_policy": [
    "public"
  ]
}

Response

(application/json)

{
  "data": {
    "status": "preparing",
    "playback_ids": [
      {
        "policy": "public",
        "id": "uNbxnGLKJ00yfbijDO8COxTOyVKT01xpxW"
      }
    ],
    "mp4_support": "none",
    "master_access": "none",
    "id": "SqQnqz6s5MBuXGvJaUWdXuXM93J9Q2yv",
    "created_at": "1607452572"
  }
}

List assets
get

List all Mux assets.

curl https://api.mux.com/video/v1/assets \
  -X GET \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request path & query params

limit

integer

(default: 25)

Number of items to include in the response

page

integer

(default: 1)

Offset by this many pages, of the size of limit

live_stream_id

string

Filter response to return all the assets for this live stream only

upload_id

string

Filter response to return an asset created from this direct upload only

get

200

/video/v1/assets

Response

(application/json)

{
  "data": [
    {
      "tracks": [
        {
          "type": "video",
          "max_width": 1920,
          "max_height": 800,
          "max_frame_rate": 24,
          "id": "HK01Bq7FrEQmIu3QpRiZZ98HQOOZjm6BYyg17eEunlyo",
          "duration": 734.166667
        },
        {
          "type": "audio",
          "max_channels": 2,
          "max_channel_layout": "stereo",
          "id": "nNKHJqw2G9cE019AoK16CJr3O27gGnbtW4w525hJWqWw",
          "duration": 734.143991
        }
      ],
      "status": "ready",
      "playback_ids": [
        {
          "policy": "public",
          "id": "85g23gYz7NmQu02YsY81ihuod6cZMxCp017ZrfglyLCKc"
        }
      ],
      "mp4_support": "none",
      "max_stored_resolution": "HD",
      "max_stored_frame_rate": 24,
      "master_access": "none",
      "id": "8jd7M77xQgf2NzuocJRPYdSdEfY5dLlcRwFARtgQqU4",
      "duration": 734.25,
      "created_at": "1609869152",
      "aspect_ratio": "12:5"
    },
    {
      "tracks": [
        {
          "type": "video",
          "max_width": 1920,
          "max_height": 1080,
          "max_frame_rate": 29.97,
          "id": "RiyQPM31a1SPtfI802bEP2zD02F5FQVNL801FRHeE5t01G4",
          "duration": 23.8238
        },
        {
          "type": "audio",
          "max_channels": 2,
          "max_channel_layout": "stereo",
          "id": "LvINTciHVoC017knMCH01y9pSi5OrDLCRaBPNDAoNJcmg",
          "duration": 23.823792
        }
      ],
      "status": "ready",
      "playback_ids": [
        {
          "policy": "public",
          "id": "vAFLI2eKFFicXX00iHBS2vqt5JjJGg5HV6fQ4Xijgt1I"
        }
      ],
      "mp4_support": "none",
      "max_stored_resolution": "HD",
      "max_stored_frame_rate": 29.97,
      "master_access": "none",
      "id": "lJ4bGGsp7ZlPf02nMg015W02iHQLN9XnuuLRBsPS00xqd68",
      "duration": 23.857167,
      "created_at": "1609868768",
      "aspect_ratio": "16:9"
    }
  ]
}

Retrieve an asset
get

Retrieves the details of an asset that has previously been created. Supply the unique asset ID that was returned from your previous request, and Mux will return the corresponding asset information. The same information is returned when creating an asset.

curl https://api.mux.com/video/v1/assets/${ASSET_ID} \
  -X GET \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request path & query params

ASSET_ID

string

The asset ID.

get

200

/video/v1/assets/{ASSET_ID}

Response

(application/json)

{
  "data": {
    "tracks": [
      {
        "type": "video",
        "max_width": 1920,
        "max_height": 1080,
        "max_frame_rate": 29.97,
        "id": "RiyQPM31a1SPtfI802bEP2zD02F5FQVNL801FRHeE5t01G4",
        "duration": 23.8238
      },
      {
        "type": "audio",
        "max_channels": 2,
        "max_channel_layout": "stereo",
        "id": "LvINTciHVoC017knMCH01y9pSi5OrDLCRaBPNDAoNJcmg",
        "duration": 23.823792
      }
    ],
    "status": "ready",
    "playback_ids": [
      {
        "policy": "public",
        "id": "vAFLI2eKFFicXX00iHBS2vqt5JjJGg5HV6fQ4Xijgt1I"
      }
    ],
    "mp4_support": "none",
    "max_stored_resolution": "HD",
    "max_stored_frame_rate": 29.97,
    "master_access": "none",
    "id": "lJ4bGGsp7ZlPf02nMg015W02iHQLN9XnuuLRBsPS00xqd68",
    "duration": 23.857167,
    "created_at": "1609868768",
    "aspect_ratio": "16:9"
  }
}

Delete an asset
del

Deletes a video asset and all its data.

curl https://api.mux.com/video/v1/assets/${ASSET_ID} \
  -X DELETE \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request path & query params

ASSET_ID

string

The asset ID.

del

204

/video/v1/assets/{ASSET_ID}

Update an Asset
patch

Updates the details of an already-created Asset with the provided Asset ID. This currently supports only the passthrough field.

Request body params

passthrough

string

Arbitrary metadata set for the Asset. Max 255 characters. In order to clear this value, the field should be included with an empty string value.

Request path & query params

ASSET_ID

string

The asset ID.

patch

200

/video/v1/assets/{ASSET_ID}

Request

(application/json)

{
  "passthrough": "Example"
}

Response

(application/json)

{
  "data": {
    "tracks": [
      {
        "type": "video",
        "max_width": 1920,
        "max_height": 1080,
        "max_frame_rate": 29.97,
        "id": "RiyQPM31a1SPtfI802bEP2zD02F5FQVNL801FRHeE5t01G4",
        "duration": 23.8238
      },
      {
        "type": "audio",
        "max_channels": 2,
        "max_channel_layout": "stereo",
        "id": "LvINTciHVoC017knMCH01y9pSi5OrDLCRaBPNDAoNJcmg",
        "duration": 23.823792
      }
    ],
    "status": "ready",
    "playback_ids": [
      {
        "policy": "public",
        "id": "vAFLI2eKFFicXX00iHBS2vqt5JjJGg5HV6fQ4Xijgt1I"
      }
    ],
    "mp4_support": "none",
    "max_stored_resolution": "HD",
    "max_stored_frame_rate": 29.97,
    "master_access": "none",
    "id": "lJ4bGGsp7ZlPf02nMg015W02iHQLN9XnuuLRBsPS00xqd68",
    "duration": 23.857167,
    "created_at": "1609868768",
    "updated_at": "1609869000",
    "aspect_ratio": "16:9",
    "passthrough": "Example"
  }
}

Retrieve asset input info
get

Returns a list of the input objects that were used to create the asset along with any settings that were applied to each input.

curl https://api.mux.com/video/v1/assets/${ASSET_ID}/input-info \
  -X GET \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request path & query params

ASSET_ID

string

The asset ID.

get

200

/video/v1/assets/{ASSET_ID}/input-info

Response

(application/json)

{
  "data": [
    {
      "settings": {
        "url": "https://muxed.s3.amazonaws.com/leds.mp4"
      },
      "file": {
        "container_format": "mp4",
        "tracks": [
          {
            "type": "video",
            "duration": 120,
            "width": 1280,
            "height": 720,
            "frame_rate": 30,
            "encoding": "h.264"
          },
          {
            "type": "audio",
            "duration": 120,
            "sample_rate": 16000,
            "sample_size": 24,
            "encoding": "aac"
          }
        ]
      }
    },
    {
      "settings": {
        "url": "https://example.com/myVideo_en.srt"
      },
      "file": {
        "container_format": "srt"
      }
    }
  ]
}

Create a playback ID
post

Creates a playback ID that can be used to stream the asset to a viewer.

curl https://api.mux.com/video/v1/assets/${ASSET_ID}/playback-ids \
  -X POST \
  -d '{ "policy": "public" }' \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request body params

policy

string

Possible values: "public" "signed"

public playback IDs are accessible by constructing an HLS URL like https://stream.mux.com/${PLAYBACK_ID}
signed playback IDs should be used with tokens https://stream.mux.com/${PLAYBACK_ID}?token={TOKEN}. See Secure video playback for details about creating tokens.

Request path & query params

ASSET_ID

string

The asset ID.

post

201

/video/v1/assets/{ASSET_ID}/playback-ids

Request

(application/json)

{
  "policy": "public"
}

Response

(application/json)

{
  "data": {
    "policy": "public",
    "id": "Lj02VZDorh9hCV00flNqPli8fmwf6KEppug01w8zDEYVlQ"
  }
}

Retrieve a playback ID
get

Retrieves information about the specified playback ID.

curl https://api.mux.com/video/v1/assets/${ASSET_ID}/playback-ids/${PLAYBACK_ID} \
  -X GET \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request path & query params

ASSET_ID

string

The asset ID.

PLAYBACK_ID

string

The live stream's playback ID.

get

200

/video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID}

Response

(application/json)

{
  "data": {
    "policy": "public",
    "id": "vAFLI2eKFFicXX00iHBS2vqt5JjJGg5HV6fQ4Xijgt1I"
  }
}

Delete a playback ID
del

Deletes a playback ID, rendering it nonfunctional for viewing an asset's video content. Please note that deleting the playback ID removes access to the underlying asset; a viewer who started playback before the playback ID was deleted may be able to watch the entire video for a limited duration.

curl https://api.mux.com/video/v1/assets/${ASSET_ID}/playback-ids/${PLAYBACK_ID} \
  -X DELETE \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request path & query params

ASSET_ID

string

The asset ID.

PLAYBACK_ID

string

The live stream's playback ID.

del

204

/video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID}

Update MP4 support
put

Allows you to add or remove mp4 support for assets that were created without it. Currently there are two values supported in this request, standard and none. none means that an asset does not have mp4 support, so submitting a request with mp4_support set to none will delete the mp4 assets from the asset in question.

curl https://api.mux.com/video/v1/assets/${ASSET_ID}/mp4-support \
  -X PUT \
  -d '{ "mp4_support": "standard" }' \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request body params

mp4_support

string

Possible values: "standard" "none"

String value for the level of mp4 support

Request path & query params

ASSET_ID

string

The asset ID.

put

200

/video/v1/assets/{ASSET_ID}/mp4-support

Request

(application/json)

{
  "mp4_support": "standard"
}

Response

(application/json)

{
  "data": {
    "tracks": [
      {
        "type": "video",
        "max_width": 1920,
        "max_height": 1080,
        "max_frame_rate": 29.97,
        "id": "RiyQPM31a1SPtfI802bEP2zD02F5FQVNL801FRHeE5t01G4",
        "duration": 23.8238
      },
      {
        "type": "audio",
        "max_channels": 2,
        "max_channel_layout": "stereo",
        "id": "LvINTciHVoC017knMCH01y9pSi5OrDLCRaBPNDAoNJcmg",
        "duration": 23.823792
      }
    ],
    "status": "ready",
    "static_renditions": {
      "status": "preparing"
    },
    "playback_ids": [
      {
        "policy": "public",
        "id": "Lj02VZDorh9hCV00flNqPli8fmwf6KEppug01w8zDEYVlQ"
      }
    ],
    "mp4_support": "standard",
    "max_stored_resolution": "HD",
    "max_stored_frame_rate": 29.97,
    "master_access": "none",
    "id": "lJ4bGGsp7ZlPf02nMg015W02iHQLN9XnuuLRBsPS00xqd68",
    "duration": 23.857167,
    "created_at": "1609868768",
    "aspect_ratio": "16:9"
  }
}

Update master access
put

Allows you to add temporary access to the master (highest-quality) version of the asset in MP4 format. A URL will be created that can be used to download the master version for 24 hours. After 24 hours Master Access will revert to "none". This master version is not optimized for web and not meant to be streamed, only downloaded for purposes like archiving or editing the video offline.

curl https://api.mux.com/video/v1/assets/${ASSET_ID}/master-access \
  -X PUT \
  -d '{ "master_access": "temporary" }' \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request body params

master_access

string

Possible values: "temporary" "none"

Add or remove access to the master version of the video.

Request path & query params

ASSET_ID

string

The asset ID.

put

200

/video/v1/assets/{ASSET_ID}/master-access

Request

(application/json)

{
  "master_access": "temporary"
}

Response

(application/json)

{
  "data": {
    "tracks": [
      {
        "type": "video",
        "max_width": 1920,
        "max_height": 1080,
        "max_frame_rate": 29.97,
        "id": "RiyQPM31a1SPtfI802bEP2zD02F5FQVNL801FRHeE5t01G4",
        "duration": 23.8238
      },
      {
        "type": "audio",
        "max_channels": 2,
        "max_channel_layout": "stereo",
        "id": "LvINTciHVoC017knMCH01y9pSi5OrDLCRaBPNDAoNJcmg",
        "duration": 23.823792
      }
    ],
    "status": "ready",
    "playback_ids": [
      {
        "policy": "public",
        "id": "Lj02VZDorh9hCV00flNqPli8fmwf6KEppug01w8zDEYVlQ"
      }
    ],
    "mp4_support": "none",
    "max_stored_resolution": "HD",
    "max_stored_frame_rate": 29.97,
    "master_access": "temporary",
    "master": {
      "status": "preparing"
    },
    "id": "lJ4bGGsp7ZlPf02nMg015W02iHQLN9XnuuLRBsPS00xqd68",
    "duration": 23.857167,
    "created_at": "1609868768",
    "aspect_ratio": "16:9"
  }
}

Create an asset track
post

Adds an asset track (for example, subtitles) to an asset.

curl https://api.mux.com/video/v1/assets/${ASSET_ID}/tracks \
  -X POST \
  -d '{ "url": "https://example.com/myVIdeo_en.srt", "type": "text", "text_type": "subtitles", "closed_captions": true, "language_code": "en-US", "name": "English",  "passthrough": "English" }' \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request body params

url

string

type

string

Possible values: "text"

text_type

string

Possible values: "subtitles"

language_code

string

The language code value must be a valid BCP 47 specification compliant value. For example, en for English or en-US for the US version of English.

name

string

The name of the track containing a human-readable description. This value must be unique across all the text type and subtitles text type tracks. HLS manifest will associate subtitle text track with this value. For example, set the value to "English" for subtitles text track with language_code as en-US. If this parameter is not included, Mux will auto-populate based on the language_code value.

closed_captions

boolean

Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).

passthrough

string

Arbitrary user-supplied metadata set for the track either when creating the asset or track.

Request path & query params

ASSET_ID

string

The asset ID.

post

201

/video/v1/assets/{ASSET_ID}/tracks

Request

(application/json)

{
  "url": "https://example.com/myVideo_en.srt",
  "type": "text",
  "text_type": "subtitles",
  "language_code": "en-US",
  "name": "English",
  "closed_captions": true,
  "passthrough": "English"
}

Response

(application/json)

{
  "data": {
    "type": "text",
    "text_type": "subtitles",
    "status": "preparing",
    "passthrough": "English",
    "name": "English",
    "language_code": "en-US",
    "id": "xBe7u01029ipxBLQhYzZCJ1cke01zCkuUsgnYtH0017nNzbpv2YcsoMDmw",
    "closed_captions": true
  }
}

Delete an asset track
del

Removes a text track from an asset. Audio and video tracks on assets cannot be removed.

curl https://api.mux.com/video/v1/assets/${ASSET_ID}/tracks/${TRACK_ID} \
  -X DELETE \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request path & query params

ASSET_ID

string

The asset ID.

TRACK_ID

string

The track ID.

del

204

/video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID}

Live Streams

A Live Stream represents a unique live stream of video being pushed to Mux. It includes configuration details (a Stream Key) for live broadcasting software/hardware and a Playback ID for playing the stream anywhere. Currently, RTMP is the only supported method of ingesting video. Use rtmp://global-live.mux.com:5222/app with the Live Stream's Stream Key for getting the video into Mux, and use https://stream.mux.com with the Live Stream's Playback ID for playback.

A Live Stream can be used once for a specific event, or re-used forever. If you're building an application like Facebook Live or Twitch, you could create one Live Stream per user. This allows them to configure their broadcasting software once, and the Live Stream Playback ID will always show their latest stream.

Each RTMP session creates a new video asset automatically. You can set up a webhook to be notified each time a broadcast (or Live Stream RTMP session) begins or ends with the video.live_stream.active and video.live_stream.idle events respectively. Assets that are created from a Live Stream have the same behavior as other Assets you create.

Learn more about how to go live in our guides.

Properties

id.

string

Unique identifier for the Live Stream. Max 255 characters.

created_at.

string

Time the Live Stream was created, defined as a Unix timestamp (seconds since epoch).

stream_key.

string

Unique key used for streaming to a Mux RTMP endpoint. This should be considered as sensitive as credentials, anyone with this stream key can begin streaming.

active_asset_id.

string

The Asset that is currently being created if there is an active broadcast.

recent_asset_ids.

array

An array of strings with the most recent Assets that were created from this live stream.

status.

string

Possible values: "active" "idle" "disabled"

idle indicates that there is no active broadcast. active indicates that there is an active broadcast and disabled status indicates that no future RTMP streams can be published.

playback_ids.

array

An array of Playback ID objects. Use these to create HLS playback URLs. See Play your videos for more details.

playback_ids[].id.

string

Unique identifier for the PlaybackID

playback_ids[].policy.

string

Possible values: "public" "signed"

public playback IDs are accessible by constructing an HLS URL like https://stream.mux.com/${PLAYBACK_ID}
signed playback IDs should be used with tokens https://stream.mux.com/${PLAYBACK_ID}?token={TOKEN}. See Secure video playback for details about creating tokens.

new_asset_settings.

object

The settings to be used when creating a new asset. You can use any of the usual settings when creating an asset normally, with the exception to not include file url for creating the asset in input. You could optionally add overlay_setting and input urls to add Subtitles / Captions.

passthrough.

string

Arbitrary user-supplied metadata set for the asset. Max 255 characters.

audio_only.

boolean

The live stream only processes the audio track if the value is set to true. Mux drops the video track if broadcasted.

embedded_subtitles.

array

Describes the embedded closed caption configuration of the incoming live stream.

embedded_subtitles[].name.

string

A name for this live stream closed caption track.

embedded_subtitles[].passthrough.

string

Arbitrary user-supplied metadata set for the live stream closed caption track. Max 255 characters.

embedded_subtitles[].language_code.

string (default: en)

The language of the closed caption stream. Value must be BCP 47 compliant.

embedded_subtitles[].language_channel.

string (default: cc1)

Possible values: "cc1"

CEA-608 caption channel to read data from.

reconnect_window.

number (default: 60)

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. Max: 1800s (30 minutes).

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_latency.

BETA

boolean

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_url.

BETA

string

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.

reduced_latency.

DEPRECATED

boolean

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. See the Reduce live stream latency guide to understand the tradeoffs.

simulcast_targets.

array

Each Simulcast Target contains configuration details to broadcast (or "restream") a live stream to a third-party streaming service. See the Stream live to 3rd party platforms guide.

simulcast_targets[].id.

string

ID of the Simulcast Target

simulcast_targets[].passthrough.

string

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

simulcast_targets[].status.

string

Possible values: "idle" "starting" "broadcasting" "errored"

The current status of the simulcast target. See Statuses below for detailed description.

idle: Default status. When the parent live stream is in disconnected status, simulcast targets will be idle state.
starting: The simulcast target transitions into this state when the parent live stream transition into connected state.
broadcasting: The simulcast target has successfully connected to the third party live streaming service and is pushing video to that service.
errored: The simulcast target encountered an error either while attempting to connect to the third party live streaming service, or mid-broadcasting. Compared to other errored statuses in the Mux Video API, a simulcast may transition back into the broadcasting state if a connection with the service can be re-established.

simulcast_targets[].stream_key.

string

Stream Key represents an stream identifier for the third party live streaming service to simulcast the parent live stream too.

simulcast_targets[].url.

string

RTMP hostname including the application name for the third party live streaming service.

latency_mode.

BETA

string

Possible values: "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. The Low Latency value is a beta feature. Read more here: https://mux.com/blog/introducing-low-latency-live-streaming/

test.

boolean

True means this live stream is a test live stream. Test live streams can be used to help evaluate the Mux Video APIs for free. There is no limit on the number of test live streams, but they 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_duration.

integer (default: 43200)

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

Create a live stream
post

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

curl https://api.mux.com/video/v1/live-streams \
  -X POST \
  -d '{ "playback_policy": "public", "new_asset_settings": { "playback_policy": "public" } }' \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request body params

playback_policy

array

Possible values: "public" "signed"

public playback IDs are accessible by constructing an HLS URL like https://stream.mux.com/${PLAYBACK_ID}
signed playback IDs should be used with tokens https://stream.mux.com/${PLAYBACK_ID}?token={TOKEN}. See Secure video playback for details about creating tokens.

new_asset_settings

object

input

array

url

string

The URL of the file that Mux should download and use.

For subtitles text tracks, the URL is the location of subtitle/captions file. Mux supports SubRip Text (SRT) and Web Video Text Tracks format for ingesting Subtitles and Closed Captions.
For Watermarking or Overlay, the URL is the location of the watermark image.
When creating clips from existing Mux assets, the URL is defined with mux://assets/{asset_id} template where asset_id is the Asset Identifier for creating the clip from.

overlay_settings

object

An object that describes how the image file referenced in URL should be placed over the video (i.e. watermarking). Ensure that the URL is active and persists the entire lifespan of the video object.

vertical_align

string

Possible values: "top" "middle" "bottom"

Where the vertical positioning of the overlay/watermark should begin from. Defaults to "top"

vertical_margin

string

horizontal_align

string

Possible values: "left" "center" "right"

Where the horizontal positioning of the overlay/watermark should begin from.

horizontal_margin

string

width

string

height

string

opacity

string

How opaque the overlay should appear, expressed as a percent. (Default 100%)

start_time

number

end_time

number

type

string

Possible values: "video" "audio" "text"

This parameter is required for text type tracks.

text_type

string

Possible values: "subtitles"

Type of text track. This parameter only supports subtitles value. For more information on Subtitles / Closed Captions, see this blog post. This parameter is required for text type tracks.

language_code

string

name

string

closed_captions

boolean

Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This optional parameter should be used for text type and subtitles text type tracks.

passthrough

string

This optional parameter should be used for text type and subtitles text type tracks.

playback_policy

array

Possible values: "public" "signed"

public playback IDs are accessible by constructing an HLS URL like https://stream.mux.com/${PLAYBACK_ID}
signed playback IDs should be used with tokens https://stream.mux.com/${PLAYBACK_ID}?token={TOKEN}. See Secure video playback for details about creating tokens.

passthrough

string

Arbitrary user-supplied metadata that will be included in the asset details and related webhooks. Can be used to store your own ID for a video along with the asset. Max: 255 characters.

mp4_support

string

Possible values: "none" "standard"

normalize_audio

boolean

Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets.

master_access

string

Possible values: "none" "temporary"

Specify what level (if any) of support for master access. Master access can be enabled temporarily for your asset to be downloaded. See the Download your videos guide for more information.

test

boolean

reconnect_window

number

(default: 60)

use_slate_for_standard_latency

boolean

BETA

reconnect_slate_url

string

BETA

passthrough

string

audio_only

boolean

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

embedded_subtitles

array

Describe the embedded closed caption contents of the incoming live stream.

name

string

A name for this live stream closed caption track.

passthrough

string

Arbitrary user-supplied metadata set for the live stream closed caption track. Max 255 characters.

language_code

string

(default: en)

The language of the closed caption stream. Value must be BCP 47 compliant.

language_channel

string

(default: cc1)

Possible values: "cc1"

CEA-608 caption channel to read data from.

reduced_latency

boolean

DEPRECATED

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/

latency_mode

string

BETA

Possible values: "low" "reduced" "standard"

test

boolean

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.

simulcast_targets

array

passthrough

string

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

stream_key

string

Stream Key represents a stream identifier on the third party live streaming service to send the parent live stream to.

url

string

RTMP hostname including application name for the third party live streaming service. Example: rtmp://live.example.com/app.

max_continuous_duration

integer

(default: 43200)

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

post

201

/video/v1/live-streams

Request

(application/json)

{
  "playback_policy": [
    "public"
  ],
  "new_asset_settings": {
    "playback_policy": [
      "public"
    ]
  }
}

Response

(application/json)

{
  "data": {
    "stream_key": "abcdefgh",
    "status": "idle",
    "reconnect_window": 60,
    "playback_ids": [
      {
        "policy": "public",
        "id": "HNRDuwff3K2VjTZZAPuvd2Kx6D01XUQFv02GFBHPUka018"
      }
    ],
    "new_asset_settings": {
      "playback_policies": [
        "public"
      ]
    },
    "id": "ZEBrNTpHC02iUah025KM3te6ylM7W4S4silsrFtUkn3Ag",
    "created_at": "1609937654",
    "latency_mode": "standard",
    "max_continuous_duration": 43200
  }
}

List live streams
get

Lists the live streams that currently exist in the current environment.

curl https://api.mux.com/video/v1/live-streams \
  -X GET \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request path & query params

limit

integer

(default: 25)

Number of items to include in the response

page

integer

(default: 1)

Offset by this many pages, of the size of limit

stream_key

string

Filter response to return live stream for this stream key only

status

string

Possible values: "active" "idle" "disabled"

Filter response to return live streams with the specified status only. idle indicates that there is no active broadcast. active indicates that there is an active broadcast and disabled status indicates that no future RTMP streams can be published.

get

200

/video/v1/live-streams

Response

(application/json)

{
  "data": [
    {
      "stream_key": "831b5bde-cd8a-5bc4-115d-4ba34b19f481",
      "status": "idle",
      "reconnect_window": 60,
      "playback_ids": [
        {
          "policy": "public",
          "id": "HNRDuwff3K2VjTZZAPuvd2Kx6D01XUQFv02GFBHPUka018"
        }
      ],
      "new_asset_settings": {
        "playback_policies": [
          "public"
        ]
      },
      "id": "ZEBrNTpHC02iUah025KM3te6ylM7W4S4silsrFtUkn3Ag",
      "created_at": "1609937654",
      "latency_mode": "standard",
      "max_continuous_duration": 43200
    },
    {
      "stream_key": "d273c65e-1fc8-27dc-e9ef-56144cbceb3a",
      "status": "idle",
      "reconnect_window": 60,
      "recent_asset_ids": [
        "SZs02xxHgYdkHp00OSCjJiHUHqzVQZNU332XPXRxe341o",
        "e4J9cwb5tjVxMeeV8201dC00i800ThPKKGT2SEN002dHH2s"
      ],
      "playback_ids": [
        {
          "policy": "public",
          "id": "00zOcribkUmXqXHzBTpflk2771BRTcKATqPjWf7JHpuM"
        }
      ],
      "new_asset_settings": {
        "playback_policies": [
          "public"
        ]
      },
      "id": "B65hEUWW01ErVKDDGImKcBquYhwEAkjW6Ic3lPY0299Cc",
      "created_at": "1607587513",
      "latency_mode": "standard",
      "max_continuous_duration": 43200
    }
  ]
}

Retrieve a live stream
get

Retrieves the details of a live stream that has previously been created. Supply the unique live stream ID that was returned from your previous request, and Mux will return the corresponding live stream information. The same information is returned when creating a live stream.

curl https://api.mux.com/video/v1/live-streams/${LIVE_STREAM_ID} \
  -X GET \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request path & query params

LIVE_STREAM_ID

string

The live stream ID

get

200

/video/v1/live-streams/{LIVE_STREAM_ID}

Response

(application/json)

{
  "data": {
    "stream_key": "831b5bde-cd8a-5bc4-115d-4ba34b19f481",
    "status": "idle",
    "reconnect_window": 60,
    "playback_ids": [
      {
        "policy": "public",
        "id": "HNRDuwff3K2VjTZZAPuvd2Kx6D01XUQFv02GFBHPUka018"
      }
    ],
    "new_asset_settings": {
      "playback_policies": [
        "public"
      ]
    },
    "id": "ZEBrNTpHC02iUah025KM3te6ylM7W4S4silsrFtUkn3Ag",
    "created_at": "1609937654",
    "latency_mode": "standard",
    "max_continuous_duration": 43200
  }
}

Delete a live stream
del

Deletes a live stream from the current environment. If the live stream is currently active and being streamed to, ingest will be terminated and the encoder will be disconnected.

curl https://api.mux.com/video/v1/live-streams/${LIVE_STREAM_ID} \
  -X DELETE \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request path & query params

LIVE_STREAM_ID

string

The live stream ID

del

204

/video/v1/live-streams/{LIVE_STREAM_ID}

Update a live stream
patch

Updates the parameters of a previously-created live stream. This currently supports a subset of variables. Supply the live stream ID and the updated parameters and Mux will return the corresponding live stream information. The information returned will be the same after update as for subsequent get live stream requests.

Request body params

passthrough

string

Arbitrary user-supplied metadata set for the live stream. Max 255 characters. In order to clear this value, the field should be included with an empty-string value.

latency_mode

string

Possible values: "low" "reduced" "standard"

reconnect_window

number

(default: 60)

use_slate_for_standard_latency

boolean

BETA

reconnect_slate_url

string

BETA

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. Set this to a blank string to clear the value so that the default slate media will be used.

max_continuous_duration

integer

(default: 43200)

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

Request path & query params

LIVE_STREAM_ID

string

The live stream ID

patch

200

/video/v1/live-streams/{LIVE_STREAM_ID}

Request

(application/json)

{
  "latency_mode": "standard",
  "reconnect_window": 30,
  "max_continuous_duration": 1200
}

Response

(application/json)

{
  "data": {
    "stream_key": "831b5bde-cd8a-5bc4-115d-4ba34b19f481",
    "status": "idle",
    "reconnect_window": 30,
    "playback_ids": [
      {
        "policy": "public",
        "id": "HNRDuwff3K2VjTZZAPuvd2Kx6D01XUQFv02GFBHPUka018"
      }
    ],
    "new_asset_settings": {
      "playback_policies": [
        "public"
      ]
    },
    "id": "ZEBrNTpHC02iUah025KM3te6ylM7W4S4silsrFtUkn3Ag",
    "created_at": "1609937654",
    "latency_mode": "standard",
    "max_continuous_duration": 1200
  }
}

Create a live stream playback ID
post

Create a new playback ID for this live stream, through which a viewer can watch the streamed content of the live stream.

curl https://api.mux.com/video/v1/live-streams/${LIVE_STREAM_ID}/playback-ids \
  -X POST \
  -d '{ "policy": "public" }' \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request body params

policy

string

Possible values: "public" "signed"

public playback IDs are accessible by constructing an HLS URL like https://stream.mux.com/${PLAYBACK_ID}
signed playback IDs should be used with tokens https://stream.mux.com/${PLAYBACK_ID}?token={TOKEN}. See Secure video playback for details about creating tokens.

Request path & query params

LIVE_STREAM_ID

string

The live stream ID

post

201

/video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids

Request

(application/json)

{
  "policy": "signed"
}

Response

(application/json)

{
  "data": {
    "policy": "public",
    "id": "4O902oOPU100s7XIQgOeY01U7dHzYlBe26zi3Sq01EJqnxw"
  }
}

Retrieve a live stream playback ID
get

Fetches information about a live stream's playback ID, through which a viewer can watch the streamed content from this live stream.

Request path & query params

LIVE_STREAM_ID

string

The live stream ID

PLAYBACK_ID

string

The live stream's playback ID.

get

200

/video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids/{PLAYBACK_ID}

Response

(application/json)

{
  "data": {
    "policy": "public",
    "id": "4O902oOPU100s7XIQgOeY01U7dHzYlBe26zi3Sq01EJqnxw"
  }
}

Delete a live stream playback ID
del

Deletes the playback ID for the live stream. This will not disable ingest (as the live stream still exists). New attempts to play back the live stream will fail immediately. However, current viewers will be able to continue watching the stream for some period of time.

curl https://api.mux.com/video/v1/live-streams/${LIVE_STREAM_ID}/playback-ids/${PLAYBACK_ID} \
  -X DELETE \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request path & query params

LIVE_STREAM_ID

string

The live stream ID

PLAYBACK_ID

string

The live stream's playback ID.

del

204

/video/v1/live-streams/{LIVE_STREAM_ID}/playback-ids/{PLAYBACK_ID}

Reset a live stream's stream key
post

Reset a live stream key if you want to immediately stop the current stream key from working and create a new stream key that can be used for future broadcasts.

curl https://api.mux.com/video/v1/live-streams/${LIVE_STREAM_ID}/reset-stream-key \
  -X POST \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request path & query params

LIVE_STREAM_ID

string

The live stream ID

post

201

/video/v1/live-streams/{LIVE_STREAM_ID}/reset-stream-key

Response

(application/json)

{
  "data": {
    "stream_key": "acaf2ca1-ba9c-5ffe-8c9c-a02bbf0009a6",
    "status": "idle",
    "reconnect_window": 60,
    "playback_ids": [
      {
        "policy": "public",
        "id": "HNRDuwff3K2VjTZZAPuvd2Kx6D01XUQFv02GFBHPUka018"
      },
      {
        "policy": "public",
        "id": "4O902oOPU100s7XIQgOeY01U7dHzYlBe26zi3Sq01EJqnxw"
      }
    ],
    "new_asset_settings": {
      "playback_policies": [
        "public"
      ]
    },
    "id": "ZEBrNTpHC02iUah025KM3te6ylM7W4S4silsrFtUkn3Ag",
    "created_at": "1609937654",
    "latency_mode": "standard",
    "max_continuous_duration": 43200
  }
}

Signal a live stream is finished
put

(Optional) End the live stream recording immediately instead of waiting for the reconnect_window. EXT-X-ENDLIST tag is added to the HLS manifest which notifies the player that this live stream is over.

Mux does not close the encoder connection immediately. Encoders are often configured to re-establish connections immediately which would result in a new recorded asset. For this reason, Mux waits for 60s before closing the connection with the encoder. This 60s timeframe is meant to give encoder operators a chance to disconnect from their end.

curl https://api.mux.com/video/v1/live-streams/${LIVE_STREAM_ID}/complete \
  -X PUT \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request path & query params

LIVE_STREAM_ID

string

The live stream ID

put

200

/video/v1/live-streams/{LIVE_STREAM_ID}/complete

Response

(application/json)

{
  "data": {}
}

Disable a live stream
put

Disables a live stream, making it reject incoming RTMP streams until re-enabled. The API also ends the live stream recording immediately when active. Ending the live stream recording adds the EXT-X-ENDLIST tag to the HLS manifest which notifies the player that this live stream is over.

Mux also closes the encoder connection immediately. Any attempt from the encoder to re-establish connection will fail till the live stream is re-enabled.

curl https://api.mux.com/video/v1/live-streams/${LIVE_STREAM_ID}/disable \
  -X PUT \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request path & query params

LIVE_STREAM_ID

string

The live stream ID

put

200

/video/v1/live-streams/{LIVE_STREAM_ID}/disable

Response

(application/json)

{
  "data": {}
}

Enable a live stream
put

Enables a live stream, allowing it to accept an incoming RTMP stream.

curl https://api.mux.com/video/v1/live-streams/${LIVE_STREAM_ID}/enable \
  -X PUT \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request path & query params

LIVE_STREAM_ID

string

The live stream ID

put

200

/video/v1/live-streams/{LIVE_STREAM_ID}/enable

Response

(application/json)

{
  "data": {}
}

Update a live stream's embedded subtitles
put

Configures a live stream to receive embedded closed captions. The resulting Asset's subtitle text track will have closed_captions: true set.

Request body params

embedded_subtitles

array

Describe the embedded closed caption contents of the incoming live stream.

name

string

A name for this live stream closed caption track.

passthrough

string

Arbitrary user-supplied metadata set for the live stream closed caption track. Max 255 characters.

language_code

string

(default: en)

The language of the closed caption stream. Value must be BCP 47 compliant.

language_channel

string

(default: cc1)

Possible values: "cc1"

CEA-608 caption channel to read data from.

Request path & query params

LIVE_STREAM_ID

string

The live stream ID

put

200

/video/v1/live-streams/{LIVE_STREAM_ID}/embedded-subtitles

Request

(application/json)

{
  "embedded_subtitles": [
    {
      "passthrough": "Example"
    }
  ]
}

Response

(application/json)

{
  "data": {
    "stream_key": "acaf2ca1-ba9c-5ffe-8c9c-a02bbf0009a6",
    "status": "idle",
    "reconnect_window": 60,
    "playback_ids": [
      {
        "policy": "public",
        "id": "HNRDuwff3K2VjTZZAPuvd2Kx6D01XUQFv02GFBHPUka018"
      },
      {
        "policy": "public",
        "id": "4O902oOPU100s7XIQgOeY01U7dHzYlBe26zi3Sq01EJqnxw"
      }
    ],
    "new_asset_settings": {
      "playback_policies": [
        "public"
      ]
    },
    "id": "ZEBrNTpHC02iUah025KM3te6ylM7W4S4silsrFtUkn3Ag",
    "created_at": "1609937654",
    "embedded_subtitles": [
      {
        "name": "English CC",
        "language_code": "en",
        "language_channel": "cc1",
        "passthrough": "Example"
      }
    ],
    "latency_mode": "standard",
    "max_continuous_duration": 43200
  }
}

Create a live stream simulcast target
post

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.

curl https://api.mux.com/video/v1/live-streams/${LIVE_STREAM_ID}/simulcast-targets \
  -X POST \
  -d '{"url": "rtmp://live.example.com/app", "stream_key": "abcdefgh", "passthrough":"Example"}' \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request body params

passthrough

string

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

stream_key

string

Stream Key represents a stream identifier on the third party live streaming service to send the parent live stream to.

url

string

RTMP hostname including application name for the third party live streaming service. Example: rtmp://live.example.com/app.

Request path & query params

LIVE_STREAM_ID

string

The live stream ID

post

201

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

Request

(application/json)

{
  "url": "rtmp://live.example.com/app",
  "stream_key": "abcdefgh",
  "passthrough": "Example"
}

Response

(application/json)

{
  "data": {
    "url": "rtmp://live.example.com/app",
    "stream_key": "abcdefgh",
    "status": "idle",
    "passthrough": "Example",
    "id": "le1axfGDc9ETqh6trHNTxGQ9XEhj02fOnX0200aAh24fwlmwzqKCYNJgw"
  }
}

Delete a Live Stream Simulcast Target
del

Delete the simulcast target using the simulcast target ID returned when creating the simulcast target. Simulcast Target can only be deleted when the parent live stream is in idle state.

curl https://api.mux.com/video/v1/live-streams/${LIVE_STREAM_ID}/simulcast-targets/${SIMULCAST_TARGET_ID} \
  -X DELETE \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request path & query params

LIVE_STREAM_ID

string

The live stream ID

SIMULCAST_TARGET_ID

string

The ID of the simulcast target.

del

204

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

Retrieve a Live Stream Simulcast Target
get

Retrieves the details of the simulcast target created for the parent live stream. Supply the unique live stream ID and simulcast target ID that was returned in the response of create simulcast target request, and Mux will return the corresponding information.

curl https://api.mux.com/video/v1/live-streams/${LIVE_STREAM_ID}/simulcast-targets/${SIMULCAST_TARGET_ID} \
  -X GET \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request path & query params

LIVE_STREAM_ID

string

The live stream ID

SIMULCAST_TARGET_ID

string

The ID of the simulcast target.

get

200

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

Response

(application/json)

{
  "data": {
    "url": "rtmp://live.example.com/app",
    "stream_key": "abcdefgh",
    "status": "idle",
    "passthrough": "Example",
    "id": "02FU00rPq00fC9S6kygrqlxygGMdpW1lk00BkFpCfc2kGregEIr7brt7CQ"
  }
}

Spaces

Spaces allow developers to build real-time video and audio experiences into their applications via the Real-Time Video product.

Composited video of space sessions can be sent to live streams using broadcasts.

To add real-time video to an application, you'll also need to integrate one of our Real-Time Video sdks.

Learn more in the Real-Time Video guides.

Properties

id.

string

Unique identifier for the space. Max 255 characters.

created_at.

string

Time the space was created, defined as a Unix timestamp (seconds since epoch).

type.

string (default: server)

Possible values: "server"

Specify the network architecture of the space. In server spaces, all video travels through Mux's video infrastructure. Defaults to server if not set.

status.

string

Possible values: "idle" "active"

The status of the space. Spaces are idle when there are no participants connected, and active when there are participants connected.

passthrough.

string

Arbitrary user-supplied metadata that will be included in the space details and related webhooks. Max: 255 characters.

broadcasts.

array

An array of broadcast destinations.

broadcasts[].id.

string

Unique identifier for the broadcast. Max 255 characters.

broadcasts[].passthrough.

string

Arbitrary user-supplied metadata that will be included in the broadcast details and related webhooks. Max: 255 characters.

broadcasts[].live_stream_id.

string

The ID of the live stream that the broadcast will be sent to.

broadcasts[].status.

string

Possible values: "idle" "active"

The status of the broadcast. You can start and stop broadcasts with the start and stop APIs.

broadcasts[].layout.

string (default: gallery)

Possible values: "gallery" "active-speaker"

The layout used when broadcasting the space. Defaults to gallery if not set.

broadcasts[].background.

string

URL of an image to display as the background of the broadcast. Its dimensions should match the provided resolution.

broadcasts[].resolution.

string (default: 1920x1080)

Possible values: "1920x1080" "1280x720" "1080x1920" "720x1280" "1080x1080" "720x720"

The resolution of the composited video sent to the live stream. Defaults to 1920x1080 if not set.

active_session_id.

string

Unique identifier for the current lifecycle of the space. Only set when the space is active and is set to a new value each time the space transitions from idle to active. This value is useful for logging and debugging issues. Max 255 characters.

Create a space
post

Create a new space. Spaces are used to build real-time video applications.

Request body params

type

string

(default: server)

Possible values: "server"

Specify the network architecture of the space. In server spaces, all video travels through Mux's video infrastructure. Defaults to server if not set.

passthrough

string

Arbitrary user-supplied metadata that will be included in the space details and related webhooks. Max: 255 characters.

broadcasts

array

An array of broadcast destinations you want to stream the space to. Note: By default only a single broadcast destination can be specified. Contact Mux support if you need more.

passthrough

string

Arbitrary user-supplied metadata that will be included in the broadcast details and related webhooks. Max: 255 characters.

live_stream_id

string

The ID of the live stream that you want to broadcast to.

layout

string

(default: gallery)

Possible values: "gallery" "active-speaker"

The layout used when broadcasting the space. Defaults to gallery if not set.

background

string

URL of an image to display as the background of the broadcast. Its dimensions should match the provided resolution.

resolution

string

(default: 1920x1080)

Possible values: "1920x1080" "1280x720" "1080x1920" "720x1280" "1080x1080" "720x720"

The resolution of the composited video sent to the live stream. Defaults to 1920x1080 if not set.

post

201

/video/v1/spaces

Request

(application/json)

{
  "type": "server"
}

Response

(application/json)

{
  "data": {
    "type": "server",
    "id": "uylLl3WuQ54CwqUB9UHySxnN66sqKue5",
    "created_at": "1607452572",
    "status": "idle"
  }
}

List spaces
get

List all spaces in the current enviroment.

Request path & query params

limit

integer

(default: 25)

Number of items to include in the response

page

integer

(default: 1)

Offset by this many pages, of the size of limit

get

200

/video/v1/spaces

Response

(application/json)

{
  "data": [
    {
      "type": "server",
      "id": "uylLl3WuQ54CwqUB9UHySxnN66sqKue5",
      "created_at": "1607452572",
      "status": "idle"
    },
    {
      "type": "server",
      "id": "HK01Bq7FrEQmIu3QpRiZZ98HQOOZjm6B",
      "created_at": "1693452572",
      "status": "active"
    }
  ]
}

Retrieve a space
get

Retrieves the details of a space that has previously been created. Supply the unique space ID that was returned from your create space request, and Mux will return the information about the corresponding space. The same information is returned when creating a space.

Request path & query params

SPACE_ID

string

The space ID.

get

200

/video/v1/spaces/{SPACE_ID}

Response

(application/json)

{
  "data": {
    "type": "server",
    "id": "uylLl3WuQ54CwqUB9UHySxnN66sqKue5",
    "created_at": "1607452572",
    "status": "idle"
  }
}

Delete a space
del

Deletes a space. Spaces can only be deleted when idle.

Request path & query params

SPACE_ID

string

The space ID.

del

204

/video/v1/spaces/{SPACE_ID}

Create a space broadcast
post

Creates a new broadcast. Broadcasts are used to create composited versions of your space, which can be broadcast to live streams. Note: By default only a single broadcast destination can be specified. Contact Mux support if you need more.

Request body params

passthrough

string

Arbitrary user-supplied metadata that will be included in the broadcast details and related webhooks. Max: 255 characters.

live_stream_id

string

The ID of the live stream that you want to broadcast to.

layout

string

(default: gallery)

Possible values: "gallery" "active-speaker"

The layout used when broadcasting the space. Defaults to gallery if not set.

background

string

URL of an image to display as the background of the broadcast. Its dimensions should match the provided resolution.

resolution

string

(default: 1920x1080)

Possible values: "1920x1080" "1280x720" "1080x1920" "720x1280" "1080x1080" "720x720"

The resolution of the composited video sent to the live stream. Defaults to 1920x1080 if not set.

Request path & query params

SPACE_ID

string

The space ID.

post

201

/video/v1/spaces/{SPACE_ID}/broadcasts

Request

(application/json)

{
  "live_stream_id": "GQ9025mPqzyjOy3kKQW006qKTqmULW9vFO"
}

Response

(application/json)

{
  "data": {
    "id": "uylLl3WuQ54CwqUB9UHySxnN66sqKue5",
    "live_stream_id": "GQ9025mPqzyjOy3kKQW006qKTqmULW9vFO",
    "resolution": "1920x1080",
    "layout": "gallery",
    "status": "idle"
  }
}

Retrieve space broadcast
get

Retrieves the details of a broadcast of a specific space.

Request path & query params

SPACE_ID

string

The space ID.

BROADCAST_ID

string

The broadcast ID.

get

200

/video/v1/spaces/{SPACE_ID}/broadcasts/{BROADCAST_ID}

Response

(application/json)

{
  "data": {
    "id": "uylLl3WuQ54CwqUB9UHySxnN66sqKue5",
    "live_stream_id": "GQ9025mPqzyjOy3kKQW006qKTqmULW9vFO",
    "resolution": "1920x1080",
    "layout": "gallery",
    "status": "idle"
  }
}

Delete a space broadcast
del

Deletes a single broadcast of a specific space. Broadcasts can only be deleted when idle.

Request path & query params

SPACE_ID

string

The space ID.

BROADCAST_ID

string

The broadcast ID.

del

204

/video/v1/spaces/{SPACE_ID}/broadcasts/{BROADCAST_ID}

Start a space broadcast
post

Starts broadcasting a space to the associated destination. Broadcasts can only be started when the space is active (when there are participants connected).

Request path & query params

SPACE_ID

string

The space ID.

BROADCAST_ID

string

The broadcast ID.

post

200

/video/v1/spaces/{SPACE_ID}/broadcasts/{BROADCAST_ID}/start

Response

(application/json)

{
  "data": {}
}

Stop a space broadcast
post

Stops broadcasting a space, causing the destination live stream to become idle. This API also automatically calls complete on the destination live stream. Broadcasts are also automatically stopped when a space becomes idle.

Request path & query params

SPACE_ID

string

The space ID.

BROADCAST_ID

string

The broadcast ID.

post

200

/video/v1/spaces/{SPACE_ID}/broadcasts/{BROADCAST_ID}/stop

Response

(application/json)

{
  "data": {}
}

Playback ID

Operations related to the manipulation of playback IDs, through which users are able to stream videos and live streams from Mux.

Properties

id.

string

Unique identifier for the PlaybackID

policy.

string

Possible values: "public" "signed"

public playback IDs are accessible by constructing an HLS URL like https://stream.mux.com/${PLAYBACK_ID}
signed playback IDs should be used with tokens https://stream.mux.com/${PLAYBACK_ID}?token={TOKEN}. See Secure video playback for details about creating tokens.

Retrieve an Asset or Live Stream ID
get

Retrieves the Identifier of the Asset or Live Stream associated with the Playback ID.

Request path & query params

PLAYBACK_ID

string

The live stream's playback ID.

get

200

/video/v1/playback-ids/{PLAYBACK_ID}

Response

(application/json)

{
  "data": {
    "id": "a1B2c3D4e5F6g7H8i9",
    "policy": "public",
    "object": {
      "type": "asset",
      "id": "123456789012345678"
    }
  }
}

URL Signing Keys

A URL signing key is used as the secret when signing any Mux URL. Mux requires a JSON Web Token as the value of the token query parameter. The token query parameter must be set for URLs that reference a playback ID with a signed playback policy.

Properties

id.

string

Unique identifier for the Signing Key.

created_at.

string

Time at which the object was created. Measured in seconds since the Unix epoch.

private_key.

string

A Base64 encoded private key that can be used with the RS256 algorithm when creating a JWT. Note that this value is only returned once when creating a URL signing key.

Create a URL signing key
post

Creates a new signing key pair. When creating a new signing key, the API will generate a 2048-bit RSA key-pair and return the private key and a generated key-id; the public key will be stored at Mux to validate signed tokens.

curl https://api.mux.com/video/v1/signing-keys \
  -X POST \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

post

201

/video/v1/signing-keys

Response

(application/json)

{
  "data": {
    "private_key": "abcd123=",
    "id": "vI5KTQ78ohYriuvWKHY6COtZWXexHGLllxksOdZuya8",
    "created_at": "1610108345"
  }
}

List URL signing keys
get

Returns a list of URL signing keys.

curl https://api.mux.com/video/v1/signing-keys \
  -X GET \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request path & query params

limit

integer

(default: 25)

Number of items to include in the response

page

integer

(default: 1)

Offset by this many pages, of the size of limit

get

200

/video/v1/signing-keys

Response

(application/json)

{
  "data": [
    {
      "id": "vI5KTQ78ohYriuvWKHY6COtZWXexHGLllxksOdZuya8",
      "created_at": "1610108345"
    },
    {
      "id": "jc6lJiCLMjyC202EXtRQ644sShzDv6x5tWJrbvUFpvmo",
      "created_at": "1608632647"
    }
  ]
}

Retrieve a URL signing key
get

Retrieves the details of a URL signing key that has previously been created. Supply the unique signing key ID that was returned from your previous request, and Mux will return the corresponding signing key information. The private key is not returned in this response.

curl https://api.mux.com/video/v1/signing-keys/${SIGNING_KEY_ID} \
  -X GET \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request path & query params

SIGNING_KEY_ID

string

The ID of the signing key.

get

200

/video/v1/signing-keys/{SIGNING_KEY_ID}

Response

(application/json)

{
  "data": {
    "id": "jc6lJiCLMjyC202EXtRQ644sShzDv6x5tWJrbvUFpvmo",
    "created_at": "1608632647"
  }
}

Delete a URL signing key
del

Deletes an existing signing key. Use with caution, as this will invalidate any existing signatures and no URLs can be signed using the key again.

url https://api.mux.com/video/v1/signing-keys/${SIGNING_KEY_ID} \
  -X DELETE \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request path & query params

SIGNING_KEY_ID

string

The ID of the signing key.

del

204

/video/v1/signing-keys/{SIGNING_KEY_ID}

Direct Uploads

Direct upload allows you to push assets directly to Mux storage instead of needing to go through your own first. When you create a new direct upload, we'll give you back a signed URL for a Google Cloud Storage bucket. Their storage API is S3 compatible, so whatever tool you use to upload to either GCS or S3 should work, just remember you're probably uploading large video files and should take advantage of things like resumable or multipart uploads.

Particularly for customers that deal with a lot of user-generated content, it's common to expect quite a few abandoned uploads. To keep those abandoned uploads from cluttering up your asset lists, we don't create an asset for you until the upload is complete. Once that asset is created, you can expect all of the normal asset-related webhooks.

Properties

id.

string

Unique identifier for the Direct Upload.

timeout.

integer (default: 3600)

Max time in seconds for the signed upload URL to be valid. If a successful upload has not occurred before the timeout limit, the direct upload is marked timed_out

status.

string

Possible values: "waiting" "asset_created" "errored" "cancelled" "timed_out"

new_asset_settings.

object

asset_id.

string

Only set once the upload is in the asset_created state.

error.

object

Only set if an error occurred during asset creation.

error.type.

string

Label for the specific error

error.message.

string

Human readable error message

cors_origin.

string

If the upload URL will be used in a browser, you must specify the origin in order for the signed URL to have the correct CORS headers.

url.

string

The URL to upload the associated source media to.

test.

boolean

Indicates if this is a test Direct Upload, in which case the Asset that gets created will be a test Asset.

Create a new direct upload URL
post

Creates a new direct upload, through which video content can be uploaded for ingest to Mux.

curl https://api.mux.com/video/v1/uploads \
  -X POST \
  -d '{ "cors_origin": "*", "new_asset_settings": { "playback_policy": ["public"] } }' \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request body params

timeout

integer

(default: 3600)

Max time in seconds for the signed upload URL to be valid. If a successful upload has not occurred before the timeout limit, the direct upload is marked timed_out

cors_origin

string

If the upload URL will be used in a browser, you must specify the origin in order for the signed URL to have the correct CORS headers.

new_asset_settings

object

input

array

url

string

The URL of the file that Mux should download and use.

For subtitles text tracks, the URL is the location of subtitle/captions file. Mux supports SubRip Text (SRT) and Web Video Text Tracks format for ingesting Subtitles and Closed Captions.
For Watermarking or Overlay, the URL is the location of the watermark image.
When creating clips from existing Mux assets, the URL is defined with mux://assets/{asset_id} template where asset_id is the Asset Identifier for creating the clip from.

overlay_settings

object

An object that describes how the image file referenced in URL should be placed over the video (i.e. watermarking). Ensure that the URL is active and persists the entire lifespan of the video object.

vertical_align

string

Possible values: "top" "middle" "bottom"

Where the vertical positioning of the overlay/watermark should begin from. Defaults to "top"

vertical_margin

string

horizontal_align

string

Possible values: "left" "center" "right"

Where the horizontal positioning of the overlay/watermark should begin from.

horizontal_margin

string

width

string

height

string

opacity

string

How opaque the overlay should appear, expressed as a percent. (Default 100%)

start_time

number

end_time

number

type

string

Possible values: "video" "audio" "text"

This parameter is required for text type tracks.

text_type

string

Possible values: "subtitles"

Type of text track. This parameter only supports subtitles value. For more information on Subtitles / Closed Captions, see this blog post. This parameter is required for text type tracks.

language_code

string

name

string

closed_captions

boolean

Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This optional parameter should be used for text type and subtitles text type tracks.

passthrough

string

This optional parameter should be used for text type and subtitles text type tracks.

playback_policy

array

Possible values: "public" "signed"

public playback IDs are accessible by constructing an HLS URL like https://stream.mux.com/${PLAYBACK_ID}
signed playback IDs should be used with tokens https://stream.mux.com/${PLAYBACK_ID}?token={TOKEN}. See Secure video playback for details about creating tokens.

passthrough

string

Arbitrary user-supplied metadata that will be included in the asset details and related webhooks. Can be used to store your own ID for a video along with the asset. Max: 255 characters.

mp4_support

string

Possible values: "none" "standard"

normalize_audio

boolean

Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets.

master_access

string

Possible values: "none" "temporary"

Specify what level (if any) of support for master access. Master access can be enabled temporarily for your asset to be downloaded. See the Download your videos guide for more information.

test

boolean

test

boolean

post

201

/video/v1/uploads

Request

(application/json)

{
  "cors_origin": "https://example.com/",
  "new_asset_settings": {
    "playback_policy": [
      "public"
    ],
    "mp4_support": "standard"
  }
}

Response

(application/json)

{
  "url": "https://storage.googleapis.com/video-storage-us-east1-uploads/zd01Pe2bNpYhxbrwYABgFE01twZdtv4M00kts2i02GhbGjc?Expires=1610112458&GoogleAccessId=mux-direct-upload%40mux-cloud.iam.gserviceaccount.com&Signature=LCu4PMoKUo%2BJkWQAUwB9WU4bWVVfW3K5bZxSxEptBz3DrjbFxNyGvs0sriyJupZh9Jdb6FxKWFIRbxEetfnAAiesOvSPH%2F1GlIichmGg3YfebfxiX77%2B6ToFF6FMkJucBo284PD90AVLHhKagOea2VsbdO0fh78MAxGH9sEspyQ2uJEfYWjHFqYQ9smJyIuM3CYOmN5HKPgRWy2yUqzV7OTMe%2FivPO4%2FX6XiiN2J4nTmy83252CJUsHIvbiGctfKxcNI6b23UVN4B1tJTVgyxTOZiBQCkMLkD%2FEe5OhoAkvJgkqENRr0q3swO0IChDDWjrh7OTMwqvWGwAoVXEGiHg%3D%3D&upload_id=ABg5-UznTdib1HhOAMjdHhWIYqBbwmSYM6dVKyPe3v33uTeEE8gkN5QzvR3cei6uSZOSrjPn7bdvvDH3nhsrLBq8AjWY2qE4UQ",
  "timeout": 3600,
  "status": "waiting",
  "new_asset_settings": {
    "playback_policies": [
      "public"
    ],
    "mp4_support": "standard"
  },
  "id": "zd01Pe2bNpYhxbrwYABgFE01twZdtv4M00kts2i02GhbGjc",
  "cors_origin": "https://example.com/"
}

List direct uploads
get

Lists currently extant direct uploads in the current environment.

curl https://api.mux.com/video/v1/uploads \
  -X GET \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request path & query params

limit

integer

(default: 25)

Number of items to include in the response

page

integer

(default: 1)

Offset by this many pages, of the size of limit

get

200

/video/v1/uploads

Response

(application/json)

{
  "data": [
    {
      "url": "https://storage.googleapis.com/video-storage-us-east1-uploads/zd01Pe2bNpYhxbrwYABgFE01twZdtv4M00kts2i02GhbGjc?Expires=1610112458&GoogleAccessId=mux-direct-upload%40mux-cloud.iam.gserviceaccount.com&Signature=LCu4PMoKUo%2BJkWQAUwB9WU4bWVVfW3K5bZxSxEptBz3DrjbFxNyGvs0sriyJupZh9Jdb6FxKWFIRbxEetfnAAiesOvSPH%2F1GlIichmGg3YfebfxiX77%2B6ToFF6FMkJucBo284PD90AVLHhKagOea2VsbdO0fh78MAxGH9sEspyQ2uJEfYWjHFqYQ9smJyIuM3CYOmN5HKPgRWy2yUqzV7OTMe%2FivPO4%2FX6XiiN2J4nTmy83252CJUsHIvbiGctfKxcNI6b23UVN4B1tJTVgyxTOZiBQCkMLkD%2FEe5OhoAkvJgkqENRr0q3swO0IChDDWjrh7OTMwqvWGwAoVXEGiHg%3D%3D&upload_id=ABg5-UznTdib1HhOAMjdHhWIYqBbwmSYM6dVKyPe3v33uTeEE8gkN5QzvR3cei6uSZOSrjPn7bdvvDH3nhsrLBq8AjWY2qE4UQ",
      "timeout": 3600,
      "status": "waiting",
      "new_asset_settings": {
        "playback_policies": [
          "public"
        ],
        "mp4_support": "standard"
      },
      "id": "zd01Pe2bNpYhxbrwYABgFE01twZdtv4M00kts2i02GhbGjc",
      "cors_origin": "https://example.com/"
    },
    {
      "timeout": 3600,
      "status": "asset_created",
      "new_asset_settings": {
        "playback_policies": [
          "public"
        ],
        "mp4_support": "standard"
      },
      "id": "YzoCL01HHOtAVYq4Ds9zekdHJ2XqL9e8ukPWbr01KhtvM",
      "asset_id": "AnFVqAVXfb7vVL3ypSQDMnJZunnb8nkwe02O00p2gK8P00"
    },
    {
      "timeout": 10800,
      "status": "cancelled",
      "new_asset_settings": {
        "playback_policies": [
          "public"
        ],
        "mp4_support": "standard"
      },
      "id": "AZcWu0201SqVW01LMdmVxE00m3gEWUFZPItvni1sTqF800dQ"
    }
  ]
}

Retrieve a single direct upload's info
get

Fetches information about a single direct upload in the current environment.

curl https://api.mux.com/video/v1/uploads/${UPLOAD_ID} \
  -X GET \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request path & query params

UPLOAD_ID

string

ID of the Upload

get

200

/video/v1/uploads/{UPLOAD_ID}

Response

(application/json)

{
  "data": {
    "timeout": 3600,
    "status": "asset_created",
    "new_asset_settings": {
      "playback_policies": [
        "public"
      ],
      "mp4_support": "standard"
    },
    "id": "YzoCL01HHOtAVYq4Ds9zekdHJ2XqL9e8ukPWbr01KhtvM",
    "asset_id": "AnFVqAVXfb7vVL3ypSQDMnJZunnb8nkwe02O00p2gK8P00"
  }
}

Cancel a direct upload
put

Cancels a direct upload and marks it as cancelled. If a pending upload finishes after this request, no asset will be created. This request will only succeed if the upload is still in the waiting state.

curl https://api.mux.com/video/v1/uploads/${UPLOAD_ID}/cancel \
  -X PUT \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request path & query params

UPLOAD_ID

string

ID of the Upload

put

200

/video/v1/uploads/{UPLOAD_ID}/cancel

Response

(application/json)

{
  "data": {
    "timeout": 3600,
    "status": "cancelled",
    "new_asset_settings": {
      "playback_policies": [
        "public"
      ],
      "mp4_support": "standard"
    },
    "id": "zd01Pe2bNpYhxbrwYABgFE01twZdtv4M00kts2i02GhbGjc",
    "cors_origin": "https://example.com/"
  }
}

Delivery Usage

The Delivery Usage API allows you to get delivery/streaming usage details for each asset and across all assets. Delivery usage details are aggregated every hour at the top of the hour and can be requested for a specified time window within the last 90 days starting at 12 hours prior to when the request is made.

Assets are ordered by delivery usage starting with the one with the highest usage. Only assets with delivery usage greater than 0 seconds are returned in the response.

Properties

live_stream_id.

string

Unique identifier for the live stream that created the asset.

asset_id.

string

Unique identifier for the asset.

passthrough.

string

The passthrough value for the asset.

created_at.

string

Time at which the asset was created. Measured in seconds since the Unix epoch.

deleted_at.

string

If exists, time at which the asset was deleted. Measured in seconds since the Unix epoch.

asset_state.

string

Possible values: "ready" "errored" "deleted"

The state of the asset.

asset_duration.

number

The duration of the asset in seconds.

delivered_seconds.

number

Total number of delivered seconds during this time window.

List Usage
get

Returns a list of delivery usage records and their associated Asset IDs or Live Stream IDs.

curl 'https://api.mux.com/video/v1/delivery-usage?timeframe[]=${START_TIME}&timeframe[]=${END_TIME}'   -X GET \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request path & query params

page

integer

(default: 1)

Offset by this many pages, of the size of limit

limit

integer

(default: 100)

Number of items to include in the response

asset_id

string

Filter response to return delivery usage for this asset only. You cannot specify both the asset_id and live_stream_id parameters together.

live_stream_id

string

Filter response to return delivery usage for assets for this live stream. You cannot specify both the asset_id and live_stream_id parameters together.

timeframe[]

array

Time window to get delivery usage information. timeframe[0] indicates the start time, timeframe[1] indicates the end time in seconds since the Unix epoch. Default time window is 1 hour representing usage from 13th to 12th hour from when the request is made.

get

200

/video/v1/delivery-usage

Response

(application/json)

{
  "total_row_count": 2,
  "timeframe": [
    1607817600,
    1607990400
  ],
  "page": 1,
  "limit": 100,
  "data": [
    {
      "live_stream_id": "B65hEUWW01ErVKDDGImKcBquYhwEAkjW6Ic3lPY0299Cc",
      "delivered_seconds": 206.366667,
      "deleted_at": "1607945257",
      "created_at": "1607939184",
      "asset_state": "deleted",
      "asset_id": "Ww4v2q2H4MNbHIAM2wApKb3cmrh7eHjGLUjdKohR5wM",
      "asset_duration": 154.366667
    },
    {
      "delivered_seconds": 30,
      "deleted_at": "1607935288",
      "created_at": "1607617107",
      "asset_state": "deleted",
      "asset_id": "Qlb007on1TwN43XLIG027QJlUxm3jd01v5PRi1aXhnyFZY",
      "asset_duration": 98.773667
    }
  ]
}

Playback Restrictions

Playback Restrictions allows you to set additional rules for playing videos. You can set the domains/hostnames allowed to play your videos. For instance, viewers can play videos embedded on the https://example.com website when you set the Playback Restrictions with example.com as an allowed domain. Any Video requests from other websites are denied.

Properties

data.

object

data.id.

string

Unique identifier for the Playback Restriction. Max 255 characters.

data.created_at.

string

Time the Playback Restriction was created, defined as a Unix timestamp (seconds since epoch).

data.updated_at.

string

Time the Playback Restriction was last updated, defined as a Unix timestamp (seconds since epoch).

data.referrer.

object

A list of domains allowed to play your videos.

data.referrer.allowed_domains.

array

List of domains allowed to play videos. Possible values are

[] Empty Array indicates deny video playback requests for all domains
["*"] A Single Wildcard * entry means allow video playback requests from any domain
["*.example.com", "foo.com"] A list of up to 10 domains or valid dns-style wildcards

data.referrer.allow_no_referrer.

boolean

A boolean to determine whether to allow or deny HTTP requests without Referer HTTP request header. Playback requests coming from non-web/native applications like iOS, Android or smart TVs will not have a Referer HTTP header. Set this value to true to allow these playback requests.

Create a Playback Restriction
post

Create a new Playback Restriction.

curl 'https://api.mux.com/video/v1/playback-restrictions' \
  -X POST \
  -d '{ "referrer": { "allowed_domains": ["*.example.com"], "allow_no_referrer": true } }' \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request body params

referrer

object

A list of domains allowed to play your videos.

allowed_domains

array

List of domains allowed to play videos. Possible values are

[] Empty Array indicates deny video playback requests for all domains
["*"] A Single Wildcard * entry means allow video playback requests from any domain
["*.example.com", "foo.com"] A list of up to 10 domains or valid dns-style wildcards

allow_no_referrer

boolean

post

201

/video/v1/playback-restrictions

Request

(application/json)

{
  "referrer": {
    "allowed_domains": [
      "*.example.com"
    ],
    "allow_no_referrer": true
  }
}

Response

(application/json)

{
  "data": {
    "id": "9dbEg8o00uqQzZbzJT6NXdqNA00SdnSo8O",
    "updated_at": "1607945257",
    "created_at": "1607945257",
    "referrer": {
      "allowed_domains": [
        "*.example.com"
      ],
      "allow_no_referrer": true
    }
  }
}

List Playback Restrictions
get

Returns a list of all Playback Restrictions.

curl 'https://api.mux.com/video/v1/playback-restrictions' \
  -X GET \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request path & query params

page

integer

(default: 1)

Offset by this many pages, of the size of limit

limit

integer

(default: 25)

Number of items to include in the response

get

200

/video/v1/playback-restrictions

Response

(application/json)

{
  "total_row_count": 2,
  "page": 1,
  "limit": 100,
  "data": [
    {
      "id": "9dbEg8o00uqQzZbzJT6NXdqNA00SdnSo8O",
      "updated_at": "1607945257",
      "created_at": "1607939184",
      "referrer": {
        "allowed_domains": [
          "*.example.com"
        ],
        "allow_no_referrer": false
      }
    },
    {
      "id": "012uTQqPygDYWz3jey8cyOX9n01Bd5SDH1",
      "updated_at": "1607945980",
      "created_at": "1607939188",
      "referrer": {
        "allowed_domains": [
          "a.example.com",
          "b.example.com"
        ],
        "allow_no_referrer": true
      }
    }
  ]
}

Delete a Playback Restriction
del

Deletes a single Playback Restriction.

curl 'https://api.mux.com/video/v1/playback-restrictions/${PLAYBACK_RESTRICTION_ID}' \
  -X DELETE \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request path & query params

PLAYBACK_RESTRICTION_ID

string

ID of the Playback Restriction.

del

204

/video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}

Retrieve a Playback Restriction
get

Retrieves a Playback Restriction associated with the unique identifier.

curl 'https://api.mux.com/video/v1/playback-restrictions/${PLAYBACK_RESTRICTION_ID}' \
  -X GET \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request path & query params

PLAYBACK_RESTRICTION_ID

string

ID of the Playback Restriction.

get

200

/video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}

Response

(application/json)

{
  "data": {
    "id": "9dbEg8o00uqQzZbzJT6NXdqNA00SdnSo8O",
    "updated_at": "1607945257",
    "created_at": "1607939184",
    "referrer": {
      "allowed_domains": [
        "*.example.com"
      ],
      "allow_no_referrer": false
    }
  }
}

Update the Referrer Playback Restriction
put

Allows you to modify the list of domains or change how Mux validates playback requests without the Referer HTTP header. The Referrer restriction fully replaces the old list with this new list of domains.

curl 'https://api.mux.com/video/v1/playback-restrictions/${PLAYBACK_RESTRICTION_ID}/referrer' \
  -X PUT \
  -d '{ "allowed_domains": ["*.example.com"], "allow_no_referrer": true }' \
  -H "Content-Type: application/json" \
  -u ${MUX_TOKEN_ID}:${MUX_TOKEN_SECRET}

Request body params

allowed_domains

array

List of domains allowed to play videos. Possible values are

[] Empty Array indicates deny video playback requests for all domains
["*"] A Single Wildcard * entry means allow video playback requests from any domain
["*.example.com", "foo.com"] A list of up to 10 domains or valid dns-style wildcards

allow_no_referrer

boolean

Request path & query params

PLAYBACK_RESTRICTION_ID

string

ID of the Playback Restriction.

put

200

/video/v1/playback-restrictions/{PLAYBACK_RESTRICTION_ID}/referrer

Request

(application/json)

{
  "allowed_domains": [
    "*.example.com"
  ],
  "allow_no_referrer": true
}

Response

(application/json)

{
  "data": {
    "id": "9dbEg8o00uqQzZbzJT6NXdqNA00SdnSo8O",
    "updated_at": "1607945257",
    "created_at": "1607939184",
    "referrer": {
      "allowed_domains": [
        "*.example.com"
      ],
      "allow_no_referrer": true
    }
  }
}

Docs

Docs

Properties

Request body params

Request path & query params

Request path & query params

Request path & query params

Request body params

Request path & query params

Request path & query params

Request body params

Request path & query params

Request path & query params

Request path & query params

Request body params

Request path & query params

Request body params

Request path & query params

Request body params

Request path & query params

Request path & query params

Properties

Request body params

Request path & query params

Request path & query params

Request path & query params

Request body params

Request path & query params

Request body params

Request path & query params

Request path & query params

Request path & query params

Request path & query params

Request path & query params

Request path & query params

Request path & query params

Request body params

Request path & query params

Request body params

Request path & query params

Request path & query params

Request path & query params

Properties

Request body params

Request path & query params

Request path & query params

Request path & query params

Request body params

Request path & query params

Request path & query params

Request path & query params

Request path & query params

Request path & query params

Properties

Request path & query params

Properties

Request path & query params

Request path & query params

Request path & query params

Properties

Request body params

Request path & query params

Request path & query params

Request path & query params

Properties

Request path & query params

Properties

Request body params

Request path & query params

Request path & query params

Request path & query params

Request body params

Request path & query params