Skip to Content
Mux Docs: Home

Webhook Reference

An asset has been created

NameTypeDescription
type
string

Type for the webhook event

id
string

Unique identifier for the event

created_at
string

Time the event was created

object
object
object.type
string
object.id
string
environment
object
environment.name
string

Name for the environment

environment.id
string

Unique identifier for the environment

data
object
data.id
string

Unique identifier for the Asset. Max 255 characters.

data.created_at
integer
data.status
string
Possible values: "preparing""ready""errored"

The status of the asset.

data.duration
number

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

data.max_stored_resolutionDeprecated
string
Possible values: "Audio only""SD""HD""FHD""UHD"

This field is deprecated. Please use resolution_tier instead. 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.

data.resolution_tier
string
Possible values: "audio-only""720p""1080p""1440p""2160p"

The resolution tier that the asset was ingested at, affecting billing for ingest & storage. This field also represents the highest resolution tier that the content can be delivered at, however the actual resolution may be lower depending on the device, bandwidth, and exact resolution of the uploaded asset.

data.max_resolution_tier
string
Possible values: "1080p""1440p""2160p"

Max resolution tier can be used to control the maximum resolution_tier your asset is encoded, stored, and streamed at. If not set, this defaults to 1080p.

data.encoding_tier
string
Possible values: "smart""baseline"

The encoding tier informs the cost, quality, and available platform features for the asset. By default the smart encoding tier is used. See the guide for more details.

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

data.aspect_ratio
string

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

data.playback_ids
array

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

data.playback_ids[].id
string

Unique identifier for the PlaybackID

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

data.tracks
array

The individual media tracks that make up an asset.

data.tracks[].id
string

Unique identifier for the Track

data.tracks[].type
string
Possible values: "video""audio""text"

The type of track

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

data.tracks[].max_width
integer

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

data.tracks[].max_height
integer

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

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

data.tracks[].max_channels
integer

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

data.tracks[].max_channel_layoutDeprecated
string

Only set for the audio type track.

data.tracks[].text_type
string
Possible values: "subtitles"

This parameter is only set for text type tracks.

data.tracks[].text_source
string
Possible values: "uploaded""embedded""generated_live""generated_live_final""generated_vod"

The source of the text contained in a Track of type text. Valid text_source values are listed below.

  • uploaded: Tracks uploaded to Mux as caption or subtitle files using the Create Asset Track API.
  • embedded: Tracks extracted from an embedded stream of CEA-608 closed captions.
  • generated_vod: Tracks generated by automatic speech recognition on an on-demand asset.
  • generated_live: Tracks generated by automatic speech recognition on a live stream configured with generated_subtitles. If an Asset has both generated_live and generated_live_final tracks that are ready, then only the generated_live_final track will be included during playback.
  • generated_live_final: Tracks generated by automatic speech recognition on a live stream using generated_subtitles. The accuracy, timing, and formatting of these subtitles is improved compared to the corresponding generated_live tracks. However, generated_live_final tracks will not be available in ready status until the live stream ends. If an Asset has both generated_live and generated_live_final tracks that are ready, then only the generated_live_final track will be included during playback.
data.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 and audio track types.

data.tracks[].name
string

The name of the track containing a human-readable description. The HLS manifest will associate a subtitle text or audio track with this value. For example, the value should be "English" for a subtitle text track for the language_code value of en-US. This parameter is only set for text and audio track types.

data.tracks[].closed_captions
boolean

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

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

data.tracks[].status
string
Possible values: "preparing""ready""errored""deleted"

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

data.tracks[].primary
boolean

For an audio track, indicates that this is the primary audio track, ingested from the main input for this asset. The primary audio track cannot be deleted.

data.tracks[].error
object

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

data.tracks[].error.type
string

The type of error that occurred for this asset.

data.tracks[].error.messages
array

Error messages with more details.

data.errors
object

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

data.errors.type
string

The type of error that occurred for this asset.

data.errors.messages
array

Error messages with more details.

data.upload_id
string

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

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

data.passthrough
string

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

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

data.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_access is set to none and when the temporary URL expires.

data.master.status
string
Possible values: "ready""preparing""errored"
data.master.url
string

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

data.master_access
string (default: none)
Possible values: "temporary""none"
data.mp4_support
string (default: none)
Possible values: "standard""none"
data.source_asset_id
string

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

data.normalize_audio
boolean (default: false)

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

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

data.static_renditions.status
string (default: disabled)
Possible values: "ready""preparing""disabled""errored"

Indicates the status of downloadable MP4 versions of this asset.

data.static_renditions.files
array

Array of file objects.

data.static_renditions.files[].name
string
Possible values: "low.mp4""medium.mp4""high.mp4""audio.m4a"
data.static_renditions.files[].ext
string
Possible values: "mp4""m4a"

Extension of the static rendition file

data.static_renditions.files[].height
integer

The height of the static rendition's file in pixels

data.static_renditions.files[].width
integer

The width of the static rendition's file in pixels

data.static_renditions.files[].bitrate
integer

The bitrate in bits per second

data.static_renditions.files[].filesize
integer

The file size in bytes

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

data.recording_times[].started_at
object
data.recording_times[].started_at.nanos
integer
data.recording_times[].started_at.seconds
integer
data.recording_times[].duration
number

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

data.recording_times[].typeBeta
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.

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

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

data.non_standard_input_reasons.audio_codec
string

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

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

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

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

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

data.non_standard_input_reasons.pixel_aspect_ratio
string

The video pixel aspect ratio of the input file.

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

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

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

data.non_standard_input_reasons.unsupported_pixel_format
string

The video pixel format, as a string, returned by libav. Considered non-standard if not one of yuv420p or yuvj420p.

data.non_standard_input_reasons.unexpected_video_parameters
string
data.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.

data.ingest_type
string
Possible values: "on_demand_url""on_demand_direct_upload""on_demand_clip""live_rtmp""live_srt"

The type of ingest used to create the asset.

attempts
array

Attempts for sending out the webhook event

attempts[].webhook_id
integer

Unique identifier for the webhook

attempts[].response_status_code
integer

HTTP response status code for the webhook attempt

attempts[].response_headers
object

HTTP response headers for the webhook attempt

attempts[].response_body
stringnull

HTTP response body for the webhook attempt

attempts[].max_attempts
integer

Max attempts number for the webhook attempt

attempts[].id
string

Unique identifier for the webhook attempt

attempts[].created_at
string

Time the webhook request was attempted

attempts[].address
string

URL address for the webhook attempt

request_idDeprecated
stringnull
accessorDeprecated
stringnull
accessor_sourceDeprecated
stringnull

An asset is ready for playback. You can now use the asset's playback_id to successfully start streaming this asset.

NameTypeDescription
type
string

Type for the webhook event

id
string

Unique identifier for the event

created_at
string

Time the event was created

object
object
object.type
string
object.id
string
environment
object
environment.name
string

Name for the environment

environment.id
string

Unique identifier for the environment

data
object
data.id
string

Unique identifier for the Asset. Max 255 characters.

data.created_at
integer
data.status
string
Possible values: "preparing""ready""errored"

The status of the asset.

data.duration
number

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

data.max_stored_resolutionDeprecated
string
Possible values: "Audio only""SD""HD""FHD""UHD"

This field is deprecated. Please use resolution_tier instead. 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.

data.resolution_tier
string
Possible values: "audio-only""720p""1080p""1440p""2160p"

The resolution tier that the asset was ingested at, affecting billing for ingest & storage. This field also represents the highest resolution tier that the content can be delivered at, however the actual resolution may be lower depending on the device, bandwidth, and exact resolution of the uploaded asset.

data.max_resolution_tier
string
Possible values: "1080p""1440p""2160p"

Max resolution tier can be used to control the maximum resolution_tier your asset is encoded, stored, and streamed at. If not set, this defaults to 1080p.

data.encoding_tier
string
Possible values: "smart""baseline"

The encoding tier informs the cost, quality, and available platform features for the asset. By default the smart encoding tier is used. See the guide for more details.

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

data.aspect_ratio
string

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

data.playback_ids
array

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

data.playback_ids[].id
string

Unique identifier for the PlaybackID

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

data.tracks
array

The individual media tracks that make up an asset.

data.tracks[].id
string

Unique identifier for the Track

data.tracks[].type
string
Possible values: "video""audio""text"

The type of track

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

data.tracks[].max_width
integer

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

data.tracks[].max_height
integer

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

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

data.tracks[].max_channels
integer

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

data.tracks[].max_channel_layoutDeprecated
string

Only set for the audio type track.

data.tracks[].text_type
string
Possible values: "subtitles"

This parameter is only set for text type tracks.

data.tracks[].text_source
string
Possible values: "uploaded""embedded""generated_live""generated_live_final""generated_vod"

The source of the text contained in a Track of type text. Valid text_source values are listed below.

  • uploaded: Tracks uploaded to Mux as caption or subtitle files using the Create Asset Track API.
  • embedded: Tracks extracted from an embedded stream of CEA-608 closed captions.
  • generated_vod: Tracks generated by automatic speech recognition on an on-demand asset.
  • generated_live: Tracks generated by automatic speech recognition on a live stream configured with generated_subtitles. If an Asset has both generated_live and generated_live_final tracks that are ready, then only the generated_live_final track will be included during playback.
  • generated_live_final: Tracks generated by automatic speech recognition on a live stream using generated_subtitles. The accuracy, timing, and formatting of these subtitles is improved compared to the corresponding generated_live tracks. However, generated_live_final tracks will not be available in ready status until the live stream ends. If an Asset has both generated_live and generated_live_final tracks that are ready, then only the generated_live_final track will be included during playback.
data.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 and audio track types.

data.tracks[].name
string

The name of the track containing a human-readable description. The HLS manifest will associate a subtitle text or audio track with this value. For example, the value should be "English" for a subtitle text track for the language_code value of en-US. This parameter is only set for text and audio track types.

data.tracks[].closed_captions
boolean

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

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

data.tracks[].status
string
Possible values: "preparing""ready""errored""deleted"

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

data.tracks[].primary
boolean

For an audio track, indicates that this is the primary audio track, ingested from the main input for this asset. The primary audio track cannot be deleted.

data.tracks[].error
object

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

data.tracks[].error.type
string

The type of error that occurred for this asset.

data.tracks[].error.messages
array

Error messages with more details.

data.errors
object

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

data.errors.type
string

The type of error that occurred for this asset.

data.errors.messages
array

Error messages with more details.

data.upload_id
string

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

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

data.passthrough
string

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

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

data.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_access is set to none and when the temporary URL expires.

data.master.status
string
Possible values: "ready""preparing""errored"
data.master.url
string

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

data.master_access
string (default: none)
Possible values: "temporary""none"
data.mp4_support
string (default: none)
Possible values: "standard""none"
data.source_asset_id
string

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

data.normalize_audio
boolean (default: false)

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

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

data.static_renditions.status
string (default: disabled)
Possible values: "ready""preparing""disabled""errored"

Indicates the status of downloadable MP4 versions of this asset.

data.static_renditions.files
array

Array of file objects.

data.static_renditions.files[].name
string
Possible values: "low.mp4""medium.mp4""high.mp4""audio.m4a"
data.static_renditions.files[].ext
string
Possible values: "mp4""m4a"

Extension of the static rendition file

data.static_renditions.files[].height
integer

The height of the static rendition's file in pixels

data.static_renditions.files[].width
integer

The width of the static rendition's file in pixels

data.static_renditions.files[].bitrate
integer

The bitrate in bits per second

data.static_renditions.files[].filesize
integer

The file size in bytes

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

data.recording_times[].started_at
object
data.recording_times[].started_at.nanos
integer
data.recording_times[].started_at.seconds
integer
data.recording_times[].duration
number

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

data.recording_times[].typeBeta
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.

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

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

data.non_standard_input_reasons.audio_codec
string

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

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

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

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

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

data.non_standard_input_reasons.pixel_aspect_ratio
string

The video pixel aspect ratio of the input file.

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

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

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

data.non_standard_input_reasons.unsupported_pixel_format
string

The video pixel format, as a string, returned by libav. Considered non-standard if not one of yuv420p or yuvj420p.

data.non_standard_input_reasons.unexpected_video_parameters
string
data.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.

data.ingest_type
string
Possible values: "on_demand_url""on_demand_direct_upload""on_demand_clip""live_rtmp""live_srt"

The type of ingest used to create the asset.

attempts
array

Attempts for sending out the webhook event

attempts[].webhook_id
integer

Unique identifier for the webhook

attempts[].response_status_code
integer

HTTP response status code for the webhook attempt

attempts[].response_headers
object

HTTP response headers for the webhook attempt

attempts[].response_body
stringnull

HTTP response body for the webhook attempt

attempts[].max_attempts
integer

Max attempts number for the webhook attempt

attempts[].id
string

Unique identifier for the webhook attempt

attempts[].created_at
string

Time the webhook request was attempted

attempts[].address
string

URL address for the webhook attempt

request_idDeprecated
stringnull
accessorDeprecated
stringnull
accessor_sourceDeprecated
stringnull

An asset has encountered an error. Use this to notify your server about assets with errors. Asset errors can happen for a number of reasons, most commonly an input URL that Mux is unable to download or a file that is not a valid video file.

NameTypeDescription
type
string

Type for the webhook event

id
string

Unique identifier for the event

created_at
string

Time the event was created

object
object
object.type
string
object.id
string
environment
object
environment.name
string

Name for the environment

environment.id
string

Unique identifier for the environment

data
object
data.id
string

Unique identifier for the Asset. Max 255 characters.

data.created_at
integer
data.status
string
Possible values: "preparing""ready""errored"

The status of the asset.

data.duration
number

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

data.max_stored_resolutionDeprecated
string
Possible values: "Audio only""SD""HD""FHD""UHD"

This field is deprecated. Please use resolution_tier instead. 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.

data.resolution_tier
string
Possible values: "audio-only""720p""1080p""1440p""2160p"

The resolution tier that the asset was ingested at, affecting billing for ingest & storage. This field also represents the highest resolution tier that the content can be delivered at, however the actual resolution may be lower depending on the device, bandwidth, and exact resolution of the uploaded asset.

data.max_resolution_tier
string
Possible values: "1080p""1440p""2160p"

Max resolution tier can be used to control the maximum resolution_tier your asset is encoded, stored, and streamed at. If not set, this defaults to 1080p.

data.encoding_tier
string
Possible values: "smart""baseline"

The encoding tier informs the cost, quality, and available platform features for the asset. By default the smart encoding tier is used. See the guide for more details.

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

data.aspect_ratio
string

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

data.playback_ids
array

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

data.playback_ids[].id
string

Unique identifier for the PlaybackID

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

data.tracks
array

The individual media tracks that make up an asset.

data.tracks[].id
string

Unique identifier for the Track

data.tracks[].type
string
Possible values: "video""audio""text"

The type of track

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

data.tracks[].max_width
integer

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

data.tracks[].max_height
integer

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

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

data.tracks[].max_channels
integer

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

data.tracks[].max_channel_layoutDeprecated
string

Only set for the audio type track.

data.tracks[].text_type
string
Possible values: "subtitles"

This parameter is only set for text type tracks.

data.tracks[].text_source
string
Possible values: "uploaded""embedded""generated_live""generated_live_final""generated_vod"

The source of the text contained in a Track of type text. Valid text_source values are listed below.

  • uploaded: Tracks uploaded to Mux as caption or subtitle files using the Create Asset Track API.
  • embedded: Tracks extracted from an embedded stream of CEA-608 closed captions.
  • generated_vod: Tracks generated by automatic speech recognition on an on-demand asset.
  • generated_live: Tracks generated by automatic speech recognition on a live stream configured with generated_subtitles. If an Asset has both generated_live and generated_live_final tracks that are ready, then only the generated_live_final track will be included during playback.
  • generated_live_final: Tracks generated by automatic speech recognition on a live stream using generated_subtitles. The accuracy, timing, and formatting of these subtitles is improved compared to the corresponding generated_live tracks. However, generated_live_final tracks will not be available in ready status until the live stream ends. If an Asset has both generated_live and generated_live_final tracks that are ready, then only the generated_live_final track will be included during playback.
data.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 and audio track types.

data.tracks[].name
string

The name of the track containing a human-readable description. The HLS manifest will associate a subtitle text or audio track with this value. For example, the value should be "English" for a subtitle text track for the language_code value of en-US. This parameter is only set for text and audio track types.

data.tracks[].closed_captions
boolean

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

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

data.tracks[].status
string
Possible values: "preparing""ready""errored""deleted"

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

data.tracks[].primary
boolean

For an audio track, indicates that this is the primary audio track, ingested from the main input for this asset. The primary audio track cannot be deleted.

data.tracks[].error
object

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

data.tracks[].error.type
string

The type of error that occurred for this asset.

data.tracks[].error.messages
array

Error messages with more details.

data.errors
object

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

data.errors.type
string

The type of error that occurred for this asset.

data.errors.messages
array

Error messages with more details.

data.upload_id
string

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

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

data.passthrough
string

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

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

data.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_access is set to none and when the temporary URL expires.

data.master.status
string
Possible values: "ready""preparing""errored"
data.master.url
string

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

data.master_access
string (default: none)
Possible values: "temporary""none"
data.mp4_support
string (default: none)
Possible values: "standard""none"
data.source_asset_id
string

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

data.normalize_audio
boolean (default: false)

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

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

data.static_renditions.status
string (default: disabled)
Possible values: "ready""preparing""disabled""errored"

Indicates the status of downloadable MP4 versions of this asset.

data.static_renditions.files
array

Array of file objects.

data.static_renditions.files[].name
string
Possible values: "low.mp4""medium.mp4""high.mp4""audio.m4a"
data.static_renditions.files[].ext
string
Possible values: "mp4""m4a"

Extension of the static rendition file

data.static_renditions.files[].height
integer

The height of the static rendition's file in pixels

data.static_renditions.files[].width
integer

The width of the static rendition's file in pixels

data.static_renditions.files[].bitrate
integer

The bitrate in bits per second

data.static_renditions.files[].filesize
integer

The file size in bytes

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

data.recording_times[].started_at
object
data.recording_times[].started_at.nanos
integer
data.recording_times[].started_at.seconds
integer
data.recording_times[].duration
number

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

data.recording_times[].typeBeta
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.

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

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

data.non_standard_input_reasons.audio_codec
string

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

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

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

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

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

data.non_standard_input_reasons.pixel_aspect_ratio
string

The video pixel aspect ratio of the input file.

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

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

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

data.non_standard_input_reasons.unsupported_pixel_format
string

The video pixel format, as a string, returned by libav. Considered non-standard if not one of yuv420p or yuvj420p.

data.non_standard_input_reasons.unexpected_video_parameters
string
data.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.

data.ingest_type
string
Possible values: "on_demand_url""on_demand_direct_upload""on_demand_clip""live_rtmp""live_srt"

The type of ingest used to create the asset.

attempts
array

Attempts for sending out the webhook event

attempts[].webhook_id
integer

Unique identifier for the webhook

attempts[].response_status_code
integer

HTTP response status code for the webhook attempt

attempts[].response_headers
object

HTTP response headers for the webhook attempt

attempts[].response_body
stringnull

HTTP response body for the webhook attempt

attempts[].max_attempts
integer

Max attempts number for the webhook attempt

attempts[].id
string

Unique identifier for the webhook attempt

attempts[].created_at
string

Time the webhook request was attempted

attempts[].address
string

URL address for the webhook attempt

request_idDeprecated
stringnull
accessorDeprecated
stringnull
accessor_sourceDeprecated
stringnull

An asset has been updated. Use this to make sure your server is notified about changes to assets.

NameTypeDescription
type
string

Type for the webhook event

id
string

Unique identifier for the event

created_at
string

Time the event was created

object
object
object.type
string
object.id
string
environment
object
environment.name
string

Name for the environment

environment.id
string

Unique identifier for the environment

data
object
data.id
string

Unique identifier for the Asset. Max 255 characters.

data.created_at
integer
data.status
string
Possible values: "preparing""ready""errored"

The status of the asset.

data.duration
number

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

data.max_stored_resolutionDeprecated
string
Possible values: "Audio only""SD""HD""FHD""UHD"

This field is deprecated. Please use resolution_tier instead. 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.

data.resolution_tier
string
Possible values: "audio-only""720p""1080p""1440p""2160p"

The resolution tier that the asset was ingested at, affecting billing for ingest & storage. This field also represents the highest resolution tier that the content can be delivered at, however the actual resolution may be lower depending on the device, bandwidth, and exact resolution of the uploaded asset.

data.max_resolution_tier
string
Possible values: "1080p""1440p""2160p"

Max resolution tier can be used to control the maximum resolution_tier your asset is encoded, stored, and streamed at. If not set, this defaults to 1080p.

data.encoding_tier
string
Possible values: "smart""baseline"

The encoding tier informs the cost, quality, and available platform features for the asset. By default the smart encoding tier is used. See the guide for more details.

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

data.aspect_ratio
string

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

data.playback_ids
array

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

data.playback_ids[].id
string

Unique identifier for the PlaybackID

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

data.tracks
array

The individual media tracks that make up an asset.

data.tracks[].id
string

Unique identifier for the Track

data.tracks[].type
string
Possible values: "video""audio""text"

The type of track

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

data.tracks[].max_width
integer

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

data.tracks[].max_height
integer

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

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

data.tracks[].max_channels
integer

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

data.tracks[].max_channel_layoutDeprecated
string

Only set for the audio type track.

data.tracks[].text_type
string
Possible values: "subtitles"

This parameter is only set for text type tracks.

data.tracks[].text_source
string
Possible values: "uploaded""embedded""generated_live""generated_live_final""generated_vod"

The source of the text contained in a Track of type text. Valid text_source values are listed below.

  • uploaded: Tracks uploaded to Mux as caption or subtitle files using the Create Asset Track API.
  • embedded: Tracks extracted from an embedded stream of CEA-608 closed captions.
  • generated_vod: Tracks generated by automatic speech recognition on an on-demand asset.
  • generated_live: Tracks generated by automatic speech recognition on a live stream configured with generated_subtitles. If an Asset has both generated_live and generated_live_final tracks that are ready, then only the generated_live_final track will be included during playback.
  • generated_live_final: Tracks generated by automatic speech recognition on a live stream using generated_subtitles. The accuracy, timing, and formatting of these subtitles is improved compared to the corresponding generated_live tracks. However, generated_live_final tracks will not be available in ready status until the live stream ends. If an Asset has both generated_live and generated_live_final tracks that are ready, then only the generated_live_final track will be included during playback.
data.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 and audio track types.

data.tracks[].name
string

The name of the track containing a human-readable description. The HLS manifest will associate a subtitle text or audio track with this value. For example, the value should be "English" for a subtitle text track for the language_code value of en-US. This parameter is only set for text and audio track types.

data.tracks[].closed_captions
boolean

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

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

data.tracks[].status
string
Possible values: "preparing""ready""errored""deleted"

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

data.tracks[].primary
boolean

For an audio track, indicates that this is the primary audio track, ingested from the main input for this asset. The primary audio track cannot be deleted.

data.tracks[].error
object

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

data.tracks[].error.type
string

The type of error that occurred for this asset.

data.tracks[].error.messages
array

Error messages with more details.

data.errors
object

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

data.errors.type
string

The type of error that occurred for this asset.

data.errors.messages
array

Error messages with more details.

data.upload_id
string

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

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

data.passthrough
string

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

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

data.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_access is set to none and when the temporary URL expires.

data.master.status
string
Possible values: "ready""preparing""errored"
data.master.url
string

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

data.master_access
string (default: none)
Possible values: "temporary""none"
data.mp4_support
string (default: none)
Possible values: "standard""none"
data.source_asset_id
string

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

data.normalize_audio
boolean (default: false)

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

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

data.static_renditions.status
string (default: disabled)
Possible values: "ready""preparing""disabled""errored"

Indicates the status of downloadable MP4 versions of this asset.

data.static_renditions.files
array

Array of file objects.

data.static_renditions.files[].name
string
Possible values: "low.mp4""medium.mp4""high.mp4""audio.m4a"
data.static_renditions.files[].ext
string
Possible values: "mp4""m4a"

Extension of the static rendition file

data.static_renditions.files[].height
integer

The height of the static rendition's file in pixels

data.static_renditions.files[].width
integer

The width of the static rendition's file in pixels

data.static_renditions.files[].bitrate
integer

The bitrate in bits per second

data.static_renditions.files[].filesize
integer

The file size in bytes

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

data.recording_times[].started_at
object
data.recording_times[].started_at.nanos
integer
data.recording_times[].started_at.seconds
integer
data.recording_times[].duration
number

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

data.recording_times[].typeBeta
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.

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

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

data.non_standard_input_reasons.audio_codec
string

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

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

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

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

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

data.non_standard_input_reasons.pixel_aspect_ratio
string

The video pixel aspect ratio of the input file.

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

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

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

data.non_standard_input_reasons.unsupported_pixel_format
string

The video pixel format, as a string, returned by libav. Considered non-standard if not one of yuv420p or yuvj420p.

data.non_standard_input_reasons.unexpected_video_parameters
string
data.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.

data.ingest_type
string
Possible values: "on_demand_url""on_demand_direct_upload""on_demand_clip""live_rtmp""live_srt"

The type of ingest used to create the asset.

attempts
array

Attempts for sending out the webhook event

attempts[].webhook_id
integer

Unique identifier for the webhook

attempts[].response_status_code
integer

HTTP response status code for the webhook attempt

attempts[].response_headers
object

HTTP response headers for the webhook attempt

attempts[].response_body
stringnull

HTTP response body for the webhook attempt

attempts[].max_attempts
integer

Max attempts number for the webhook attempt

attempts[].id
string

Unique identifier for the webhook attempt

attempts[].created_at
string

Time the webhook request was attempted

attempts[].address
string

URL address for the webhook attempt

request_idDeprecated
stringnull
accessorDeprecated
stringnull
accessor_sourceDeprecated
stringnull

An asset has been deleted. Use this so that your server knows when an asset has been deleted, at which point it will no longer be playable.

NameTypeDescription
type
string

Type for the webhook event

id
string

Unique identifier for the event

created_at
string

Time the event was created

object
object
object.type
string
object.id
string
environment
object
environment.name
string

Name for the environment

environment.id
string

Unique identifier for the environment

data
object
data.id
string

Unique identifier for the Asset. Max 255 characters.

data.created_at
integer
data.status
string
Possible values: "preparing""ready""errored"

The status of the asset.

data.duration
number

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

data.max_stored_resolutionDeprecated
string
Possible values: "Audio only""SD""HD""FHD""UHD"

This field is deprecated. Please use resolution_tier instead. 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.

data.resolution_tier
string
Possible values: "audio-only""720p""1080p""1440p""2160p"

The resolution tier that the asset was ingested at, affecting billing for ingest & storage. This field also represents the highest resolution tier that the content can be delivered at, however the actual resolution may be lower depending on the device, bandwidth, and exact resolution of the uploaded asset.

data.max_resolution_tier
string
Possible values: "1080p""1440p""2160p"

Max resolution tier can be used to control the maximum resolution_tier your asset is encoded, stored, and streamed at. If not set, this defaults to 1080p.

data.encoding_tier
string
Possible values: "smart""baseline"

The encoding tier informs the cost, quality, and available platform features for the asset. By default the smart encoding tier is used. See the guide for more details.

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

data.aspect_ratio
string

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

data.playback_ids
array

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

data.playback_ids[].id
string

Unique identifier for the PlaybackID

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

data.tracks
array

The individual media tracks that make up an asset.

data.tracks[].id
string

Unique identifier for the Track

data.tracks[].type
string
Possible values: "video""audio""text"

The type of track

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

data.tracks[].max_width
integer

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

data.tracks[].max_height
integer

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

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

data.tracks[].max_channels
integer

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

data.tracks[].max_channel_layoutDeprecated
string

Only set for the audio type track.

data.tracks[].text_type
string
Possible values: "subtitles"

This parameter is only set for text type tracks.

data.tracks[].text_source
string
Possible values: "uploaded""embedded""generated_live""generated_live_final""generated_vod"

The source of the text contained in a Track of type text. Valid text_source values are listed below.

  • uploaded: Tracks uploaded to Mux as caption or subtitle files using the Create Asset Track API.
  • embedded: Tracks extracted from an embedded stream of CEA-608 closed captions.
  • generated_vod: Tracks generated by automatic speech recognition on an on-demand asset.
  • generated_live: Tracks generated by automatic speech recognition on a live stream configured with generated_subtitles. If an Asset has both generated_live and generated_live_final tracks that are ready, then only the generated_live_final track will be included during playback.
  • generated_live_final: Tracks generated by automatic speech recognition on a live stream using generated_subtitles. The accuracy, timing, and formatting of these subtitles is improved compared to the corresponding generated_live tracks. However, generated_live_final tracks will not be available in ready status until the live stream ends. If an Asset has both generated_live and generated_live_final tracks that are ready, then only the generated_live_final track will be included during playback.
data.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 and audio track types.

data.tracks[].name
string

The name of the track containing a human-readable description. The HLS manifest will associate a subtitle text or audio track with this value. For example, the value should be "English" for a subtitle text track for the language_code value of en-US. This parameter is only set for text and audio track types.

data.tracks[].closed_captions
boolean

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

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

data.tracks[].status
string
Possible values: "preparing""ready""errored""deleted"

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

data.tracks[].primary
boolean

For an audio track, indicates that this is the primary audio track, ingested from the main input for this asset. The primary audio track cannot be deleted.

data.tracks[].error
object

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

data.tracks[].error.type
string

The type of error that occurred for this asset.

data.tracks[].error.messages
array

Error messages with more details.

data.errors
object

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

data.errors.type
string

The type of error that occurred for this asset.

data.errors.messages
array

Error messages with more details.

data.upload_id
string

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

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

data.passthrough
string

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

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

data.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_access is set to none and when the temporary URL expires.

data.master.status
string
Possible values: "ready""preparing""errored"
data.master.url
string

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

data.master_access
string (default: none)
Possible values: "temporary""none"
data.mp4_support
string (default: none)
Possible values: "standard""none"
data.source_asset_id
string

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

data.normalize_audio
boolean (default: false)

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

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

data.static_renditions.status
string (default: disabled)
Possible values: "ready""preparing""disabled""errored"

Indicates the status of downloadable MP4 versions of this asset.

data.static_renditions.files
array

Array of file objects.

data.static_renditions.files[].name
string
Possible values: "low.mp4""medium.mp4""high.mp4""audio.m4a"
data.static_renditions.files[].ext
string
Possible values: "mp4""m4a"

Extension of the static rendition file

data.static_renditions.files[].height
integer

The height of the static rendition's file in pixels

data.static_renditions.files[].width
integer

The width of the static rendition's file in pixels

data.static_renditions.files[].bitrate
integer

The bitrate in bits per second

data.static_renditions.files[].filesize
integer

The file size in bytes

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

data.recording_times[].started_at
object
data.recording_times[].started_at.nanos
integer
data.recording_times[].started_at.seconds
integer
data.recording_times[].duration
number

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

data.recording_times[].typeBeta
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.

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

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

data.non_standard_input_reasons.audio_codec
string

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

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

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

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

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

data.non_standard_input_reasons.pixel_aspect_ratio
string

The video pixel aspect ratio of the input file.

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

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

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

data.non_standard_input_reasons.unsupported_pixel_format
string

The video pixel format, as a string, returned by libav. Considered non-standard if not one of yuv420p or yuvj420p.

data.non_standard_input_reasons.unexpected_video_parameters
string
data.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.

data.ingest_type
string
Possible values: "on_demand_url""on_demand_direct_upload""on_demand_clip""live_rtmp""live_srt"

The type of ingest used to create the asset.

attempts
array

Attempts for sending out the webhook event

attempts[].webhook_id
integer

Unique identifier for the webhook

attempts[].response_status_code
integer

HTTP response status code for the webhook attempt

attempts[].response_headers
object

HTTP response headers for the webhook attempt

attempts[].response_body
stringnull

HTTP response body for the webhook attempt

attempts[].max_attempts
integer

Max attempts number for the webhook attempt

attempts[].id
string

Unique identifier for the webhook attempt

attempts[].created_at
string

Time the webhook request was attempted

attempts[].address
string

URL address for the webhook attempt

request_idDeprecated
stringnull
accessorDeprecated
stringnull
accessor_sourceDeprecated
stringnull

The live stream for this asset has completed. Every time a live stream starts and ends a new asset gets created and this event fires.

NameTypeDescription
type
string

Type for the webhook event

id
string

Unique identifier for the event

created_at
string

Time the event was created

object
object
object.type
string
object.id
string
environment
object
environment.name
string

Name for the environment

environment.id
string

Unique identifier for the environment

data
object
data.id
string

Unique identifier for the Asset. Max 255 characters.

data.created_at
integer
data.status
string
Possible values: "preparing""ready""errored"

The status of the asset.

data.duration
number

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

data.max_stored_resolutionDeprecated
string
Possible values: "Audio only""SD""HD""FHD""UHD"

This field is deprecated. Please use resolution_tier instead. 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.

data.resolution_tier
string
Possible values: "audio-only""720p""1080p""1440p""2160p"

The resolution tier that the asset was ingested at, affecting billing for ingest & storage. This field also represents the highest resolution tier that the content can be delivered at, however the actual resolution may be lower depending on the device, bandwidth, and exact resolution of the uploaded asset.

data.max_resolution_tier
string
Possible values: "1080p""1440p""2160p"

Max resolution tier can be used to control the maximum resolution_tier your asset is encoded, stored, and streamed at. If not set, this defaults to 1080p.

data.encoding_tier
string
Possible values: "smart""baseline"

The encoding tier informs the cost, quality, and available platform features for the asset. By default the smart encoding tier is used. See the guide for more details.

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

data.aspect_ratio
string

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

data.playback_ids
array

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

data.playback_ids[].id
string

Unique identifier for the PlaybackID

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

data.tracks
array

The individual media tracks that make up an asset.

data.tracks[].id
string

Unique identifier for the Track

data.tracks[].type
string
Possible values: "video""audio""text"

The type of track

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

data.tracks[].max_width
integer

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

data.tracks[].max_height
integer

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

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

data.tracks[].max_channels
integer

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

data.tracks[].max_channel_layoutDeprecated
string

Only set for the audio type track.

data.tracks[].text_type
string
Possible values: "subtitles"

This parameter is only set for text type tracks.

data.tracks[].text_source
string
Possible values: "uploaded""embedded""generated_live""generated_live_final""generated_vod"

The source of the text contained in a Track of type text. Valid text_source values are listed below.

  • uploaded: Tracks uploaded to Mux as caption or subtitle files using the Create Asset Track API.
  • embedded: Tracks extracted from an embedded stream of CEA-608 closed captions.
  • generated_vod: Tracks generated by automatic speech recognition on an on-demand asset.
  • generated_live: Tracks generated by automatic speech recognition on a live stream configured with generated_subtitles. If an Asset has both generated_live and generated_live_final tracks that are ready, then only the generated_live_final track will be included during playback.
  • generated_live_final: Tracks generated by automatic speech recognition on a live stream using generated_subtitles. The accuracy, timing, and formatting of these subtitles is improved compared to the corresponding generated_live tracks. However, generated_live_final tracks will not be available in ready status until the live stream ends. If an Asset has both generated_live and generated_live_final tracks that are ready, then only the generated_live_final track will be included during playback.
data.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 and audio track types.

data.tracks[].name
string

The name of the track containing a human-readable description. The HLS manifest will associate a subtitle text or audio track with this value. For example, the value should be "English" for a subtitle text track for the language_code value of en-US. This parameter is only set for text and audio track types.

data.tracks[].closed_captions
boolean

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

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

data.tracks[].status
string
Possible values: "preparing""ready""errored""deleted"

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

data.tracks[].primary
boolean

For an audio track, indicates that this is the primary audio track, ingested from the main input for this asset. The primary audio track cannot be deleted.

data.tracks[].error
object

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

data.tracks[].error.type
string

The type of error that occurred for this asset.

data.tracks[].error.messages
array

Error messages with more details.

data.errors
object

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

data.errors.type
string

The type of error that occurred for this asset.

data.errors.messages
array

Error messages with more details.

data.upload_id
string

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

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

data.passthrough
string

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

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

data.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_access is set to none and when the temporary URL expires.

data.master.status
string
Possible values: "ready""preparing""errored"
data.master.url
string

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

data.master_access
string (default: none)
Possible values: "temporary""none"
data.mp4_support
string (default: none)
Possible values: "standard""none"
data.source_asset_id
string

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

data.normalize_audio
boolean (default: false)

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

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

data.static_renditions.status
string (default: disabled)
Possible values: "ready""preparing""disabled""errored"

Indicates the status of downloadable MP4 versions of this asset.

data.static_renditions.files
array

Array of file objects.

data.static_renditions.files[].name
string
Possible values: "low.mp4""medium.mp4""high.mp4""audio.m4a"
data.static_renditions.files[].ext
string
Possible values: "mp4""m4a"

Extension of the static rendition file

data.static_renditions.files[].height
integer

The height of the static rendition's file in pixels

data.static_renditions.files[].width
integer

The width of the static rendition's file in pixels

data.static_renditions.files[].bitrate
integer

The bitrate in bits per second

data.static_renditions.files[].filesize
integer

The file size in bytes

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

data.recording_times[].started_at
object
data.recording_times[].started_at.nanos
integer
data.recording_times[].started_at.seconds
integer
data.recording_times[].duration
number

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

data.recording_times[].typeBeta
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.

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

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

data.non_standard_input_reasons.audio_codec
string

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

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

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

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

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

data.non_standard_input_reasons.pixel_aspect_ratio
string

The video pixel aspect ratio of the input file.

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

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

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

data.non_standard_input_reasons.unsupported_pixel_format
string

The video pixel format, as a string, returned by libav. Considered non-standard if not one of yuv420p or yuvj420p.

data.non_standard_input_reasons.unexpected_video_parameters
string
data.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.

data.ingest_type
string
Possible values: "on_demand_url""on_demand_direct_upload""on_demand_clip""live_rtmp""live_srt"

The type of ingest used to create the asset.

attempts
array

Attempts for sending out the webhook event

attempts[].webhook_id
integer

Unique identifier for the webhook

attempts[].response_status_code
integer

HTTP response status code for the webhook attempt

attempts[].response_headers
object

HTTP response headers for the webhook attempt

attempts[].response_body
stringnull

HTTP response body for the webhook attempt

attempts[].max_attempts
integer

Max attempts number for the webhook attempt

attempts[].id
string

Unique identifier for the webhook attempt

attempts[].created_at
string

Time the webhook request was attempted

attempts[].address
string

URL address for the webhook attempt

request_idDeprecated
stringnull
accessorDeprecated
stringnull
accessor_sourceDeprecated
stringnull

Static renditions for this asset are ready. Static renditions are streamable mp4 files that are most commonly used for allowing users to download files for offline viewing.

NameTypeDescription
type
string

Type for the webhook event

id
string

Unique identifier for the event

created_at
string

Time the event was created

object
object
object.type
string
object.id
string
environment
object
environment.name
string

Name for the environment

environment.id
string

Unique identifier for the environment

data
object
data.id
string

Unique identifier for the Asset. Max 255 characters.

data.created_at
integer
data.status
string
Possible values: "preparing""ready""errored"

The status of the asset.

data.duration
number

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

data.max_stored_resolutionDeprecated
string
Possible values: "Audio only""SD""HD""FHD""UHD"

This field is deprecated. Please use resolution_tier instead. 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.

data.resolution_tier
string
Possible values: "audio-only""720p""1080p""1440p""2160p"

The resolution tier that the asset was ingested at, affecting billing for ingest & storage. This field also represents the highest resolution tier that the content can be delivered at, however the actual resolution may be lower depending on the device, bandwidth, and exact resolution of the uploaded asset.

data.max_resolution_tier
string
Possible values: "1080p""1440p""2160p"

Max resolution tier can be used to control the maximum resolution_tier your asset is encoded, stored, and streamed at. If not set, this defaults to 1080p.

data.encoding_tier
string
Possible values: "smart""baseline"

The encoding tier informs the cost, quality, and available platform features for the asset. By default the smart encoding tier is used. See the guide for more details.

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

data.aspect_ratio
string

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

data.playback_ids
array

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

data.playback_ids[].id
string

Unique identifier for the PlaybackID

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

data.tracks
array

The individual media tracks that make up an asset.

data.tracks[].id
string

Unique identifier for the Track

data.tracks[].type
string
Possible values: "video""audio""text"

The type of track

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

data.tracks[].max_width
integer

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

data.tracks[].max_height
integer

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

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

data.tracks[].max_channels
integer

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

data.tracks[].max_channel_layoutDeprecated
string

Only set for the audio type track.

data.tracks[].text_type
string
Possible values: "subtitles"

This parameter is only set for text type tracks.

data.tracks[].text_source
string
Possible values: "uploaded""embedded""generated_live""generated_live_final""generated_vod"

The source of the text contained in a Track of type text. Valid text_source values are listed below.

  • uploaded: Tracks uploaded to Mux as caption or subtitle files using the Create Asset Track API.
  • embedded: Tracks extracted from an embedded stream of CEA-608 closed captions.
  • generated_vod: Tracks generated by automatic speech recognition on an on-demand asset.
  • generated_live: Tracks generated by automatic speech recognition on a live stream configured with generated_subtitles. If an Asset has both generated_live and generated_live_final tracks that are ready, then only the generated_live_final track will be included during playback.
  • generated_live_final: Tracks generated by automatic speech recognition on a live stream using generated_subtitles. The accuracy, timing, and formatting of these subtitles is improved compared to the corresponding generated_live tracks. However, generated_live_final tracks will not be available in ready status until the live stream ends. If an Asset has both generated_live and generated_live_final tracks that are ready, then only the generated_live_final track will be included during playback.
data.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 and audio track types.

data.tracks[].name
string

The name of the track containing a human-readable description. The HLS manifest will associate a subtitle text or audio track with this value. For example, the value should be "English" for a subtitle text track for the language_code value of en-US. This parameter is only set for text and audio track types.

data.tracks[].closed_captions
boolean

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

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

data.tracks[].status
string
Possible values: "preparing""ready""errored""deleted"

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

data.tracks[].primary
boolean

For an audio track, indicates that this is the primary audio track, ingested from the main input for this asset. The primary audio track cannot be deleted.

data.tracks[].error
object

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

data.tracks[].error.type
string

The type of error that occurred for this asset.

data.tracks[].error.messages
array

Error messages with more details.

data.errors
object

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

data.errors.type
string

The type of error that occurred for this asset.

data.errors.messages
array

Error messages with more details.

data.upload_id
string

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

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

data.passthrough
string

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

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

data.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_access is set to none and when the temporary URL expires.

data.master.status
string
Possible values: "ready""preparing""errored"
data.master.url
string

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

data.master_access
string (default: none)
Possible values: "temporary""none"
data.mp4_support
string (default: none)
Possible values: "standard""none"
data.source_asset_id
string

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

data.normalize_audio
boolean (default: false)

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

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

data.static_renditions.status
string (default: disabled)
Possible values: "ready""preparing""disabled""errored"

Indicates the status of downloadable MP4 versions of this asset.

data.static_renditions.files
array

Array of file objects.

data.static_renditions.files[].name
string
Possible values: "low.mp4""medium.mp4""high.mp4""audio.m4a"
data.static_renditions.files[].ext
string
Possible values: "mp4""m4a"

Extension of the static rendition file

data.static_renditions.files[].height
integer

The height of the static rendition's file in pixels

data.static_renditions.files[].width
integer

The width of the static rendition's file in pixels

data.static_renditions.files[].bitrate
integer

The bitrate in bits per second

data.static_renditions.files[].filesize
integer

The file size in bytes

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

data.recording_times[].started_at
object
data.recording_times[].started_at.nanos
integer
data.recording_times[].started_at.seconds
integer
data.recording_times[].duration
number

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

data.recording_times[].typeBeta
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.

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

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

data.non_standard_input_reasons.audio_codec
string

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

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

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

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

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

data.non_standard_input_reasons.pixel_aspect_ratio
string

The video pixel aspect ratio of the input file.

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

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

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

data.non_standard_input_reasons.unsupported_pixel_format
string

The video pixel format, as a string, returned by libav. Considered non-standard if not one of yuv420p or yuvj420p.

data.non_standard_input_reasons.unexpected_video_parameters
string
data.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.

data.ingest_type
string
Possible values: "on_demand_url""on_demand_direct_upload""on_demand_clip""live_rtmp""live_srt"

The type of ingest used to create the asset.

attempts
array

Attempts for sending out the webhook event

attempts[].webhook_id
integer

Unique identifier for the webhook

attempts[].response_status_code
integer

HTTP response status code for the webhook attempt

attempts[].response_headers
object

HTTP response headers for the webhook attempt

attempts[].response_body
stringnull

HTTP response body for the webhook attempt

attempts[].max_attempts
integer

Max attempts number for the webhook attempt

attempts[].id
string

Unique identifier for the webhook attempt

attempts[].created_at
string

Time the webhook request was attempted

attempts[].address
string

URL address for the webhook attempt

request_idDeprecated
stringnull
accessorDeprecated
stringnull
accessor_sourceDeprecated
stringnull

Static renditions for this asset are being prepared. After requesting static renditions you will get this webhook when they are being prepared.

NameTypeDescription
type
string

Type for the webhook event

id
string

Unique identifier for the event

created_at
string

Time the event was created

object
object
object.type
string
object.id
string
environment
object
environment.name
string

Name for the environment

environment.id
string

Unique identifier for the environment

data
object
data.id
string

Unique identifier for the Asset. Max 255 characters.

data.created_at
integer
data.status
string
Possible values: "preparing""ready""errored"

The status of the asset.

data.duration
number

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

data.max_stored_resolutionDeprecated
string
Possible values: "Audio only""SD""HD""FHD""UHD"

This field is deprecated. Please use resolution_tier instead. 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.

data.resolution_tier
string
Possible values: "audio-only""720p""1080p""1440p""2160p"

The resolution tier that the asset was ingested at, affecting billing for ingest & storage. This field also represents the highest resolution tier that the content can be delivered at, however the actual resolution may be lower depending on the device, bandwidth, and exact resolution of the uploaded asset.

data.max_resolution_tier
string
Possible values: "1080p""1440p""2160p"

Max resolution tier can be used to control the maximum resolution_tier your asset is encoded, stored, and streamed at. If not set, this defaults to 1080p.

data.encoding_tier
string
Possible values: "smart""baseline"

The encoding tier informs the cost, quality, and available platform features for the asset. By default the smart encoding tier is used. See the guide for more details.

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

data.aspect_ratio
string

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

data.playback_ids
array

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

data.playback_ids[].id
string

Unique identifier for the PlaybackID

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

data.tracks
array

The individual media tracks that make up an asset.

data.tracks[].id
string

Unique identifier for the Track

data.tracks[].type
string
Possible values: "video""audio""text"

The type of track

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

data.tracks[].max_width
integer

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

data.tracks[].max_height
integer

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

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

data.tracks[].max_channels
integer

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

data.tracks[].max_channel_layoutDeprecated
string

Only set for the audio type track.

data.tracks[].text_type
string
Possible values: "subtitles"

This parameter is only set for text type tracks.

data.tracks[].text_source
string
Possible values: "uploaded""embedded""generated_live""generated_live_final""generated_vod"

The source of the text contained in a Track of type text. Valid text_source values are listed below.

  • uploaded: Tracks uploaded to Mux as caption or subtitle files using the Create Asset Track API.
  • embedded: Tracks extracted from an embedded stream of CEA-608 closed captions.
  • generated_vod: Tracks generated by automatic speech recognition on an on-demand asset.
  • generated_live: Tracks generated by automatic speech recognition on a live stream configured with generated_subtitles. If an Asset has both generated_live and generated_live_final tracks that are ready, then only the generated_live_final track will be included during playback.
  • generated_live_final: Tracks generated by automatic speech recognition on a live stream using generated_subtitles. The accuracy, timing, and formatting of these subtitles is improved compared to the corresponding generated_live tracks. However, generated_live_final tracks will not be available in ready status until the live stream ends. If an Asset has both generated_live and generated_live_final tracks that are ready, then only the generated_live_final track will be included during playback.
data.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 and audio track types.

data.tracks[].name
string

The name of the track containing a human-readable description. The HLS manifest will associate a subtitle text or audio track with this value. For example, the value should be "English" for a subtitle text track for the language_code value of en-US. This parameter is only set for text and audio track types.

data.tracks[].closed_captions
boolean

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

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

data.tracks[].status
string
Possible values: "preparing""ready""errored""deleted"

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

data.tracks[].primary
boolean

For an audio track, indicates that this is the primary audio track, ingested from the main input for this asset. The primary audio track cannot be deleted.

data.tracks[].error
object

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

data.tracks[].error.type
string

The type of error that occurred for this asset.

data.tracks[].error.messages
array

Error messages with more details.

data.errors
object

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

data.errors.type
string

The type of error that occurred for this asset.

data.errors.messages
array

Error messages with more details.

data.upload_id
string

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

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

data.passthrough
string

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

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

data.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_access is set to none and when the temporary URL expires.

data.master.status
string
Possible values: "ready""preparing""errored"
data.master.url
string

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

data.master_access
string (default: none)
Possible values: "temporary""none"
data.mp4_support
string (default: none)
Possible values: "standard""none"
data.source_asset_id
string

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

data.normalize_audio
boolean (default: false)

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

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

data.static_renditions.status
string (default: disabled)
Possible values: "ready""preparing""disabled""errored"

Indicates the status of downloadable MP4 versions of this asset.

data.static_renditions.files
array

Array of file objects.

data.static_renditions.files[].name
string
Possible values: "low.mp4""medium.mp4""high.mp4""audio.m4a"
data.static_renditions.files[].ext
string
Possible values: "mp4""m4a"

Extension of the static rendition file

data.static_renditions.files[].height
integer

The height of the static rendition's file in pixels

data.static_renditions.files[].width
integer

The width of the static rendition's file in pixels

data.static_renditions.files[].bitrate
integer

The bitrate in bits per second

data.static_renditions.files[].filesize
integer

The file size in bytes

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

data.recording_times[].started_at
object
data.recording_times[].started_at.nanos
integer
data.recording_times[].started_at.seconds
integer
data.recording_times[].duration
number

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

data.recording_times[].typeBeta
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.

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

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

data.non_standard_input_reasons.audio_codec
string

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

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

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

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

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

data.non_standard_input_reasons.pixel_aspect_ratio
string

The video pixel aspect ratio of the input file.

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

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

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

data.non_standard_input_reasons.unsupported_pixel_format
string

The video pixel format, as a string, returned by libav. Considered non-standard if not one of yuv420p or yuvj420p.

data.non_standard_input_reasons.unexpected_video_parameters
string
data.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.

data.ingest_type
string
Possible values: "on_demand_url""on_demand_direct_upload""on_demand_clip""live_rtmp""live_srt"

The type of ingest used to create the asset.

attempts
array

Attempts for sending out the webhook event

attempts[].webhook_id
integer

Unique identifier for the webhook

attempts[].response_status_code
integer

HTTP response status code for the webhook attempt

attempts[].response_headers
object

HTTP response headers for the webhook attempt

attempts[].response_body
stringnull

HTTP response body for the webhook attempt

attempts[].max_attempts
integer

Max attempts number for the webhook attempt

attempts[].id
string

Unique identifier for the webhook attempt

attempts[].created_at
string

Time the webhook request was attempted

attempts[].address
string

URL address for the webhook attempt

request_idDeprecated
stringnull
accessorDeprecated
stringnull
accessor_sourceDeprecated
stringnull

Static renditions for this asset have been deleted. The static renditions (mp4 files) for this asset will no longer be available.

NameTypeDescription
type
string

Type for the webhook event

id
string

Unique identifier for the event

created_at
string

Time the event was created

object
object
object.type
string
object.id
string
environment
object
environment.name
string

Name for the environment

environment.id
string

Unique identifier for the environment

data
object
data.id
string

Unique identifier for the Asset. Max 255 characters.

data.created_at
integer
data.status
string
Possible values: "preparing""ready""errored"

The status of the asset.

data.duration
number

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

data.max_stored_resolutionDeprecated
string
Possible values: "Audio only""SD""HD""FHD""UHD"

This field is deprecated. Please use resolution_tier instead. 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.

data.resolution_tier
string
Possible values: "audio-only""720p""1080p""1440p""2160p"

The resolution tier that the asset was ingested at, affecting billing for ingest & storage. This field also represents the highest resolution tier that the content can be delivered at, however the actual resolution may be lower depending on the device, bandwidth, and exact resolution of the uploaded asset.

data.max_resolution_tier
string
Possible values: "1080p""1440p""2160p"

Max resolution tier can be used to control the maximum resolution_tier your asset is encoded, stored, and streamed at. If not set, this defaults to 1080p.

data.encoding_tier
string
Possible values: "smart""baseline"

The encoding tier informs the cost, quality, and available platform features for the asset. By default the smart encoding tier is used. See the guide for more details.

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

data.aspect_ratio
string

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

data.playback_ids
array

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

data.playback_ids[].id
string

Unique identifier for the PlaybackID

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

data.tracks
array

The individual media tracks that make up an asset.

data.tracks[].id
string

Unique identifier for the Track

data.tracks[].type
string
Possible values: "video""audio""text"

The type of track

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

data.tracks[].max_width
integer

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

data.tracks[].max_height
integer

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

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

data.tracks[].max_channels
integer

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

data.tracks[].max_channel_layoutDeprecated
string

Only set for the audio type track.

data.tracks[].text_type
string
Possible values: "subtitles"

This parameter is only set for text type tracks.

data.tracks[].text_source
string
Possible values: "uploaded""embedded""generated_live""generated_live_final""generated_vod"

The source of the text contained in a Track of type text. Valid text_source values are listed below.

  • uploaded: Tracks uploaded to Mux as caption or subtitle files using the Create Asset Track API.
  • embedded: Tracks extracted from an embedded stream of CEA-608 closed captions.
  • generated_vod: Tracks generated by automatic speech recognition on an on-demand asset.
  • generated_live: Tracks generated by automatic speech recognition on a live stream configured with generated_subtitles. If an Asset has both generated_live and generated_live_final tracks that are ready, then only the generated_live_final track will be included during playback.
  • generated_live_final: Tracks generated by automatic speech recognition on a live stream using generated_subtitles. The accuracy, timing, and formatting of these subtitles is improved compared to the corresponding generated_live tracks. However, generated_live_final tracks will not be available in ready status until the live stream ends. If an Asset has both generated_live and generated_live_final tracks that are ready, then only the generated_live_final track will be included during playback.
data.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 and audio track types.

data.tracks[].name
string

The name of the track containing a human-readable description. The HLS manifest will associate a subtitle text or audio track with this value. For example, the value should be "English" for a subtitle text track for the language_code value of en-US. This parameter is only set for text and audio track types.

data.tracks[].closed_captions
boolean

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

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

data.tracks[].status
string
Possible values: "preparing""ready""errored""deleted"

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

data.tracks[].primary
boolean

For an audio track, indicates that this is the primary audio track, ingested from the main input for this asset. The primary audio track cannot be deleted.

data.tracks[].error
object

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

data.tracks[].error.type
string

The type of error that occurred for this asset.

data.tracks[].error.messages
array

Error messages with more details.

data.errors
object

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

data.errors.type
string

The type of error that occurred for this asset.

data.errors.messages
array

Error messages with more details.

data.upload_id
string

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

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

data.passthrough
string

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

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

data.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_access is set to none and when the temporary URL expires.

data.master.status
string
Possible values: "ready""preparing""errored"
data.master.url
string

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

data.master_access
string (default: none)
Possible values: "temporary""none"
data.mp4_support
string (default: none)
Possible values: "standard""none"
data.source_asset_id
string

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

data.normalize_audio
boolean (default: false)

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

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

data.static_renditions.status
string (default: disabled)
Possible values: "ready""preparing""disabled""errored"

Indicates the status of downloadable MP4 versions of this asset.

data.static_renditions.files
array

Array of file objects.

data.static_renditions.files[].name
string
Possible values: "low.mp4""medium.mp4""high.mp4""audio.m4a"
data.static_renditions.files[].ext
string
Possible values: "mp4""m4a"

Extension of the static rendition file

data.static_renditions.files[].height
integer

The height of the static rendition's file in pixels

data.static_renditions.files[].width
integer

The width of the static rendition's file in pixels

data.static_renditions.files[].bitrate
integer

The bitrate in bits per second

data.static_renditions.files[].filesize
integer

The file size in bytes

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

data.recording_times[].started_at
object
data.recording_times[].started_at.nanos
integer
data.recording_times[].started_at.seconds
integer
data.recording_times[].duration
number

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

data.recording_times[].typeBeta
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.

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

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

data.non_standard_input_reasons.audio_codec
string

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

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

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

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

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

data.non_standard_input_reasons.pixel_aspect_ratio
string

The video pixel aspect ratio of the input file.

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

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

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

data.non_standard_input_reasons.unsupported_pixel_format
string

The video pixel format, as a string, returned by libav. Considered non-standard if not one of yuv420p or yuvj420p.

data.non_standard_input_reasons.unexpected_video_parameters
string
data.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.

data.ingest_type
string
Possible values: "on_demand_url""on_demand_direct_upload""on_demand_clip""live_rtmp""live_srt"

The type of ingest used to create the asset.

attempts
array

Attempts for sending out the webhook event

attempts[].webhook_id
integer

Unique identifier for the webhook

attempts[].response_status_code
integer

HTTP response status code for the webhook attempt

attempts[].response_headers
object

HTTP response headers for the webhook attempt

attempts[].response_body
stringnull