# Assets

> Video API reference, generated from the OpenAPI spec.

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

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

HTML version: https://www.mux.com/docs/api-reference/video/assets. Full OpenAPI spec: https://www.mux.com/api-spec.json

Operations on this page:

- Create an asset: `POST /video/v1/assets`
- List assets: `GET /video/v1/assets`
- Retrieve an asset: `GET /video/v1/assets/{ASSET_ID}`
- Delete an asset: `DELETE /video/v1/assets/{ASSET_ID}`
- Update an asset: `PATCH /video/v1/assets/{ASSET_ID}`
- Retrieve asset input info: `GET /video/v1/assets/{ASSET_ID}/input-info`
- Create a playback ID: `POST /video/v1/assets/{ASSET_ID}/playback-ids`
- Retrieve a playback ID: `GET /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID}`
- Delete a playback ID: `DELETE /video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID}`
- Update MP4 support: `PUT /video/v1/assets/{ASSET_ID}/mp4-support`
- Update master access: `PUT /video/v1/assets/{ASSET_ID}/master-access`
- Create a static rendition for an asset: `POST /video/v1/assets/{ASSET_ID}/static-renditions`
- Delete a single static rendition for an asset: `DELETE /video/v1/assets/{ASSET_ID}/static-renditions/{STATIC_RENDITION_ID}`
- Unset the thumbnail time for an asset: `DELETE /video/v1/assets/{ASSET_ID}/thumbnail-time`
- Create an asset track: `POST /video/v1/assets/{ASSET_ID}/tracks`
- Delete an asset track: `DELETE /video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID}`
- Update an asset track: `PATCH /video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID}`
- Generate track subtitles: `POST /video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID}/generate-subtitles`
- Get asset shots: `GET /video/v1/assets/{ASSET_ID}/shots`
- Generate shots: `POST /video/v1/assets/{ASSET_ID}/shots`
- Delete asset shots: `DELETE /video/v1/assets/{ASSET_ID}/shots`

## Create an asset

`POST https://api.mux.com/video/v1/assets`

Create a new Mux Video asset.

Operation ID: `create-asset`. HTML version: https://www.mux.com/docs/api-reference/video/assets/create-asset

### Request body

- `input` (array of object, deprecated): Deprecated. Use `inputs` instead, which accepts an identical type.
- `inputs` (array of object, required): An array of objects that each describe an input file to be used to create the asset. As a shortcut, input can also be a string URL for a file when only one input file is used. See `input[].url` for requirements.
  - `url` (string): The URL of the file that Mux should download and use. * For the main input file, this should be the URL to the muxed file for Mux to download, for example an MP4, MOV, MKV, or TS file. Mux supports most audio/video file formats and codecs, but for fastest processing, you should [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time). * For `audio` tracks, the URL is the location of the audio file for Mux to download, for example an M4A, WAV, or MP3 file. Mux supports most audio file formats and codecs, but for fastest processing, you should [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time). * For `text` tracks, the URL is the location of subtitle/captions file. Mux supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) formats for ingesting Subtitles and Closed Captions. * For Watermarking or Overlay, the URL is the location of the watermark image. The maximum size is 4096x4096. * When creating clips from existing Mux assets, the URL is defined with `mux://assets/{asset_id}` template where `asset_id` is the Asset Identifier for creating the clip from. The url property may be omitted on the first input object when providing asset settings for LiveStream and Upload objects, in order to configure settings related to the primary (live stream or direct upload) input.
  - `overlay_settings` (object): An object that describes how the image file referenced in URL should be placed over the video (i.e. watermarking). Ensure that the URL is active and persists the entire lifespan of the video object.
    - `vertical_align` (string): Where the vertical positioning of the overlay/watermark should begin from. Defaults to `"top"` Possible values: `"top"`, `"middle"`, `"bottom"`.
    - `vertical_margin` (string): The distance from the vertical_align starting point and the image's closest edge. Can be expressed as a percent ("10%") or as a pixel value ("100px"). Negative values will move the overlay offscreen. In the case of 'middle', a positive value will shift the overlay towards the bottom and and a negative value will shift it towards the top.
    - `horizontal_align` (string): Where the horizontal positioning of the overlay/watermark should begin from. Possible values: `"left"`, `"center"`, `"right"`.
    - `horizontal_margin` (string): The distance from the horizontal_align starting point and the image's closest edge. Can be expressed as a percent ("10%") or as a pixel value ("100px"). Negative values will move the overlay offscreen. In the case of 'center', a positive value will shift the image towards the right and and a negative value will shift it towards the left.
    - `width` (string): How wide the overlay should appear. Can be expressed as a percent ("10%") or as a pixel value ("100px"). If both width and height are left blank the width will be the true pixels of the image, applied as if the video has been scaled to fit a 1920x1080 frame. If height is supplied with no width, the width will scale proportionally to the height.
    - `height` (string): How tall the overlay should appear. Can be expressed as a percent ("10%") or as a pixel value ("100px"). If both width and height are left blank the height will be the true pixels of the image, applied as if the video has been scaled to fit a 1920x1080 frame. If width is supplied with no height, the height will scale proportionally to the width.
    - `opacity` (string): How opaque the overlay should appear, expressed as a percent. (Default 100%)
  - `generated_subtitles` (array of object): Generate subtitle tracks using automatic speech recognition with this configuration. Subtitles are generated using the audio of the input they are nested within. For direct uploads, this first input should omit the url parameter, as the main input file is provided via the direct upload. Note that subtitle generation happens after initial ingest, so the generated tracks will be in the `preparing` state when the asset transitions to `ready`.
    - `name` (string): A name for this subtitle track.
    - `passthrough` (string): Arbitrary metadata set for the subtitle track. Max 255 characters.
    - `language_code` (string, default: "en"): The language of the audio from which subtitles are generated. Selecting a language of "auto" will allow language detection to set the language code automatically. Possible values: `"en"`, `"es"`, `"it"`, `"pt"`, `"de"`, `"fr"`, `"pl"`, `"ru"`, `"nl"`, `"ca"`, `"tr"`, `"sv"`, `"uk"`, `"no"`, `"fi"`, `"sk"`, `"el"`, `"cs"`, `"hr"`, `"da"`, `"ro"`, `"bg"`, `"auto"`.
  - `start_time` (number, format: double): The time offset in seconds from the beginning of the video indicating the clip's starting marker. The default value is 0 when not included. This parameter is only applicable for creating clips when `input.url` has `mux://assets/{asset_id}` format.
  - `end_time` (number, format: double): The time offset in seconds from the beginning of the video, indicating the clip's ending marker. The default value is the duration of the video when not included. This parameter is only applicable for creating clips when `input.url` has `mux://assets/{asset_id}` format.
  - `type` (string): This parameter is required for `text` type tracks. Possible values: `"video"`, `"audio"`, `"text"`.
  - `text_type` (string): Type of text track. Use `subtitles` for subtitles and closed captions, or `chapters` for a chapters track. For more information on Subtitles / Closed Captions, [see this blog post](https://mux.com/blog/subtitles-captions-webvtt-hls-and-those-magic-flags/). This parameter is required for `text` type tracks. Possible values: `"subtitles"`, `"chapters"`.
  - `language_code` (string): The language code value must be a valid [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For example, `en` for English or `en-US` for the US version of English. This parameter is required for `text` and `audio` track types.
  - `name` (string): The name of the track containing a human-readable description. This value must be unique within each group of `text` or `audio` track types. The HLS manifest will associate a subtitle text track with this value. For example, the value should be "English" for a subtitle text track with `language_code` set to `en`. This optional parameter should be used only for `text` and `audio` type tracks. This parameter can be optionally provided for the first video input to denote the name of the muxed audio track if present. If this parameter is not included, Mux will auto-populate based on the `input[].language_code` value.
  - `closed_captions` (boolean): Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This optional parameter should be used for tracks with `type` of `text` and `text_type` set to `subtitles`.
  - `passthrough` (string): This optional parameter should be used for tracks with `type` of `text` and `text_type` set to `subtitles`.
- `playback_policy` (array of string, deprecated): Deprecated. Use `playback_policies` instead, which accepts an identical type. Possible values: `"public"`, `"signed"`, `"drm"`.
- `playback_policies` (array of string): An array of playback policy names that you want applied to this asset and available through `playback_ids`. Options include: * `"public"` (anyone with the playback URL can stream the asset). * `"signed"` (an additional access token is required to play the asset). If no `playback_policies` are set, the asset will have no playback IDs and will therefore not be playable. For simplicity, a single string name can be used in place of the array in the case of only one playback policy. Possible values: `"public"`, `"signed"`, `"drm"`.
- `advanced_playback_policies` (array of object): An array of playback policy objects that you want applied to this asset and available through `playback_ids`. `advanced_playback_policies` must be used instead of `playback_policies` when creating a DRM playback ID.
  - `policy` (string): * `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](https://docs.mux.com/guides/secure-video-playback) for details about creating tokens. * `drm` playback IDs are protected with DRM technologies. [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm). Possible values: `"public"`, `"signed"`, `"drm"`.
  - `drm_configuration_id` (string): The DRM configuration used by this playback ID. Must only be set when `policy` is set to `drm`.
- `passthrough` (string): You can set this field to anything you want. It will be included in the asset details and related webhooks. If you're looking for more structured metadata, such as `title` or `external_id`, you can use the `meta` object instead. **Max: 255 characters**.
- `mp4_support` (string, deprecated): Deprecated. See the [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions) for the updated API. Specify what level of support for mp4 playback. You may not enable both `mp4_support` and `static_renditions`. * The `capped-1080p` option produces a single MP4 file, called `capped-1080p.mp4`, with the video resolution capped at 1080p. This option produces an `audio.m4a` file for an audio-only asset. * The `audio-only` option produces a single M4A file, called `audio.m4a` for a video or an audio-only asset. MP4 generation will error when this option is specified for a video-only asset. * The `audio-only,capped-1080p` option produces both the `audio.m4a` and `capped-1080p.mp4` files. Only the `capped-1080p.mp4` file is produced for a video-only asset, while only the `audio.m4a` file is produced for an audio-only asset. The `standard`(deprecated) option produces up to three MP4 files with different levels of resolution (`high.mp4`, `medium.mp4`, `low.mp4`, or `audio.m4a` for an audio-only asset). MP4 files are not produced for `none` (default). In most cases you should use our default HLS-based streaming playback (`{playback_id}.m3u8`) which can automatically adjust to viewers' connection speeds, but an mp4 can be useful for some legacy devices or downloading for offline playback. See the [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions) for more information. Possible values: `"none"`, `"standard"` (deprecated), `"capped-1080p"`, `"audio-only"`, `"audio-only,capped-1080p"`.
- `normalize_audio` (boolean, format: boolean, default: false): Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets.
- `master_access` (string): Specify what level (if any) of support for master access. Master access can be enabled temporarily for your asset to be downloaded. See the [Download your videos guide](https://docs.mux.com/guides/enable-static-mp4-renditions) for more information. Possible values: `"none"`, `"temporary"`.
- `test` (boolean, format: boolean): Marks the asset as a test asset when the value is set to true. A Test asset can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test assets created. Test asset are watermarked with the Mux logo, limited to 10 seconds, deleted after 24 hrs.
- `max_resolution_tier` (string): 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`. Possible values: `"1080p"`, `"1440p"`, `"2160p"`.
- `encoding_tier` (string, deprecated): This field is deprecated. Please use `video_quality` instead. The encoding tier informs the cost, quality, and available platform features for the asset. The default encoding tier for an account can be set in the Mux Dashboard. [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels) Possible values: `"smart"`, `"baseline"`, `"premium"`.
- `video_quality` (string): The video quality controls the cost, quality, and available platform features for the asset. The default video quality for an account can be set in the Mux Dashboard. This field replaces the deprecated `encoding_tier` value. [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels) Possible values: `"basic"`, `"plus"`, `"premium"`.
- `static_renditions` (array of object): An array of static renditions to create for this asset. You may not enable both `static_renditions` and the deprecated `mp4_support`.
  - `resolution` (string, required) Possible values: `"highest"`, `"audio-only"`, `"2160p"`, `"1440p"`, `"1080p"`, `"720p"`, `"540p"`, `"480p"`, `"360p"`, `"270p"`.
  - `passthrough` (string): Arbitrary user-supplied metadata set for the static rendition. Max 255 characters.
- `meta` (object): Customer provided metadata about this asset. Note: This metadata may be publicly available via the video player. Do not include PII or sensitive information.
  - `title` (string, maxLength: 512): The asset title. Max 512 code points.
  - `creator_id` (string, maxLength: 128): This is an identifier you provide to keep track of the creator of the asset. Max 128 code points.
  - `external_id` (string, maxLength: 128): This is an identifier you provide to link the asset to your own data. Max 128 code points.
- `copy_overlays` (boolean, default: true): If the created asset is a clip, this controls whether overlays are copied from the source asset.
- `directives` (array of object): An array of Mux Robots directives to apply to the asset.
  - `id` (string, required): The Mux Robots directive identifier.
- `generate_shots` (boolean, default: false): Whether to perform shot detection on this asset. Shots are only generated for video assets and will not be generated for audio-only assets.

Example request body:

```json
{
  "inputs": [
    {
      "url": "https://muxed.s3.amazonaws.com/leds.mp4"
    }
  ],
  "playback_policies": [
    "public"
  ],
  "video_quality": "basic"
}
```

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

### Response `201`

Asset Created

- `data` (object, required)
  - `id` (string, required): Unique identifier for the Asset. Max 255 characters.
  - `created_at` (string, required, format: int64): Time the Asset was created, defined as a Unix timestamp (seconds since epoch).
  - `status` (string, required): The status of the asset. Possible values: `"preparing"`, `"ready"`, `"errored"`.
  - `duration` (number, format: double): The duration of the asset in seconds (max duration for a single asset is 12 hours).
  - `max_stored_resolution` (string, deprecated): 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. Possible values: `"Audio only"`, `"SD"`, `"HD"`, `"FHD"`, `"UHD"`.
  - `resolution_tier` (string): 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. Possible values: `"audio-only"`, `"720p"`, `"1080p"`, `"1440p"`, `"2160p"`.
  - `max_resolution_tier` (string, required): 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`. Possible values: `"1080p"`, `"1440p"`, `"2160p"`.
  - `encoding_tier` (string, required, deprecated): This field is deprecated. Please use `video_quality` instead. The encoding tier informs the cost, quality, and available platform features for the asset. The default encoding tier for an account can be set in the Mux Dashboard. [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels) Possible values: `"smart"`, `"baseline"`, `"premium"`.
  - `video_quality` (string): The video quality controls the cost, quality, and available platform features for the asset. The default video quality for an account can be set in the Mux Dashboard. This field replaces the deprecated `encoding_tier` value. [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels) Possible values: `"basic"`, `"plus"`, `"premium"`.
  - `max_stored_frame_rate` (number, format: double): The maximum frame rate that has been stored for the asset. The asset may be delivered at lower frame rates depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. This field may return -1 if the frame rate of the input cannot be reliably determined.
  - `aspect_ratio` (string): The aspect ratio of the asset in the form of `width:height`, for example `16:9`.
  - `playback_ids` (array of object): An array of Playback ID objects. Use these to create HLS playback URLs. See [Play your videos](https://docs.mux.com/guides/play-your-videos) for more details.
    - `id` (string, required): Unique identifier for the PlaybackID
    - `policy` (string, required): * `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](https://docs.mux.com/guides/secure-video-playback) for details about creating tokens. * `drm` playback IDs are protected with DRM technologies. [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm). Possible values: `"public"`, `"signed"`, `"drm"`.
    - `drm_configuration_id` (string): The DRM configuration used by this playback ID. Must only be set when `policy` is set to `drm`.
  - `tracks` (array of object): The individual media tracks that make up an asset.
    - `id` (string): Unique identifier for the Track
    - `type` (string): The type of track Possible values: `"video"`, `"audio"`, `"text"`.
    - `duration` (number, format: double): 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.
    - `max_width` (integer, format: int64): The maximum width in pixels available for the track. Only set for the `video` type track.
    - `max_height` (integer, format: int64): The maximum height in pixels available for the track. Only set for the `video` type track.
    - `max_frame_rate` (number, format: double): 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.
    - `max_channels` (integer, format: int64): The maximum number of audio channels the track supports. Only set for the `audio` type track.
    - `text_type` (string): This parameter is only set for `text` type tracks. Possible values: `"subtitles"`, `"chapters"`.
    - `text_source` (string): 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. Possible values: `"uploaded"`, `"embedded"`, `"generated_live"`, `"generated_live_final"`, `"generated_vod"`.
    - `language_code` (string): The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value, or 'auto'. 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. During automatic language detection for generated subtitles, this value will be set to `auto` until the language is determined.
    - `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.
    - `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`.
    - `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.
    - `status` (string): The status of the track. `skipped` means the track was not created because the asset doesn't support it, for example generated subtitles on an asset with no audio. Possible values: `"preparing"`, `"ready"`, `"errored"`, `"deleted"`, `"skipped"`.
    - `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.
    - `auto_language_confidence` (number, format: double): The confidence value (0-1) of the determined language. This value only is available when automatic language detection is utilized in generated subtitles.
  - `errors` (object): Object that describes any errors that happened when processing this asset.
    - `type` (string): The type of error that occurred for this asset.
    - `messages` (array of string): Error messages with more details.
  - `upload_id` (string): Unique identifier for the Direct Upload. This is an optional parameter added when the asset is created from a direct upload.
  - `is_live` (boolean, format: boolean): Indicates whether the live stream that created this asset is currently `active` and not in `idle` state. This is an optional parameter added when the asset is created from a live stream.
  - `passthrough` (string): You can set this field to anything you want. It will be included in the asset details and related webhooks. If you're looking for more structured metadata, such as `title` or `external_id` , you can use the `meta` object instead. **Max: 255 characters**.
  - `live_stream_id` (string): Unique identifier for the live stream. This is an optional parameter added when the asset is created from a live stream.
  - `master` (object): An object containing the current status of Master Access and the link to the Master MP4 file when ready. This object does not exist if `master_access` is set to `none` and when the temporary URL expires.
    - `status` (string) Possible values: `"ready"`, `"preparing"`, `"errored"`.
    - `url` (string): The temporary URL to the master version of the video, as an MP4 file. This URL will expire after 24 hours.
  - `master_access` (string, required, default: "none") Possible values: `"temporary"`, `"none"`.
  - `mp4_support` (string, default: "none", deprecated): Deprecated. The level of MP4 support requested through the legacy `mp4_support` option, or `none` if it was not used. Renditions created this way appear in the `static_renditions` object alongside renditions created with the [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions); see that object for how the two differ. An asset cannot use both mechanisms at the same time. Possible values: `"standard"` (deprecated), `"none"`, `"capped-1080p"`, `"audio-only"`, `"audio-only,capped-1080p"`.
  - `source_asset_id` (string): Asset Identifier of the video used as the source for creating the clip.
  - `normalize_audio` (boolean, default: false): Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets.
  - `static_renditions` (object): An object containing the current status of any static renditions (MP4s) for this asset. The object does not exist if no static renditions have been requested. See [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions) for more information. This object is populated by both the [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions) and the deprecated `mp4_support` option, and the two report status differently: * Renditions created with the Static Renditions API each carry their own `id`, `status`, `type`, `resolution`, and `resolution_tier` in `files`. Track progress per rendition using `files[].status`. * Renditions created with the deprecated `mp4_support` option share a single aggregate `status` on this object, and their `files` entries do not include the per-rendition fields above.
    - `status` (string, default: "disabled"): Indicates the aggregate status of MP4 renditions created with the deprecated `mp4_support` option. This field is only meaningful when `mp4_support` is enabled on the asset. For renditions created with the Static Renditions API, use the per-rendition `files[].status` field instead. Possible values: `"ready"`, `"preparing"`, `"disabled"`, `"errored"`.
    - `files` (array of object): Array of file objects.
      - `name` (string): Name of the static rendition file Possible values: `"low.mp4"`, `"medium.mp4"`, `"high.mp4"`, `"highest.mp4"`, `"audio.m4a"`, `"capped-1080p.mp4"`, `"2160p.mp4"`, `"1440p.mp4"`, `"1080p.mp4"`, `"720p.mp4"`, `"540p.mp4"`, `"480p.mp4"`, `"360p.mp4"`, `"270p.mp4"`.
      - `ext` (string): Extension of the static rendition file Possible values: `"mp4"`, `"m4a"`.
      - `height` (integer, format: int32): The height of the static rendition's file in pixels
      - `width` (integer, format: int32): The width of the static rendition's file in pixels
      - `bitrate` (integer, format: int64): The bitrate in bits per second
      - `filesize` (string, format: int64): The file size in bytes
      - `type` (string): Indicates the static rendition type of this specific MP4 version of this asset. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option. Possible values: `"standard"`, `"advanced"`.
      - `status` (string): Indicates the status of this specific MP4 version of this asset. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option. For `mp4_support` renditions, see the top-level `static_renditions.status` field on the asset instead. * `ready` indicates the MP4 has been generated and is ready for download * `preparing` indicates the asset has not been ingested or the static rendition is still being generated after an asset is ready * `skipped` indicates the static rendition will not be generated because the requested resolution conflicts with the asset attributes after the asset has been ingested * `errored` indicates the static rendition cannot be generated. For example, an asset could not be ingested Possible values: `"ready"`, `"preparing"`, `"skipped"`, `"errored"`.
      - `resolution_tier` (string): Indicates the resolution tier of this specific MP4 version of this asset. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option. Possible values: `"2160p"`, `"1440p"`, `"1080p"`, `"720p"`, `"audio-only"`.
      - `resolution` (string): Indicates the resolution of this specific MP4 version of this asset. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option. Possible values: `"highest"`, `"audio-only"`.
      - `id` (string): The ID of this static rendition, used in managing this static rendition. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option.
      - `passthrough` (string): Arbitrary user-supplied metadata set for the static rendition. Max 255 characters.
  - `recording_times` (array of object): 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.
    - `started_at` (string, format: date-time): The time at which the recording for the live stream started. The time value is Unix epoch time represented in ISO 8601 format.
    - `duration` (number, format: double): The duration of the live stream recorded. The time value is in seconds.
    - `type` (string): The type of media represented by the recording session, either `content` for normal stream content or `slate` for slate media inserted during stream interruptions. Possible values: `"content"`, `"slate"`.
  - `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](https://docs.mux.com/guides/minimize-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.
    - `video_codec` (string): The video codec used on the input file. For example, the input file encoded with `av1` video codec is non-standard and the value of this parameter is `av1`.
    - `audio_codec` (string): The audio codec used on the input file. Non-AAC audio codecs are non-standard.
    - `video_gop_size` (string): 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. Possible values: `"high"`.
    - `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.
    - `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.
    - `video_bitrate` (string): 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. Possible values: `"high"`.
    - `pixel_aspect_ratio` (string): The video pixel aspect ratio of the input file.
    - `video_edit_list` (string): Video Edit List reason indicates that the input file's video track contains a complex Edit Decision List. Possible values: `"non-standard"`.
    - `audio_edit_list` (string): Audio Edit List reason indicates that the input file's audio track contains a complex Edit Decision List. Possible values: `"non-standard"`.
    - `unexpected_media_file_parameters` (string): A catch-all reason when the input file in created with non-standard encoding parameters. Possible values: `"non-standard"`.
    - `unsupported_pixel_format` (string): The video pixel format, as a string, returned by libav. Considered non-standard if not one of yuv420p or yuvj420p. HEVC inputs additionally permit yuv420p10le.
  - `test` (boolean, format: 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.
  - `ingest_type` (string): The type of ingest used to create the asset. Possible values: `"on_demand_url"`, `"on_demand_direct_upload"`, `"on_demand_clip"`, `"live_rtmp"`, `"live_srt"`.
  - `meta` (object): Customer provided metadata about this asset. Note: This metadata may be publicly available via the video player. Do not include PII or sensitive information.
    - `title` (string, maxLength: 512): The asset title. Max 512 code points.
    - `creator_id` (string, maxLength: 128): This is an identifier you provide to keep track of the creator of the asset. Max 128 code points.
    - `external_id` (string, maxLength: 128): This is an identifier you provide to link the asset to your own data. Max 128 code points.
  - `progress` (object, required): Detailed state information about the asset ingest process.
    - `state` (string, required): The detailed state of the asset ingest process. This field is useful for relaying more granular processing information to end users when a [non-standard input is encountered](https://www.mux.com/docs/guides/minimize-processing-time#non-standard-input). - `ingesting`: Asset is being ingested (initial processing before or after transcoding). While in this state, the `progress` percentage will be 0. - `transcoding`: Asset is undergoing non-standard transcoding. - `completed`: Asset processing is complete (`status` is `ready`). While in this state, the `progress` percentage will be 100. - `live`: Asset is a live stream currently in progress. While in this state, the `progress` percentage will be -1. - `errored`: Asset has encountered an error (`status` is `errored`). While in this state, the `progress` percentage will be -1. Possible values: `"ingesting"`, `"transcoding"`, `"completed"`, `"live"`, `"errored"`.
    - `progress` (number, required, format: double, minimum: -1, maximum: 100): Represents the estimated completion percentage. Returns `0 - 100` when in `ingesting`, `transcoding`, or `completed` state, and `-1` when in `live` or `errored` state.
  - `directives` (array of object): The Mux Robots directives applied to the asset.
    - `id` (string, required): The Mux Robots directive identifier.
  - `generate_shots` (boolean, default: false): Whether to perform shot detection on this asset. Shots are only generated for video assets and will not be generated for audio-only assets.
  - `shots` (object): The results of generating shots on the video
    - `status` (string, required): The status of the shot detection process Possible values: `"pending"`, `"completed"`, `"errored"`, `"skipped"`, `"deleted"`.
    - `created_at` (string, required, format: int64): Time the shot detection process was created, defined as a Unix timestamp (seconds since epoch).
    - `shots_manifest_url` (string): A URL to a JSON manifest describing the shot changes detected in the video along with shot preview images for each shot. This field is only present when `status` is `completed`.
    - `errors` (object): An object describing any errors encountered during the shot detection process. This field is only present when `status` is `errored`.
      - `type` (string): The type of error that occurred
      - `messages` (array of string): A list of error messages describing the errors that occurred in more detail
  - `thumbnail_time` (number, format: float): The media time within the asset used when a thumbnail without an explicit time is requested.

## List assets

`GET https://api.mux.com/video/v1/assets`

List all Mux assets.

Operation ID: `list-assets`. HTML version: https://www.mux.com/docs/api-reference/video/assets/list-assets

### Query parameters

- `limit` (integer, format: int32, default: 25): Number of items to include in the response
- `page` (integer, format: int32, default: 1): Offset by this many pages, of the size of `limit`
- `cursor` (string): This parameter is used to request pages beyond the first. You can find the cursor value in the `next_cursor` field of paginated responses.
- `live_stream_id` (string): Filter response to return all the assets for this live stream only
- `upload_id` (string): Filter response to return an asset created from this direct upload only

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

### Response `200`

OK

- `next_cursor` (string, required, nullable): If there are more pages of data, this field will contain a string that can be used with the `cursor` querystring parameter to fetch the next page of data.
- `data` (array of object, required)
  - `id` (string, required): Unique identifier for the Asset. Max 255 characters.
  - `created_at` (string, required, format: int64): Time the Asset was created, defined as a Unix timestamp (seconds since epoch).
  - `status` (string, required): The status of the asset. Possible values: `"preparing"`, `"ready"`, `"errored"`.
  - `duration` (number, format: double): The duration of the asset in seconds (max duration for a single asset is 12 hours).
  - `max_stored_resolution` (string, deprecated): 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. Possible values: `"Audio only"`, `"SD"`, `"HD"`, `"FHD"`, `"UHD"`.
  - `resolution_tier` (string): 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. Possible values: `"audio-only"`, `"720p"`, `"1080p"`, `"1440p"`, `"2160p"`.
  - `max_resolution_tier` (string, required): 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`. Possible values: `"1080p"`, `"1440p"`, `"2160p"`.
  - `encoding_tier` (string, required, deprecated): This field is deprecated. Please use `video_quality` instead. The encoding tier informs the cost, quality, and available platform features for the asset. The default encoding tier for an account can be set in the Mux Dashboard. [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels) Possible values: `"smart"`, `"baseline"`, `"premium"`.
  - `video_quality` (string): The video quality controls the cost, quality, and available platform features for the asset. The default video quality for an account can be set in the Mux Dashboard. This field replaces the deprecated `encoding_tier` value. [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels) Possible values: `"basic"`, `"plus"`, `"premium"`.
  - `max_stored_frame_rate` (number, format: double): The maximum frame rate that has been stored for the asset. The asset may be delivered at lower frame rates depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. This field may return -1 if the frame rate of the input cannot be reliably determined.
  - `aspect_ratio` (string): The aspect ratio of the asset in the form of `width:height`, for example `16:9`.
  - `playback_ids` (array of object): An array of Playback ID objects. Use these to create HLS playback URLs. See [Play your videos](https://docs.mux.com/guides/play-your-videos) for more details.
    - `id` (string, required): Unique identifier for the PlaybackID
    - `policy` (string, required): * `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](https://docs.mux.com/guides/secure-video-playback) for details about creating tokens. * `drm` playback IDs are protected with DRM technologies. [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm). Possible values: `"public"`, `"signed"`, `"drm"`.
    - `drm_configuration_id` (string): The DRM configuration used by this playback ID. Must only be set when `policy` is set to `drm`.
  - `tracks` (array of object): The individual media tracks that make up an asset.
    - `id` (string): Unique identifier for the Track
    - `type` (string): The type of track Possible values: `"video"`, `"audio"`, `"text"`.
    - `duration` (number, format: double): 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.
    - `max_width` (integer, format: int64): The maximum width in pixels available for the track. Only set for the `video` type track.
    - `max_height` (integer, format: int64): The maximum height in pixels available for the track. Only set for the `video` type track.
    - `max_frame_rate` (number, format: double): 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.
    - `max_channels` (integer, format: int64): The maximum number of audio channels the track supports. Only set for the `audio` type track.
    - `text_type` (string): This parameter is only set for `text` type tracks. Possible values: `"subtitles"`, `"chapters"`.
    - `text_source` (string): 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. Possible values: `"uploaded"`, `"embedded"`, `"generated_live"`, `"generated_live_final"`, `"generated_vod"`.
    - `language_code` (string): The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value, or 'auto'. 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. During automatic language detection for generated subtitles, this value will be set to `auto` until the language is determined.
    - `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.
    - `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`.
    - `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.
    - `status` (string): The status of the track. `skipped` means the track was not created because the asset doesn't support it, for example generated subtitles on an asset with no audio. Possible values: `"preparing"`, `"ready"`, `"errored"`, `"deleted"`, `"skipped"`.
    - `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.
    - `auto_language_confidence` (number, format: double): The confidence value (0-1) of the determined language. This value only is available when automatic language detection is utilized in generated subtitles.
  - `errors` (object): Object that describes any errors that happened when processing this asset.
    - `type` (string): The type of error that occurred for this asset.
    - `messages` (array of string): Error messages with more details.
  - `upload_id` (string): Unique identifier for the Direct Upload. This is an optional parameter added when the asset is created from a direct upload.
  - `is_live` (boolean, format: boolean): Indicates whether the live stream that created this asset is currently `active` and not in `idle` state. This is an optional parameter added when the asset is created from a live stream.
  - `passthrough` (string): You can set this field to anything you want. It will be included in the asset details and related webhooks. If you're looking for more structured metadata, such as `title` or `external_id` , you can use the `meta` object instead. **Max: 255 characters**.
  - `live_stream_id` (string): Unique identifier for the live stream. This is an optional parameter added when the asset is created from a live stream.
  - `master` (object): An object containing the current status of Master Access and the link to the Master MP4 file when ready. This object does not exist if `master_access` is set to `none` and when the temporary URL expires.
    - `status` (string) Possible values: `"ready"`, `"preparing"`, `"errored"`.
    - `url` (string): The temporary URL to the master version of the video, as an MP4 file. This URL will expire after 24 hours.
  - `master_access` (string, required, default: "none") Possible values: `"temporary"`, `"none"`.
  - `mp4_support` (string, default: "none", deprecated): Deprecated. The level of MP4 support requested through the legacy `mp4_support` option, or `none` if it was not used. Renditions created this way appear in the `static_renditions` object alongside renditions created with the [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions); see that object for how the two differ. An asset cannot use both mechanisms at the same time. Possible values: `"standard"` (deprecated), `"none"`, `"capped-1080p"`, `"audio-only"`, `"audio-only,capped-1080p"`.
  - `source_asset_id` (string): Asset Identifier of the video used as the source for creating the clip.
  - `normalize_audio` (boolean, default: false): Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets.
  - `static_renditions` (object): An object containing the current status of any static renditions (MP4s) for this asset. The object does not exist if no static renditions have been requested. See [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions) for more information. This object is populated by both the [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions) and the deprecated `mp4_support` option, and the two report status differently: * Renditions created with the Static Renditions API each carry their own `id`, `status`, `type`, `resolution`, and `resolution_tier` in `files`. Track progress per rendition using `files[].status`. * Renditions created with the deprecated `mp4_support` option share a single aggregate `status` on this object, and their `files` entries do not include the per-rendition fields above.
    - `status` (string, default: "disabled"): Indicates the aggregate status of MP4 renditions created with the deprecated `mp4_support` option. This field is only meaningful when `mp4_support` is enabled on the asset. For renditions created with the Static Renditions API, use the per-rendition `files[].status` field instead. Possible values: `"ready"`, `"preparing"`, `"disabled"`, `"errored"`.
    - `files` (array of object): Array of file objects.
      - `name` (string): Name of the static rendition file Possible values: `"low.mp4"`, `"medium.mp4"`, `"high.mp4"`, `"highest.mp4"`, `"audio.m4a"`, `"capped-1080p.mp4"`, `"2160p.mp4"`, `"1440p.mp4"`, `"1080p.mp4"`, `"720p.mp4"`, `"540p.mp4"`, `"480p.mp4"`, `"360p.mp4"`, `"270p.mp4"`.
      - `ext` (string): Extension of the static rendition file Possible values: `"mp4"`, `"m4a"`.
      - `height` (integer, format: int32): The height of the static rendition's file in pixels
      - `width` (integer, format: int32): The width of the static rendition's file in pixels
      - `bitrate` (integer, format: int64): The bitrate in bits per second
      - `filesize` (string, format: int64): The file size in bytes
      - `type` (string): Indicates the static rendition type of this specific MP4 version of this asset. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option. Possible values: `"standard"`, `"advanced"`.
      - `status` (string): Indicates the status of this specific MP4 version of this asset. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option. For `mp4_support` renditions, see the top-level `static_renditions.status` field on the asset instead. * `ready` indicates the MP4 has been generated and is ready for download * `preparing` indicates the asset has not been ingested or the static rendition is still being generated after an asset is ready * `skipped` indicates the static rendition will not be generated because the requested resolution conflicts with the asset attributes after the asset has been ingested * `errored` indicates the static rendition cannot be generated. For example, an asset could not be ingested Possible values: `"ready"`, `"preparing"`, `"skipped"`, `"errored"`.
      - `resolution_tier` (string): Indicates the resolution tier of this specific MP4 version of this asset. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option. Possible values: `"2160p"`, `"1440p"`, `"1080p"`, `"720p"`, `"audio-only"`.
      - `resolution` (string): Indicates the resolution of this specific MP4 version of this asset. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option. Possible values: `"highest"`, `"audio-only"`.
      - `id` (string): The ID of this static rendition, used in managing this static rendition. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option.
      - `passthrough` (string): Arbitrary user-supplied metadata set for the static rendition. Max 255 characters.
  - `recording_times` (array of object): 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.
    - `started_at` (string, format: date-time): The time at which the recording for the live stream started. The time value is Unix epoch time represented in ISO 8601 format.
    - `duration` (number, format: double): The duration of the live stream recorded. The time value is in seconds.
    - `type` (string): The type of media represented by the recording session, either `content` for normal stream content or `slate` for slate media inserted during stream interruptions. Possible values: `"content"`, `"slate"`.
  - `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](https://docs.mux.com/guides/minimize-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.
    - `video_codec` (string): The video codec used on the input file. For example, the input file encoded with `av1` video codec is non-standard and the value of this parameter is `av1`.
    - `audio_codec` (string): The audio codec used on the input file. Non-AAC audio codecs are non-standard.
    - `video_gop_size` (string): 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. Possible values: `"high"`.
    - `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.
    - `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.
    - `video_bitrate` (string): 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. Possible values: `"high"`.
    - `pixel_aspect_ratio` (string): The video pixel aspect ratio of the input file.
    - `video_edit_list` (string): Video Edit List reason indicates that the input file's video track contains a complex Edit Decision List. Possible values: `"non-standard"`.
    - `audio_edit_list` (string): Audio Edit List reason indicates that the input file's audio track contains a complex Edit Decision List. Possible values: `"non-standard"`.
    - `unexpected_media_file_parameters` (string): A catch-all reason when the input file in created with non-standard encoding parameters. Possible values: `"non-standard"`.
    - `unsupported_pixel_format` (string): The video pixel format, as a string, returned by libav. Considered non-standard if not one of yuv420p or yuvj420p. HEVC inputs additionally permit yuv420p10le.
  - `test` (boolean, format: 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.
  - `ingest_type` (string): The type of ingest used to create the asset. Possible values: `"on_demand_url"`, `"on_demand_direct_upload"`, `"on_demand_clip"`, `"live_rtmp"`, `"live_srt"`.
  - `meta` (object): Customer provided metadata about this asset. Note: This metadata may be publicly available via the video player. Do not include PII or sensitive information.
    - `title` (string, maxLength: 512): The asset title. Max 512 code points.
    - `creator_id` (string, maxLength: 128): This is an identifier you provide to keep track of the creator of the asset. Max 128 code points.
    - `external_id` (string, maxLength: 128): This is an identifier you provide to link the asset to your own data. Max 128 code points.
  - `progress` (object, required): Detailed state information about the asset ingest process.
    - `state` (string, required): The detailed state of the asset ingest process. This field is useful for relaying more granular processing information to end users when a [non-standard input is encountered](https://www.mux.com/docs/guides/minimize-processing-time#non-standard-input). - `ingesting`: Asset is being ingested (initial processing before or after transcoding). While in this state, the `progress` percentage will be 0. - `transcoding`: Asset is undergoing non-standard transcoding. - `completed`: Asset processing is complete (`status` is `ready`). While in this state, the `progress` percentage will be 100. - `live`: Asset is a live stream currently in progress. While in this state, the `progress` percentage will be -1. - `errored`: Asset has encountered an error (`status` is `errored`). While in this state, the `progress` percentage will be -1. Possible values: `"ingesting"`, `"transcoding"`, `"completed"`, `"live"`, `"errored"`.
    - `progress` (number, required, format: double, minimum: -1, maximum: 100): Represents the estimated completion percentage. Returns `0 - 100` when in `ingesting`, `transcoding`, or `completed` state, and `-1` when in `live` or `errored` state.
  - `directives` (array of object): The Mux Robots directives applied to the asset.
    - `id` (string, required): The Mux Robots directive identifier.
  - `generate_shots` (boolean, default: false): Whether to perform shot detection on this asset. Shots are only generated for video assets and will not be generated for audio-only assets.
  - `shots` (object): The results of generating shots on the video
    - `status` (string, required): The status of the shot detection process Possible values: `"pending"`, `"completed"`, `"errored"`, `"skipped"`, `"deleted"`.
    - `created_at` (string, required, format: int64): Time the shot detection process was created, defined as a Unix timestamp (seconds since epoch).
    - `shots_manifest_url` (string): A URL to a JSON manifest describing the shot changes detected in the video along with shot preview images for each shot. This field is only present when `status` is `completed`.
    - `errors` (object): An object describing any errors encountered during the shot detection process. This field is only present when `status` is `errored`.
      - `type` (string): The type of error that occurred
      - `messages` (array of string): A list of error messages describing the errors that occurred in more detail
  - `thumbnail_time` (number, format: float): The media time within the asset used when a thumbnail without an explicit time is requested.

## Retrieve an asset

`GET https://api.mux.com/video/v1/assets/{ASSET_ID}`

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

Operation ID: `get-asset`. HTML version: https://www.mux.com/docs/api-reference/video/assets/get-asset

### Path parameters

- `ASSET_ID` (string, required): The asset ID.

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

### Response `200`

OK

- `data` (object, required)
  - `id` (string, required): Unique identifier for the Asset. Max 255 characters.
  - `created_at` (string, required, format: int64): Time the Asset was created, defined as a Unix timestamp (seconds since epoch).
  - `status` (string, required): The status of the asset. Possible values: `"preparing"`, `"ready"`, `"errored"`.
  - `duration` (number, format: double): The duration of the asset in seconds (max duration for a single asset is 12 hours).
  - `max_stored_resolution` (string, deprecated): 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. Possible values: `"Audio only"`, `"SD"`, `"HD"`, `"FHD"`, `"UHD"`.
  - `resolution_tier` (string): 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. Possible values: `"audio-only"`, `"720p"`, `"1080p"`, `"1440p"`, `"2160p"`.
  - `max_resolution_tier` (string, required): 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`. Possible values: `"1080p"`, `"1440p"`, `"2160p"`.
  - `encoding_tier` (string, required, deprecated): This field is deprecated. Please use `video_quality` instead. The encoding tier informs the cost, quality, and available platform features for the asset. The default encoding tier for an account can be set in the Mux Dashboard. [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels) Possible values: `"smart"`, `"baseline"`, `"premium"`.
  - `video_quality` (string): The video quality controls the cost, quality, and available platform features for the asset. The default video quality for an account can be set in the Mux Dashboard. This field replaces the deprecated `encoding_tier` value. [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels) Possible values: `"basic"`, `"plus"`, `"premium"`.
  - `max_stored_frame_rate` (number, format: double): The maximum frame rate that has been stored for the asset. The asset may be delivered at lower frame rates depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. This field may return -1 if the frame rate of the input cannot be reliably determined.
  - `aspect_ratio` (string): The aspect ratio of the asset in the form of `width:height`, for example `16:9`.
  - `playback_ids` (array of object): An array of Playback ID objects. Use these to create HLS playback URLs. See [Play your videos](https://docs.mux.com/guides/play-your-videos) for more details.
    - `id` (string, required): Unique identifier for the PlaybackID
    - `policy` (string, required): * `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](https://docs.mux.com/guides/secure-video-playback) for details about creating tokens. * `drm` playback IDs are protected with DRM technologies. [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm). Possible values: `"public"`, `"signed"`, `"drm"`.
    - `drm_configuration_id` (string): The DRM configuration used by this playback ID. Must only be set when `policy` is set to `drm`.
  - `tracks` (array of object): The individual media tracks that make up an asset.
    - `id` (string): Unique identifier for the Track
    - `type` (string): The type of track Possible values: `"video"`, `"audio"`, `"text"`.
    - `duration` (number, format: double): 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.
    - `max_width` (integer, format: int64): The maximum width in pixels available for the track. Only set for the `video` type track.
    - `max_height` (integer, format: int64): The maximum height in pixels available for the track. Only set for the `video` type track.
    - `max_frame_rate` (number, format: double): 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.
    - `max_channels` (integer, format: int64): The maximum number of audio channels the track supports. Only set for the `audio` type track.
    - `text_type` (string): This parameter is only set for `text` type tracks. Possible values: `"subtitles"`, `"chapters"`.
    - `text_source` (string): 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. Possible values: `"uploaded"`, `"embedded"`, `"generated_live"`, `"generated_live_final"`, `"generated_vod"`.
    - `language_code` (string): The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value, or 'auto'. 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. During automatic language detection for generated subtitles, this value will be set to `auto` until the language is determined.
    - `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.
    - `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`.
    - `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.
    - `status` (string): The status of the track. `skipped` means the track was not created because the asset doesn't support it, for example generated subtitles on an asset with no audio. Possible values: `"preparing"`, `"ready"`, `"errored"`, `"deleted"`, `"skipped"`.
    - `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.
    - `auto_language_confidence` (number, format: double): The confidence value (0-1) of the determined language. This value only is available when automatic language detection is utilized in generated subtitles.
  - `errors` (object): Object that describes any errors that happened when processing this asset.
    - `type` (string): The type of error that occurred for this asset.
    - `messages` (array of string): Error messages with more details.
  - `upload_id` (string): Unique identifier for the Direct Upload. This is an optional parameter added when the asset is created from a direct upload.
  - `is_live` (boolean, format: boolean): Indicates whether the live stream that created this asset is currently `active` and not in `idle` state. This is an optional parameter added when the asset is created from a live stream.
  - `passthrough` (string): You can set this field to anything you want. It will be included in the asset details and related webhooks. If you're looking for more structured metadata, such as `title` or `external_id` , you can use the `meta` object instead. **Max: 255 characters**.
  - `live_stream_id` (string): Unique identifier for the live stream. This is an optional parameter added when the asset is created from a live stream.
  - `master` (object): An object containing the current status of Master Access and the link to the Master MP4 file when ready. This object does not exist if `master_access` is set to `none` and when the temporary URL expires.
    - `status` (string) Possible values: `"ready"`, `"preparing"`, `"errored"`.
    - `url` (string): The temporary URL to the master version of the video, as an MP4 file. This URL will expire after 24 hours.
  - `master_access` (string, required, default: "none") Possible values: `"temporary"`, `"none"`.
  - `mp4_support` (string, default: "none", deprecated): Deprecated. The level of MP4 support requested through the legacy `mp4_support` option, or `none` if it was not used. Renditions created this way appear in the `static_renditions` object alongside renditions created with the [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions); see that object for how the two differ. An asset cannot use both mechanisms at the same time. Possible values: `"standard"` (deprecated), `"none"`, `"capped-1080p"`, `"audio-only"`, `"audio-only,capped-1080p"`.
  - `source_asset_id` (string): Asset Identifier of the video used as the source for creating the clip.
  - `normalize_audio` (boolean, default: false): Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets.
  - `static_renditions` (object): An object containing the current status of any static renditions (MP4s) for this asset. The object does not exist if no static renditions have been requested. See [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions) for more information. This object is populated by both the [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions) and the deprecated `mp4_support` option, and the two report status differently: * Renditions created with the Static Renditions API each carry their own `id`, `status`, `type`, `resolution`, and `resolution_tier` in `files`. Track progress per rendition using `files[].status`. * Renditions created with the deprecated `mp4_support` option share a single aggregate `status` on this object, and their `files` entries do not include the per-rendition fields above.
    - `status` (string, default: "disabled"): Indicates the aggregate status of MP4 renditions created with the deprecated `mp4_support` option. This field is only meaningful when `mp4_support` is enabled on the asset. For renditions created with the Static Renditions API, use the per-rendition `files[].status` field instead. Possible values: `"ready"`, `"preparing"`, `"disabled"`, `"errored"`.
    - `files` (array of object): Array of file objects.
      - `name` (string): Name of the static rendition file Possible values: `"low.mp4"`, `"medium.mp4"`, `"high.mp4"`, `"highest.mp4"`, `"audio.m4a"`, `"capped-1080p.mp4"`, `"2160p.mp4"`, `"1440p.mp4"`, `"1080p.mp4"`, `"720p.mp4"`, `"540p.mp4"`, `"480p.mp4"`, `"360p.mp4"`, `"270p.mp4"`.
      - `ext` (string): Extension of the static rendition file Possible values: `"mp4"`, `"m4a"`.
      - `height` (integer, format: int32): The height of the static rendition's file in pixels
      - `width` (integer, format: int32): The width of the static rendition's file in pixels
      - `bitrate` (integer, format: int64): The bitrate in bits per second
      - `filesize` (string, format: int64): The file size in bytes
      - `type` (string): Indicates the static rendition type of this specific MP4 version of this asset. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option. Possible values: `"standard"`, `"advanced"`.
      - `status` (string): Indicates the status of this specific MP4 version of this asset. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option. For `mp4_support` renditions, see the top-level `static_renditions.status` field on the asset instead. * `ready` indicates the MP4 has been generated and is ready for download * `preparing` indicates the asset has not been ingested or the static rendition is still being generated after an asset is ready * `skipped` indicates the static rendition will not be generated because the requested resolution conflicts with the asset attributes after the asset has been ingested * `errored` indicates the static rendition cannot be generated. For example, an asset could not be ingested Possible values: `"ready"`, `"preparing"`, `"skipped"`, `"errored"`.
      - `resolution_tier` (string): Indicates the resolution tier of this specific MP4 version of this asset. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option. Possible values: `"2160p"`, `"1440p"`, `"1080p"`, `"720p"`, `"audio-only"`.
      - `resolution` (string): Indicates the resolution of this specific MP4 version of this asset. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option. Possible values: `"highest"`, `"audio-only"`.
      - `id` (string): The ID of this static rendition, used in managing this static rendition. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option.
      - `passthrough` (string): Arbitrary user-supplied metadata set for the static rendition. Max 255 characters.
  - `recording_times` (array of object): 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.
    - `started_at` (string, format: date-time): The time at which the recording for the live stream started. The time value is Unix epoch time represented in ISO 8601 format.
    - `duration` (number, format: double): The duration of the live stream recorded. The time value is in seconds.
    - `type` (string): The type of media represented by the recording session, either `content` for normal stream content or `slate` for slate media inserted during stream interruptions. Possible values: `"content"`, `"slate"`.
  - `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](https://docs.mux.com/guides/minimize-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.
    - `video_codec` (string): The video codec used on the input file. For example, the input file encoded with `av1` video codec is non-standard and the value of this parameter is `av1`.
    - `audio_codec` (string): The audio codec used on the input file. Non-AAC audio codecs are non-standard.
    - `video_gop_size` (string): 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. Possible values: `"high"`.
    - `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.
    - `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.
    - `video_bitrate` (string): 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. Possible values: `"high"`.
    - `pixel_aspect_ratio` (string): The video pixel aspect ratio of the input file.
    - `video_edit_list` (string): Video Edit List reason indicates that the input file's video track contains a complex Edit Decision List. Possible values: `"non-standard"`.
    - `audio_edit_list` (string): Audio Edit List reason indicates that the input file's audio track contains a complex Edit Decision List. Possible values: `"non-standard"`.
    - `unexpected_media_file_parameters` (string): A catch-all reason when the input file in created with non-standard encoding parameters. Possible values: `"non-standard"`.
    - `unsupported_pixel_format` (string): The video pixel format, as a string, returned by libav. Considered non-standard if not one of yuv420p or yuvj420p. HEVC inputs additionally permit yuv420p10le.
  - `test` (boolean, format: 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.
  - `ingest_type` (string): The type of ingest used to create the asset. Possible values: `"on_demand_url"`, `"on_demand_direct_upload"`, `"on_demand_clip"`, `"live_rtmp"`, `"live_srt"`.
  - `meta` (object): Customer provided metadata about this asset. Note: This metadata may be publicly available via the video player. Do not include PII or sensitive information.
    - `title` (string, maxLength: 512): The asset title. Max 512 code points.
    - `creator_id` (string, maxLength: 128): This is an identifier you provide to keep track of the creator of the asset. Max 128 code points.
    - `external_id` (string, maxLength: 128): This is an identifier you provide to link the asset to your own data. Max 128 code points.
  - `progress` (object, required): Detailed state information about the asset ingest process.
    - `state` (string, required): The detailed state of the asset ingest process. This field is useful for relaying more granular processing information to end users when a [non-standard input is encountered](https://www.mux.com/docs/guides/minimize-processing-time#non-standard-input). - `ingesting`: Asset is being ingested (initial processing before or after transcoding). While in this state, the `progress` percentage will be 0. - `transcoding`: Asset is undergoing non-standard transcoding. - `completed`: Asset processing is complete (`status` is `ready`). While in this state, the `progress` percentage will be 100. - `live`: Asset is a live stream currently in progress. While in this state, the `progress` percentage will be -1. - `errored`: Asset has encountered an error (`status` is `errored`). While in this state, the `progress` percentage will be -1. Possible values: `"ingesting"`, `"transcoding"`, `"completed"`, `"live"`, `"errored"`.
    - `progress` (number, required, format: double, minimum: -1, maximum: 100): Represents the estimated completion percentage. Returns `0 - 100` when in `ingesting`, `transcoding`, or `completed` state, and `-1` when in `live` or `errored` state.
  - `directives` (array of object): The Mux Robots directives applied to the asset.
    - `id` (string, required): The Mux Robots directive identifier.
  - `generate_shots` (boolean, default: false): Whether to perform shot detection on this asset. Shots are only generated for video assets and will not be generated for audio-only assets.
  - `shots` (object): The results of generating shots on the video
    - `status` (string, required): The status of the shot detection process Possible values: `"pending"`, `"completed"`, `"errored"`, `"skipped"`, `"deleted"`.
    - `created_at` (string, required, format: int64): Time the shot detection process was created, defined as a Unix timestamp (seconds since epoch).
    - `shots_manifest_url` (string): A URL to a JSON manifest describing the shot changes detected in the video along with shot preview images for each shot. This field is only present when `status` is `completed`.
    - `errors` (object): An object describing any errors encountered during the shot detection process. This field is only present when `status` is `errored`.
      - `type` (string): The type of error that occurred
      - `messages` (array of string): A list of error messages describing the errors that occurred in more detail
  - `thumbnail_time` (number, format: float): The media time within the asset used when a thumbnail without an explicit time is requested.

## Delete an asset

`DELETE https://api.mux.com/video/v1/assets/{ASSET_ID}`

Deletes a video asset and all its data.

Operation ID: `delete-asset`. HTML version: https://www.mux.com/docs/api-reference/video/assets/delete-asset

### Path parameters

- `ASSET_ID` (string, required): The asset ID.

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

### Response `204`

No Content

## Update an asset

`PATCH https://api.mux.com/video/v1/assets/{ASSET_ID}`

Updates the details of an existing Asset with the provided Asset ID. This API currently only supports the `passthrough`, `meta` and `thumbnail_time` fields.

Operation ID: `update-asset`. HTML version: https://www.mux.com/docs/api-reference/video/assets/update-asset

### Path parameters

- `ASSET_ID` (string, required): The asset ID.

### Request body

- `passthrough` (string): You can set this field to anything you want. It will be included in the asset details and related webhooks. If you're looking for more structured metadata, such as `title` or `external_id` , you can use the `meta` object instead. **Max: 255 characters**. In order to clear this value, the field should be included with an empty string value.
- `meta` (object): Customer provided metadata about this asset. Note: This metadata may be publicly available via the video player. Do not include PII or sensitive information.
  - `title` (string, maxLength: 512): The asset title. Max 512 code points.
  - `creator_id` (string, maxLength: 128): This is an identifier you provide to keep track of the creator of the asset. Max 128 code points.
  - `external_id` (string, maxLength: 128): This is an identifier you provide to link the asset to your own data. Max 128 code points.
- `thumbnail_time` (number, format: float): The media time within the asset used when a thumbnail without an explicit time is requested.

Example request body:

```json
{
  "passthrough": "Example"
}
```

### Response `200`

OK

- `data` (object, required)
  - `id` (string, required): Unique identifier for the Asset. Max 255 characters.
  - `created_at` (string, required, format: int64): Time the Asset was created, defined as a Unix timestamp (seconds since epoch).
  - `status` (string, required): The status of the asset. Possible values: `"preparing"`, `"ready"`, `"errored"`.
  - `duration` (number, format: double): The duration of the asset in seconds (max duration for a single asset is 12 hours).
  - `max_stored_resolution` (string, deprecated): 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. Possible values: `"Audio only"`, `"SD"`, `"HD"`, `"FHD"`, `"UHD"`.
  - `resolution_tier` (string): 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. Possible values: `"audio-only"`, `"720p"`, `"1080p"`, `"1440p"`, `"2160p"`.
  - `max_resolution_tier` (string, required): 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`. Possible values: `"1080p"`, `"1440p"`, `"2160p"`.
  - `encoding_tier` (string, required, deprecated): This field is deprecated. Please use `video_quality` instead. The encoding tier informs the cost, quality, and available platform features for the asset. The default encoding tier for an account can be set in the Mux Dashboard. [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels) Possible values: `"smart"`, `"baseline"`, `"premium"`.
  - `video_quality` (string): The video quality controls the cost, quality, and available platform features for the asset. The default video quality for an account can be set in the Mux Dashboard. This field replaces the deprecated `encoding_tier` value. [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels) Possible values: `"basic"`, `"plus"`, `"premium"`.
  - `max_stored_frame_rate` (number, format: double): The maximum frame rate that has been stored for the asset. The asset may be delivered at lower frame rates depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. This field may return -1 if the frame rate of the input cannot be reliably determined.
  - `aspect_ratio` (string): The aspect ratio of the asset in the form of `width:height`, for example `16:9`.
  - `playback_ids` (array of object): An array of Playback ID objects. Use these to create HLS playback URLs. See [Play your videos](https://docs.mux.com/guides/play-your-videos) for more details.
    - `id` (string, required): Unique identifier for the PlaybackID
    - `policy` (string, required): * `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](https://docs.mux.com/guides/secure-video-playback) for details about creating tokens. * `drm` playback IDs are protected with DRM technologies. [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm). Possible values: `"public"`, `"signed"`, `"drm"`.
    - `drm_configuration_id` (string): The DRM configuration used by this playback ID. Must only be set when `policy` is set to `drm`.
  - `tracks` (array of object): The individual media tracks that make up an asset.
    - `id` (string): Unique identifier for the Track
    - `type` (string): The type of track Possible values: `"video"`, `"audio"`, `"text"`.
    - `duration` (number, format: double): 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.
    - `max_width` (integer, format: int64): The maximum width in pixels available for the track. Only set for the `video` type track.
    - `max_height` (integer, format: int64): The maximum height in pixels available for the track. Only set for the `video` type track.
    - `max_frame_rate` (number, format: double): 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.
    - `max_channels` (integer, format: int64): The maximum number of audio channels the track supports. Only set for the `audio` type track.
    - `text_type` (string): This parameter is only set for `text` type tracks. Possible values: `"subtitles"`, `"chapters"`.
    - `text_source` (string): 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. Possible values: `"uploaded"`, `"embedded"`, `"generated_live"`, `"generated_live_final"`, `"generated_vod"`.
    - `language_code` (string): The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value, or 'auto'. 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. During automatic language detection for generated subtitles, this value will be set to `auto` until the language is determined.
    - `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.
    - `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`.
    - `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.
    - `status` (string): The status of the track. `skipped` means the track was not created because the asset doesn't support it, for example generated subtitles on an asset with no audio. Possible values: `"preparing"`, `"ready"`, `"errored"`, `"deleted"`, `"skipped"`.
    - `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.
    - `auto_language_confidence` (number, format: double): The confidence value (0-1) of the determined language. This value only is available when automatic language detection is utilized in generated subtitles.
  - `errors` (object): Object that describes any errors that happened when processing this asset.
    - `type` (string): The type of error that occurred for this asset.
    - `messages` (array of string): Error messages with more details.
  - `upload_id` (string): Unique identifier for the Direct Upload. This is an optional parameter added when the asset is created from a direct upload.
  - `is_live` (boolean, format: boolean): Indicates whether the live stream that created this asset is currently `active` and not in `idle` state. This is an optional parameter added when the asset is created from a live stream.
  - `passthrough` (string): You can set this field to anything you want. It will be included in the asset details and related webhooks. If you're looking for more structured metadata, such as `title` or `external_id` , you can use the `meta` object instead. **Max: 255 characters**.
  - `live_stream_id` (string): Unique identifier for the live stream. This is an optional parameter added when the asset is created from a live stream.
  - `master` (object): An object containing the current status of Master Access and the link to the Master MP4 file when ready. This object does not exist if `master_access` is set to `none` and when the temporary URL expires.
    - `status` (string) Possible values: `"ready"`, `"preparing"`, `"errored"`.
    - `url` (string): The temporary URL to the master version of the video, as an MP4 file. This URL will expire after 24 hours.
  - `master_access` (string, required, default: "none") Possible values: `"temporary"`, `"none"`.
  - `mp4_support` (string, default: "none", deprecated): Deprecated. The level of MP4 support requested through the legacy `mp4_support` option, or `none` if it was not used. Renditions created this way appear in the `static_renditions` object alongside renditions created with the [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions); see that object for how the two differ. An asset cannot use both mechanisms at the same time. Possible values: `"standard"` (deprecated), `"none"`, `"capped-1080p"`, `"audio-only"`, `"audio-only,capped-1080p"`.
  - `source_asset_id` (string): Asset Identifier of the video used as the source for creating the clip.
  - `normalize_audio` (boolean, default: false): Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets.
  - `static_renditions` (object): An object containing the current status of any static renditions (MP4s) for this asset. The object does not exist if no static renditions have been requested. See [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions) for more information. This object is populated by both the [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions) and the deprecated `mp4_support` option, and the two report status differently: * Renditions created with the Static Renditions API each carry their own `id`, `status`, `type`, `resolution`, and `resolution_tier` in `files`. Track progress per rendition using `files[].status`. * Renditions created with the deprecated `mp4_support` option share a single aggregate `status` on this object, and their `files` entries do not include the per-rendition fields above.
    - `status` (string, default: "disabled"): Indicates the aggregate status of MP4 renditions created with the deprecated `mp4_support` option. This field is only meaningful when `mp4_support` is enabled on the asset. For renditions created with the Static Renditions API, use the per-rendition `files[].status` field instead. Possible values: `"ready"`, `"preparing"`, `"disabled"`, `"errored"`.
    - `files` (array of object): Array of file objects.
      - `name` (string): Name of the static rendition file Possible values: `"low.mp4"`, `"medium.mp4"`, `"high.mp4"`, `"highest.mp4"`, `"audio.m4a"`, `"capped-1080p.mp4"`, `"2160p.mp4"`, `"1440p.mp4"`, `"1080p.mp4"`, `"720p.mp4"`, `"540p.mp4"`, `"480p.mp4"`, `"360p.mp4"`, `"270p.mp4"`.
      - `ext` (string): Extension of the static rendition file Possible values: `"mp4"`, `"m4a"`.
      - `height` (integer, format: int32): The height of the static rendition's file in pixels
      - `width` (integer, format: int32): The width of the static rendition's file in pixels
      - `bitrate` (integer, format: int64): The bitrate in bits per second
      - `filesize` (string, format: int64): The file size in bytes
      - `type` (string): Indicates the static rendition type of this specific MP4 version of this asset. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option. Possible values: `"standard"`, `"advanced"`.
      - `status` (string): Indicates the status of this specific MP4 version of this asset. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option. For `mp4_support` renditions, see the top-level `static_renditions.status` field on the asset instead. * `ready` indicates the MP4 has been generated and is ready for download * `preparing` indicates the asset has not been ingested or the static rendition is still being generated after an asset is ready * `skipped` indicates the static rendition will not be generated because the requested resolution conflicts with the asset attributes after the asset has been ingested * `errored` indicates the static rendition cannot be generated. For example, an asset could not be ingested Possible values: `"ready"`, `"preparing"`, `"skipped"`, `"errored"`.
      - `resolution_tier` (string): Indicates the resolution tier of this specific MP4 version of this asset. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option. Possible values: `"2160p"`, `"1440p"`, `"1080p"`, `"720p"`, `"audio-only"`.
      - `resolution` (string): Indicates the resolution of this specific MP4 version of this asset. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option. Possible values: `"highest"`, `"audio-only"`.
      - `id` (string): The ID of this static rendition, used in managing this static rendition. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option.
      - `passthrough` (string): Arbitrary user-supplied metadata set for the static rendition. Max 255 characters.
  - `recording_times` (array of object): 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.
    - `started_at` (string, format: date-time): The time at which the recording for the live stream started. The time value is Unix epoch time represented in ISO 8601 format.
    - `duration` (number, format: double): The duration of the live stream recorded. The time value is in seconds.
    - `type` (string): The type of media represented by the recording session, either `content` for normal stream content or `slate` for slate media inserted during stream interruptions. Possible values: `"content"`, `"slate"`.
  - `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](https://docs.mux.com/guides/minimize-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.
    - `video_codec` (string): The video codec used on the input file. For example, the input file encoded with `av1` video codec is non-standard and the value of this parameter is `av1`.
    - `audio_codec` (string): The audio codec used on the input file. Non-AAC audio codecs are non-standard.
    - `video_gop_size` (string): 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. Possible values: `"high"`.
    - `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.
    - `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.
    - `video_bitrate` (string): 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. Possible values: `"high"`.
    - `pixel_aspect_ratio` (string): The video pixel aspect ratio of the input file.
    - `video_edit_list` (string): Video Edit List reason indicates that the input file's video track contains a complex Edit Decision List. Possible values: `"non-standard"`.
    - `audio_edit_list` (string): Audio Edit List reason indicates that the input file's audio track contains a complex Edit Decision List. Possible values: `"non-standard"`.
    - `unexpected_media_file_parameters` (string): A catch-all reason when the input file in created with non-standard encoding parameters. Possible values: `"non-standard"`.
    - `unsupported_pixel_format` (string): The video pixel format, as a string, returned by libav. Considered non-standard if not one of yuv420p or yuvj420p. HEVC inputs additionally permit yuv420p10le.
  - `test` (boolean, format: 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.
  - `ingest_type` (string): The type of ingest used to create the asset. Possible values: `"on_demand_url"`, `"on_demand_direct_upload"`, `"on_demand_clip"`, `"live_rtmp"`, `"live_srt"`.
  - `meta` (object): Customer provided metadata about this asset. Note: This metadata may be publicly available via the video player. Do not include PII or sensitive information.
    - `title` (string, maxLength: 512): The asset title. Max 512 code points.
    - `creator_id` (string, maxLength: 128): This is an identifier you provide to keep track of the creator of the asset. Max 128 code points.
    - `external_id` (string, maxLength: 128): This is an identifier you provide to link the asset to your own data. Max 128 code points.
  - `progress` (object, required): Detailed state information about the asset ingest process.
    - `state` (string, required): The detailed state of the asset ingest process. This field is useful for relaying more granular processing information to end users when a [non-standard input is encountered](https://www.mux.com/docs/guides/minimize-processing-time#non-standard-input). - `ingesting`: Asset is being ingested (initial processing before or after transcoding). While in this state, the `progress` percentage will be 0. - `transcoding`: Asset is undergoing non-standard transcoding. - `completed`: Asset processing is complete (`status` is `ready`). While in this state, the `progress` percentage will be 100. - `live`: Asset is a live stream currently in progress. While in this state, the `progress` percentage will be -1. - `errored`: Asset has encountered an error (`status` is `errored`). While in this state, the `progress` percentage will be -1. Possible values: `"ingesting"`, `"transcoding"`, `"completed"`, `"live"`, `"errored"`.
    - `progress` (number, required, format: double, minimum: -1, maximum: 100): Represents the estimated completion percentage. Returns `0 - 100` when in `ingesting`, `transcoding`, or `completed` state, and `-1` when in `live` or `errored` state.
  - `directives` (array of object): The Mux Robots directives applied to the asset.
    - `id` (string, required): The Mux Robots directive identifier.
  - `generate_shots` (boolean, default: false): Whether to perform shot detection on this asset. Shots are only generated for video assets and will not be generated for audio-only assets.
  - `shots` (object): The results of generating shots on the video
    - `status` (string, required): The status of the shot detection process Possible values: `"pending"`, `"completed"`, `"errored"`, `"skipped"`, `"deleted"`.
    - `created_at` (string, required, format: int64): Time the shot detection process was created, defined as a Unix timestamp (seconds since epoch).
    - `shots_manifest_url` (string): A URL to a JSON manifest describing the shot changes detected in the video along with shot preview images for each shot. This field is only present when `status` is `completed`.
    - `errors` (object): An object describing any errors encountered during the shot detection process. This field is only present when `status` is `errored`.
      - `type` (string): The type of error that occurred
      - `messages` (array of string): A list of error messages describing the errors that occurred in more detail
  - `thumbnail_time` (number, format: float): The media time within the asset used when a thumbnail without an explicit time is requested.

## Retrieve asset input info

`GET https://api.mux.com/video/v1/assets/{ASSET_ID}/input-info`

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

Operation ID: `get-asset-input-info`. HTML version: https://www.mux.com/docs/api-reference/video/assets/get-asset-input-info

### Path parameters

- `ASSET_ID` (string, required): The asset ID.

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

### Response `200`

OK

- `data` (array of object, required)
  - `settings` (object): An array of objects that each describe an input file to be used to create the asset. As a shortcut, `input` can also be a string URL for a file when only one input file is used. See `input[].url` for requirements.
    - `url` (string): The URL of the file that Mux should download and use. * For the main input file, this should be the URL to the muxed file for Mux to download, for example an MP4, MOV, MKV, or TS file. Mux supports most audio/video file formats and codecs, but for fastest processing, you should [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time). * For `audio` tracks, the URL is the location of the audio file for Mux to download, for example an M4A, WAV, or MP3 file. Mux supports most audio file formats and codecs, but for fastest processing, you should [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time). * For `text` tracks, the URL is the location of subtitle/captions file. Mux supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) formats for ingesting Subtitles and Closed Captions. * For Watermarking or Overlay, the URL is the location of the watermark image. The maximum size is 4096x4096. * When creating clips from existing Mux assets, the URL is defined with `mux://assets/{asset_id}` template where `asset_id` is the Asset Identifier for creating the clip from. The url property may be omitted on the first input object when providing asset settings for LiveStream and Upload objects, in order to configure settings related to the primary (live stream or direct upload) input.
    - `overlay_settings` (object): An object that describes how the image file referenced in URL should be placed over the video (i.e. watermarking). Ensure that the URL is active and persists the entire lifespan of the video object.
      - `vertical_align` (string): Where the vertical positioning of the overlay/watermark should begin from. Defaults to `"top"` Possible values: `"top"`, `"middle"`, `"bottom"`.
      - `vertical_margin` (string): The distance from the vertical_align starting point and the image's closest edge. Can be expressed as a percent ("10%") or as a pixel value ("100px"). Negative values will move the overlay offscreen. In the case of 'middle', a positive value will shift the overlay towards the bottom and and a negative value will shift it towards the top.
      - `horizontal_align` (string): Where the horizontal positioning of the overlay/watermark should begin from. Possible values: `"left"`, `"center"`, `"right"`.
      - `horizontal_margin` (string): The distance from the horizontal_align starting point and the image's closest edge. Can be expressed as a percent ("10%") or as a pixel value ("100px"). Negative values will move the overlay offscreen. In the case of 'center', a positive value will shift the image towards the right and and a negative value will shift it towards the left.
      - `width` (string): How wide the overlay should appear. Can be expressed as a percent ("10%") or as a pixel value ("100px"). If both width and height are left blank the width will be the true pixels of the image, applied as if the video has been scaled to fit a 1920x1080 frame. If height is supplied with no width, the width will scale proportionally to the height.
      - `height` (string): How tall the overlay should appear. Can be expressed as a percent ("10%") or as a pixel value ("100px"). If both width and height are left blank the height will be the true pixels of the image, applied as if the video has been scaled to fit a 1920x1080 frame. If width is supplied with no height, the height will scale proportionally to the width.
      - `opacity` (string): How opaque the overlay should appear, expressed as a percent. (Default 100%)
    - `generated_subtitles` (array of object): Generate subtitle tracks using automatic speech recognition with this configuration. Subtitles are generated using the audio of the input they are nested within. For direct uploads, this first input should omit the url parameter, as the main input file is provided via the direct upload. Note that subtitle generation happens after initial ingest, so the generated tracks will be in the `preparing` state when the asset transitions to `ready`.
      - `name` (string): A name for this subtitle track.
      - `passthrough` (string): Arbitrary metadata set for the subtitle track. Max 255 characters.
      - `language_code` (string, default: "en"): The language of the audio from which subtitles are generated. Selecting a language of "auto" will allow language detection to set the language code automatically. Possible values: `"en"`, `"es"`, `"it"`, `"pt"`, `"de"`, `"fr"`, `"pl"`, `"ru"`, `"nl"`, `"ca"`, `"tr"`, `"sv"`, `"uk"`, `"no"`, `"fi"`, `"sk"`, `"el"`, `"cs"`, `"hr"`, `"da"`, `"ro"`, `"bg"`, `"auto"`.
    - `start_time` (number, format: double): The time offset in seconds from the beginning of the video indicating the clip's starting marker. The default value is 0 when not included. This parameter is only applicable for creating clips when `input.url` has `mux://assets/{asset_id}` format.
    - `end_time` (number, format: double): The time offset in seconds from the beginning of the video, indicating the clip's ending marker. The default value is the duration of the video when not included. This parameter is only applicable for creating clips when `input.url` has `mux://assets/{asset_id}` format.
    - `type` (string): This parameter is required for `text` type tracks. Possible values: `"video"`, `"audio"`, `"text"`.
    - `text_type` (string): Type of text track. Use `subtitles` for subtitles and closed captions, or `chapters` for a chapters track. For more information on Subtitles / Closed Captions, [see this blog post](https://mux.com/blog/subtitles-captions-webvtt-hls-and-those-magic-flags/). This parameter is required for `text` type tracks. Possible values: `"subtitles"`, `"chapters"`.
    - `language_code` (string): The language code value must be a valid [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value. For example, `en` for English or `en-US` for the US version of English. This parameter is required for `text` and `audio` track types.
    - `name` (string): The name of the track containing a human-readable description. This value must be unique within each group of `text` or `audio` track types. The HLS manifest will associate a subtitle text track with this value. For example, the value should be "English" for a subtitle text track with `language_code` set to `en`. This optional parameter should be used only for `text` and `audio` type tracks. This parameter can be optionally provided for the first video input to denote the name of the muxed audio track if present. If this parameter is not included, Mux will auto-populate based on the `input[].language_code` value.
    - `closed_captions` (boolean): Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This optional parameter should be used for tracks with `type` of `text` and `text_type` set to `subtitles`.
    - `passthrough` (string): This optional parameter should be used for tracks with `type` of `text` and `text_type` set to `subtitles`.
  - `file` (object)
    - `container_format` (string)
    - `tracks` (array of object)
      - `type` (string, required)
      - `duration` (number, format: double)
      - `encoding` (string)
      - `width` (integer, format: int64)
      - `height` (integer, format: int64)
      - `frame_rate` (number, format: double)
      - `sample_rate` (integer, format: int64)
      - `sample_size` (integer, format: int64)
      - `channels` (integer, format: int64)

## Create a playback ID

`POST https://api.mux.com/video/v1/assets/{ASSET_ID}/playback-ids`

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

Operation ID: `create-asset-playback-id`. HTML version: https://www.mux.com/docs/api-reference/video/assets/create-asset-playback-id

### Path parameters

- `ASSET_ID` (string, required): The asset ID.

### Request body

- `policy` (string): * `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](https://docs.mux.com/guides/secure-video-playback) for details about creating tokens. * `drm` playback IDs are protected with DRM technologies. [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm). Possible values: `"public"`, `"signed"`, `"drm"`.
- `drm_configuration_id` (string): The DRM configuration used by this playback ID. Must only be set when `policy` is set to `drm`.

Example request body:

```json
{
  "policy": "public"
}
```

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

### Response `201`

Created

- `data` (object, required)
  - `id` (string, required): Unique identifier for the PlaybackID
  - `policy` (string, required): * `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](https://docs.mux.com/guides/secure-video-playback) for details about creating tokens. * `drm` playback IDs are protected with DRM technologies. [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm). Possible values: `"public"`, `"signed"`, `"drm"`.
  - `drm_configuration_id` (string): The DRM configuration used by this playback ID. Must only be set when `policy` is set to `drm`.

## Retrieve a playback ID

`GET https://api.mux.com/video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID}`

Retrieves information about the specified playback ID.

Operation ID: `get-asset-playback-id`. HTML version: https://www.mux.com/docs/api-reference/video/assets/get-asset-playback-id

### Path parameters

- `ASSET_ID` (string, required): The asset ID.
- `PLAYBACK_ID` (string, required): The asset or live stream's playback ID.

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

### Response `200`

OK

- `data` (object, required)
  - `id` (string, required): Unique identifier for the PlaybackID
  - `policy` (string, required): * `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](https://docs.mux.com/guides/secure-video-playback) for details about creating tokens. * `drm` playback IDs are protected with DRM technologies. [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm). Possible values: `"public"`, `"signed"`, `"drm"`.
  - `drm_configuration_id` (string): The DRM configuration used by this playback ID. Must only be set when `policy` is set to `drm`.

## Delete a playback ID

`DELETE https://api.mux.com/video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID}`

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

Operation ID: `delete-asset-playback-id`. HTML version: https://www.mux.com/docs/api-reference/video/assets/delete-asset-playback-id

### Path parameters

- `ASSET_ID` (string, required): The asset ID.
- `PLAYBACK_ID` (string, required): The asset or live stream's playback ID.

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

### Response `204`

No Content

## Update MP4 support

`PUT https://api.mux.com/video/v1/assets/{ASSET_ID}/mp4-support`

**Deprecated.**

This method has been deprecated. Please see the [Static Rendition API](https://www.mux.com/docs/guides/enable-static-mp4-renditions#after-asset-creation).
Allows you to add or remove mp4 support for assets that were created without it. The values supported are `capped-1080p`, `audio-only`, `audio-only,capped-1080p`, `standard`(deprecated),  and `none`. `none` means that an asset *does not* have mp4 support, so submitting a request with `mp4_support` set to `none` will delete the mp4 assets from the asset in question.

Operation ID: `update-asset-mp4-support`. HTML version: https://www.mux.com/docs/api-reference/video/assets/update-asset-mp4-support

### Path parameters

- `ASSET_ID` (string, required): The asset ID.

### Request body

- `mp4_support` (string, required): Specify what level of support for mp4 playback. * The `capped-1080p` option produces a single MP4 file, called `capped-1080p.mp4`, with the video resolution capped at 1080p. This option produces an `audio.m4a` file for an audio-only asset. * The `audio-only` option produces a single M4A file, called `audio.m4a` for a video or an audio-only asset. MP4 generation will error when this option is specified for a video-only asset. * The `audio-only,capped-1080p` option produces both the `audio.m4a` and `capped-1080p.mp4` files. Only the `capped-1080p.mp4` file is produced for a video-only asset, while only the `audio.m4a` file is produced for an audio-only asset. The `standard`(deprecated) option produces up to three MP4 files with different levels of resolution (`high.mp4`, `medium.mp4`, `low.mp4`, or `audio.m4a` for an audio-only asset). `none` will delete the MP4s from the asset in question. Possible values: `"standard"` (deprecated), `"none"`, `"capped-1080p"`, `"audio-only"`, `"audio-only,capped-1080p"`.

Example request body:

```json
{
  "mp4_support": "capped-1080p"
}
```

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

### Response `200`

OK

- `data` (object, required)
  - `id` (string, required): Unique identifier for the Asset. Max 255 characters.
  - `created_at` (string, required, format: int64): Time the Asset was created, defined as a Unix timestamp (seconds since epoch).
  - `status` (string, required): The status of the asset. Possible values: `"preparing"`, `"ready"`, `"errored"`.
  - `duration` (number, format: double): The duration of the asset in seconds (max duration for a single asset is 12 hours).
  - `max_stored_resolution` (string, deprecated): 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. Possible values: `"Audio only"`, `"SD"`, `"HD"`, `"FHD"`, `"UHD"`.
  - `resolution_tier` (string): 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. Possible values: `"audio-only"`, `"720p"`, `"1080p"`, `"1440p"`, `"2160p"`.
  - `max_resolution_tier` (string, required): 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`. Possible values: `"1080p"`, `"1440p"`, `"2160p"`.
  - `encoding_tier` (string, required, deprecated): This field is deprecated. Please use `video_quality` instead. The encoding tier informs the cost, quality, and available platform features for the asset. The default encoding tier for an account can be set in the Mux Dashboard. [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels) Possible values: `"smart"`, `"baseline"`, `"premium"`.
  - `video_quality` (string): The video quality controls the cost, quality, and available platform features for the asset. The default video quality for an account can be set in the Mux Dashboard. This field replaces the deprecated `encoding_tier` value. [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels) Possible values: `"basic"`, `"plus"`, `"premium"`.
  - `max_stored_frame_rate` (number, format: double): The maximum frame rate that has been stored for the asset. The asset may be delivered at lower frame rates depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. This field may return -1 if the frame rate of the input cannot be reliably determined.
  - `aspect_ratio` (string): The aspect ratio of the asset in the form of `width:height`, for example `16:9`.
  - `playback_ids` (array of object): An array of Playback ID objects. Use these to create HLS playback URLs. See [Play your videos](https://docs.mux.com/guides/play-your-videos) for more details.
    - `id` (string, required): Unique identifier for the PlaybackID
    - `policy` (string, required): * `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](https://docs.mux.com/guides/secure-video-playback) for details about creating tokens. * `drm` playback IDs are protected with DRM technologies. [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm). Possible values: `"public"`, `"signed"`, `"drm"`.
    - `drm_configuration_id` (string): The DRM configuration used by this playback ID. Must only be set when `policy` is set to `drm`.
  - `tracks` (array of object): The individual media tracks that make up an asset.
    - `id` (string): Unique identifier for the Track
    - `type` (string): The type of track Possible values: `"video"`, `"audio"`, `"text"`.
    - `duration` (number, format: double): 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.
    - `max_width` (integer, format: int64): The maximum width in pixels available for the track. Only set for the `video` type track.
    - `max_height` (integer, format: int64): The maximum height in pixels available for the track. Only set for the `video` type track.
    - `max_frame_rate` (number, format: double): 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.
    - `max_channels` (integer, format: int64): The maximum number of audio channels the track supports. Only set for the `audio` type track.
    - `text_type` (string): This parameter is only set for `text` type tracks. Possible values: `"subtitles"`, `"chapters"`.
    - `text_source` (string): 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. Possible values: `"uploaded"`, `"embedded"`, `"generated_live"`, `"generated_live_final"`, `"generated_vod"`.
    - `language_code` (string): The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value, or 'auto'. 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. During automatic language detection for generated subtitles, this value will be set to `auto` until the language is determined.
    - `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.
    - `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`.
    - `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.
    - `status` (string): The status of the track. `skipped` means the track was not created because the asset doesn't support it, for example generated subtitles on an asset with no audio. Possible values: `"preparing"`, `"ready"`, `"errored"`, `"deleted"`, `"skipped"`.
    - `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.
    - `auto_language_confidence` (number, format: double): The confidence value (0-1) of the determined language. This value only is available when automatic language detection is utilized in generated subtitles.
  - `errors` (object): Object that describes any errors that happened when processing this asset.
    - `type` (string): The type of error that occurred for this asset.
    - `messages` (array of string): Error messages with more details.
  - `upload_id` (string): Unique identifier for the Direct Upload. This is an optional parameter added when the asset is created from a direct upload.
  - `is_live` (boolean, format: boolean): Indicates whether the live stream that created this asset is currently `active` and not in `idle` state. This is an optional parameter added when the asset is created from a live stream.
  - `passthrough` (string): You can set this field to anything you want. It will be included in the asset details and related webhooks. If you're looking for more structured metadata, such as `title` or `external_id` , you can use the `meta` object instead. **Max: 255 characters**.
  - `live_stream_id` (string): Unique identifier for the live stream. This is an optional parameter added when the asset is created from a live stream.
  - `master` (object): An object containing the current status of Master Access and the link to the Master MP4 file when ready. This object does not exist if `master_access` is set to `none` and when the temporary URL expires.
    - `status` (string) Possible values: `"ready"`, `"preparing"`, `"errored"`.
    - `url` (string): The temporary URL to the master version of the video, as an MP4 file. This URL will expire after 24 hours.
  - `master_access` (string, required, default: "none") Possible values: `"temporary"`, `"none"`.
  - `mp4_support` (string, default: "none", deprecated): Deprecated. The level of MP4 support requested through the legacy `mp4_support` option, or `none` if it was not used. Renditions created this way appear in the `static_renditions` object alongside renditions created with the [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions); see that object for how the two differ. An asset cannot use both mechanisms at the same time. Possible values: `"standard"` (deprecated), `"none"`, `"capped-1080p"`, `"audio-only"`, `"audio-only,capped-1080p"`.
  - `source_asset_id` (string): Asset Identifier of the video used as the source for creating the clip.
  - `normalize_audio` (boolean, default: false): Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets.
  - `static_renditions` (object): An object containing the current status of any static renditions (MP4s) for this asset. The object does not exist if no static renditions have been requested. See [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions) for more information. This object is populated by both the [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions) and the deprecated `mp4_support` option, and the two report status differently: * Renditions created with the Static Renditions API each carry their own `id`, `status`, `type`, `resolution`, and `resolution_tier` in `files`. Track progress per rendition using `files[].status`. * Renditions created with the deprecated `mp4_support` option share a single aggregate `status` on this object, and their `files` entries do not include the per-rendition fields above.
    - `status` (string, default: "disabled"): Indicates the aggregate status of MP4 renditions created with the deprecated `mp4_support` option. This field is only meaningful when `mp4_support` is enabled on the asset. For renditions created with the Static Renditions API, use the per-rendition `files[].status` field instead. Possible values: `"ready"`, `"preparing"`, `"disabled"`, `"errored"`.
    - `files` (array of object): Array of file objects.
      - `name` (string): Name of the static rendition file Possible values: `"low.mp4"`, `"medium.mp4"`, `"high.mp4"`, `"highest.mp4"`, `"audio.m4a"`, `"capped-1080p.mp4"`, `"2160p.mp4"`, `"1440p.mp4"`, `"1080p.mp4"`, `"720p.mp4"`, `"540p.mp4"`, `"480p.mp4"`, `"360p.mp4"`, `"270p.mp4"`.
      - `ext` (string): Extension of the static rendition file Possible values: `"mp4"`, `"m4a"`.
      - `height` (integer, format: int32): The height of the static rendition's file in pixels
      - `width` (integer, format: int32): The width of the static rendition's file in pixels
      - `bitrate` (integer, format: int64): The bitrate in bits per second
      - `filesize` (string, format: int64): The file size in bytes
      - `type` (string): Indicates the static rendition type of this specific MP4 version of this asset. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option. Possible values: `"standard"`, `"advanced"`.
      - `status` (string): Indicates the status of this specific MP4 version of this asset. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option. For `mp4_support` renditions, see the top-level `static_renditions.status` field on the asset instead. * `ready` indicates the MP4 has been generated and is ready for download * `preparing` indicates the asset has not been ingested or the static rendition is still being generated after an asset is ready * `skipped` indicates the static rendition will not be generated because the requested resolution conflicts with the asset attributes after the asset has been ingested * `errored` indicates the static rendition cannot be generated. For example, an asset could not be ingested Possible values: `"ready"`, `"preparing"`, `"skipped"`, `"errored"`.
      - `resolution_tier` (string): Indicates the resolution tier of this specific MP4 version of this asset. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option. Possible values: `"2160p"`, `"1440p"`, `"1080p"`, `"720p"`, `"audio-only"`.
      - `resolution` (string): Indicates the resolution of this specific MP4 version of this asset. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option. Possible values: `"highest"`, `"audio-only"`.
      - `id` (string): The ID of this static rendition, used in managing this static rendition. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option.
      - `passthrough` (string): Arbitrary user-supplied metadata set for the static rendition. Max 255 characters.
  - `recording_times` (array of object): 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.
    - `started_at` (string, format: date-time): The time at which the recording for the live stream started. The time value is Unix epoch time represented in ISO 8601 format.
    - `duration` (number, format: double): The duration of the live stream recorded. The time value is in seconds.
    - `type` (string): The type of media represented by the recording session, either `content` for normal stream content or `slate` for slate media inserted during stream interruptions. Possible values: `"content"`, `"slate"`.
  - `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](https://docs.mux.com/guides/minimize-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.
    - `video_codec` (string): The video codec used on the input file. For example, the input file encoded with `av1` video codec is non-standard and the value of this parameter is `av1`.
    - `audio_codec` (string): The audio codec used on the input file. Non-AAC audio codecs are non-standard.
    - `video_gop_size` (string): 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. Possible values: `"high"`.
    - `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.
    - `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.
    - `video_bitrate` (string): 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. Possible values: `"high"`.
    - `pixel_aspect_ratio` (string): The video pixel aspect ratio of the input file.
    - `video_edit_list` (string): Video Edit List reason indicates that the input file's video track contains a complex Edit Decision List. Possible values: `"non-standard"`.
    - `audio_edit_list` (string): Audio Edit List reason indicates that the input file's audio track contains a complex Edit Decision List. Possible values: `"non-standard"`.
    - `unexpected_media_file_parameters` (string): A catch-all reason when the input file in created with non-standard encoding parameters. Possible values: `"non-standard"`.
    - `unsupported_pixel_format` (string): The video pixel format, as a string, returned by libav. Considered non-standard if not one of yuv420p or yuvj420p. HEVC inputs additionally permit yuv420p10le.
  - `test` (boolean, format: 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.
  - `ingest_type` (string): The type of ingest used to create the asset. Possible values: `"on_demand_url"`, `"on_demand_direct_upload"`, `"on_demand_clip"`, `"live_rtmp"`, `"live_srt"`.
  - `meta` (object): Customer provided metadata about this asset. Note: This metadata may be publicly available via the video player. Do not include PII or sensitive information.
    - `title` (string, maxLength: 512): The asset title. Max 512 code points.
    - `creator_id` (string, maxLength: 128): This is an identifier you provide to keep track of the creator of the asset. Max 128 code points.
    - `external_id` (string, maxLength: 128): This is an identifier you provide to link the asset to your own data. Max 128 code points.
  - `progress` (object, required): Detailed state information about the asset ingest process.
    - `state` (string, required): The detailed state of the asset ingest process. This field is useful for relaying more granular processing information to end users when a [non-standard input is encountered](https://www.mux.com/docs/guides/minimize-processing-time#non-standard-input). - `ingesting`: Asset is being ingested (initial processing before or after transcoding). While in this state, the `progress` percentage will be 0. - `transcoding`: Asset is undergoing non-standard transcoding. - `completed`: Asset processing is complete (`status` is `ready`). While in this state, the `progress` percentage will be 100. - `live`: Asset is a live stream currently in progress. While in this state, the `progress` percentage will be -1. - `errored`: Asset has encountered an error (`status` is `errored`). While in this state, the `progress` percentage will be -1. Possible values: `"ingesting"`, `"transcoding"`, `"completed"`, `"live"`, `"errored"`.
    - `progress` (number, required, format: double, minimum: -1, maximum: 100): Represents the estimated completion percentage. Returns `0 - 100` when in `ingesting`, `transcoding`, or `completed` state, and `-1` when in `live` or `errored` state.
  - `directives` (array of object): The Mux Robots directives applied to the asset.
    - `id` (string, required): The Mux Robots directive identifier.
  - `generate_shots` (boolean, default: false): Whether to perform shot detection on this asset. Shots are only generated for video assets and will not be generated for audio-only assets.
  - `shots` (object): The results of generating shots on the video
    - `status` (string, required): The status of the shot detection process Possible values: `"pending"`, `"completed"`, `"errored"`, `"skipped"`, `"deleted"`.
    - `created_at` (string, required, format: int64): Time the shot detection process was created, defined as a Unix timestamp (seconds since epoch).
    - `shots_manifest_url` (string): A URL to a JSON manifest describing the shot changes detected in the video along with shot preview images for each shot. This field is only present when `status` is `completed`.
    - `errors` (object): An object describing any errors encountered during the shot detection process. This field is only present when `status` is `errored`.
      - `type` (string): The type of error that occurred
      - `messages` (array of string): A list of error messages describing the errors that occurred in more detail
  - `thumbnail_time` (number, format: float): The media time within the asset used when a thumbnail without an explicit time is requested.

## Update master access

`PUT https://api.mux.com/video/v1/assets/{ASSET_ID}/master-access`

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

Operation ID: `update-asset-master-access`. HTML version: https://www.mux.com/docs/api-reference/video/assets/update-asset-master-access

### Path parameters

- `ASSET_ID` (string, required): The asset ID.

### Request body

- `master_access` (string, required): Add or remove access to the master version of the video. Possible values: `"temporary"`, `"none"`.

Example request body:

```json
{
  "master_access": "temporary"
}
```

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

### Response `200`

OK

- `data` (object, required)
  - `id` (string, required): Unique identifier for the Asset. Max 255 characters.
  - `created_at` (string, required, format: int64): Time the Asset was created, defined as a Unix timestamp (seconds since epoch).
  - `status` (string, required): The status of the asset. Possible values: `"preparing"`, `"ready"`, `"errored"`.
  - `duration` (number, format: double): The duration of the asset in seconds (max duration for a single asset is 12 hours).
  - `max_stored_resolution` (string, deprecated): 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. Possible values: `"Audio only"`, `"SD"`, `"HD"`, `"FHD"`, `"UHD"`.
  - `resolution_tier` (string): 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. Possible values: `"audio-only"`, `"720p"`, `"1080p"`, `"1440p"`, `"2160p"`.
  - `max_resolution_tier` (string, required): 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`. Possible values: `"1080p"`, `"1440p"`, `"2160p"`.
  - `encoding_tier` (string, required, deprecated): This field is deprecated. Please use `video_quality` instead. The encoding tier informs the cost, quality, and available platform features for the asset. The default encoding tier for an account can be set in the Mux Dashboard. [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels) Possible values: `"smart"`, `"baseline"`, `"premium"`.
  - `video_quality` (string): The video quality controls the cost, quality, and available platform features for the asset. The default video quality for an account can be set in the Mux Dashboard. This field replaces the deprecated `encoding_tier` value. [See the video quality guide for more details.](https://docs.mux.com/guides/use-video-quality-levels) Possible values: `"basic"`, `"plus"`, `"premium"`.
  - `max_stored_frame_rate` (number, format: double): The maximum frame rate that has been stored for the asset. The asset may be delivered at lower frame rates depending on the device and bandwidth, however it cannot be delivered at a higher value than is stored. This field may return -1 if the frame rate of the input cannot be reliably determined.
  - `aspect_ratio` (string): The aspect ratio of the asset in the form of `width:height`, for example `16:9`.
  - `playback_ids` (array of object): An array of Playback ID objects. Use these to create HLS playback URLs. See [Play your videos](https://docs.mux.com/guides/play-your-videos) for more details.
    - `id` (string, required): Unique identifier for the PlaybackID
    - `policy` (string, required): * `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](https://docs.mux.com/guides/secure-video-playback) for details about creating tokens. * `drm` playback IDs are protected with DRM technologies. [See DRM documentation for more details](https://docs.mux.com/guides/protect-videos-with-drm). Possible values: `"public"`, `"signed"`, `"drm"`.
    - `drm_configuration_id` (string): The DRM configuration used by this playback ID. Must only be set when `policy` is set to `drm`.
  - `tracks` (array of object): The individual media tracks that make up an asset.
    - `id` (string): Unique identifier for the Track
    - `type` (string): The type of track Possible values: `"video"`, `"audio"`, `"text"`.
    - `duration` (number, format: double): 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.
    - `max_width` (integer, format: int64): The maximum width in pixels available for the track. Only set for the `video` type track.
    - `max_height` (integer, format: int64): The maximum height in pixels available for the track. Only set for the `video` type track.
    - `max_frame_rate` (number, format: double): 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.
    - `max_channels` (integer, format: int64): The maximum number of audio channels the track supports. Only set for the `audio` type track.
    - `text_type` (string): This parameter is only set for `text` type tracks. Possible values: `"subtitles"`, `"chapters"`.
    - `text_source` (string): 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. Possible values: `"uploaded"`, `"embedded"`, `"generated_live"`, `"generated_live_final"`, `"generated_vod"`.
    - `language_code` (string): The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value, or 'auto'. 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. During automatic language detection for generated subtitles, this value will be set to `auto` until the language is determined.
    - `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.
    - `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`.
    - `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.
    - `status` (string): The status of the track. `skipped` means the track was not created because the asset doesn't support it, for example generated subtitles on an asset with no audio. Possible values: `"preparing"`, `"ready"`, `"errored"`, `"deleted"`, `"skipped"`.
    - `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.
    - `auto_language_confidence` (number, format: double): The confidence value (0-1) of the determined language. This value only is available when automatic language detection is utilized in generated subtitles.
  - `errors` (object): Object that describes any errors that happened when processing this asset.
    - `type` (string): The type of error that occurred for this asset.
    - `messages` (array of string): Error messages with more details.
  - `upload_id` (string): Unique identifier for the Direct Upload. This is an optional parameter added when the asset is created from a direct upload.
  - `is_live` (boolean, format: boolean): Indicates whether the live stream that created this asset is currently `active` and not in `idle` state. This is an optional parameter added when the asset is created from a live stream.
  - `passthrough` (string): You can set this field to anything you want. It will be included in the asset details and related webhooks. If you're looking for more structured metadata, such as `title` or `external_id` , you can use the `meta` object instead. **Max: 255 characters**.
  - `live_stream_id` (string): Unique identifier for the live stream. This is an optional parameter added when the asset is created from a live stream.
  - `master` (object): An object containing the current status of Master Access and the link to the Master MP4 file when ready. This object does not exist if `master_access` is set to `none` and when the temporary URL expires.
    - `status` (string) Possible values: `"ready"`, `"preparing"`, `"errored"`.
    - `url` (string): The temporary URL to the master version of the video, as an MP4 file. This URL will expire after 24 hours.
  - `master_access` (string, required, default: "none") Possible values: `"temporary"`, `"none"`.
  - `mp4_support` (string, default: "none", deprecated): Deprecated. The level of MP4 support requested through the legacy `mp4_support` option, or `none` if it was not used. Renditions created this way appear in the `static_renditions` object alongside renditions created with the [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions); see that object for how the two differ. An asset cannot use both mechanisms at the same time. Possible values: `"standard"` (deprecated), `"none"`, `"capped-1080p"`, `"audio-only"`, `"audio-only,capped-1080p"`.
  - `source_asset_id` (string): Asset Identifier of the video used as the source for creating the clip.
  - `normalize_audio` (boolean, default: false): Normalize the audio track loudness level. This parameter is only applicable to on-demand (not live) assets.
  - `static_renditions` (object): An object containing the current status of any static renditions (MP4s) for this asset. The object does not exist if no static renditions have been requested. See [Download your videos](https://docs.mux.com/guides/enable-static-mp4-renditions) for more information. This object is populated by both the [Static Renditions API](https://www.mux.com/docs/guides/enable-static-mp4-renditions) and the deprecated `mp4_support` option, and the two report status differently: * Renditions created with the Static Renditions API each carry their own `id`, `status`, `type`, `resolution`, and `resolution_tier` in `files`. Track progress per rendition using `files[].status`. * Renditions created with the deprecated `mp4_support` option share a single aggregate `status` on this object, and their `files` entries do not include the per-rendition fields above.
    - `status` (string, default: "disabled"): Indicates the aggregate status of MP4 renditions created with the deprecated `mp4_support` option. This field is only meaningful when `mp4_support` is enabled on the asset. For renditions created with the Static Renditions API, use the per-rendition `files[].status` field instead. Possible values: `"ready"`, `"preparing"`, `"disabled"`, `"errored"`.
    - `files` (array of object): Array of file objects.
      - `name` (string): Name of the static rendition file Possible values: `"low.mp4"`, `"medium.mp4"`, `"high.mp4"`, `"highest.mp4"`, `"audio.m4a"`, `"capped-1080p.mp4"`, `"2160p.mp4"`, `"1440p.mp4"`, `"1080p.mp4"`, `"720p.mp4"`, `"540p.mp4"`, `"480p.mp4"`, `"360p.mp4"`, `"270p.mp4"`.
      - `ext` (string): Extension of the static rendition file Possible values: `"mp4"`, `"m4a"`.
      - `height` (integer, format: int32): The height of the static rendition's file in pixels
      - `width` (integer, format: int32): The width of the static rendition's file in pixels
      - `bitrate` (integer, format: int64): The bitrate in bits per second
      - `filesize` (string, format: int64): The file size in bytes
      - `type` (string): Indicates the static rendition type of this specific MP4 version of this asset. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option. Possible values: `"standard"`, `"advanced"`.
      - `status` (string): Indicates the status of this specific MP4 version of this asset. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option. For `mp4_support` renditions, see the top-level `static_renditions.status` field on the asset instead. * `ready` indicates the MP4 has been generated and is ready for download * `preparing` indicates the asset has not been ingested or the static rendition is still being generated after an asset is ready * `skipped` indicates the static rendition will not be generated because the requested resolution conflicts with the asset attributes after the asset has been ingested * `errored` indicates the static rendition cannot be generated. For example, an asset could not be ingested Possible values: `"ready"`, `"preparing"`, `"skipped"`, `"errored"`.
      - `resolution_tier` (string): Indicates the resolution tier of this specific MP4 version of this asset. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option. Possible values: `"2160p"`, `"1440p"`, `"1080p"`, `"720p"`, `"audio-only"`.
      - `resolution` (string): Indicates the resolution of this specific MP4 version of this asset. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option. Possible values: `"highest"`, `"audio-only"`.
      - `id` (string): The ID of this static rendition, used in managing this static rendition. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option.
      - `passthrough` (string): Arbitrary user-supplied metadata set for the static rendition. Max 255 characters.
  - `recording_times` (array of object): 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.
    - `started_at` (string, format: date-time): The time at which the recording for the live stream started. The time value is Unix epoch time represented in ISO 8601 format.
    - `duration` (number, format: double): The duration of the live stream recorded. The time value is in seconds.
    - `type` (string): The type of media represented by the recording session, either `content` for normal stream content or `slate` for slate media inserted during stream interruptions. Possible values: `"content"`, `"slate"`.
  - `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](https://docs.mux.com/guides/minimize-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.
    - `video_codec` (string): The video codec used on the input file. For example, the input file encoded with `av1` video codec is non-standard and the value of this parameter is `av1`.
    - `audio_codec` (string): The audio codec used on the input file. Non-AAC audio codecs are non-standard.
    - `video_gop_size` (string): 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. Possible values: `"high"`.
    - `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.
    - `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.
    - `video_bitrate` (string): 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. Possible values: `"high"`.
    - `pixel_aspect_ratio` (string): The video pixel aspect ratio of the input file.
    - `video_edit_list` (string): Video Edit List reason indicates that the input file's video track contains a complex Edit Decision List. Possible values: `"non-standard"`.
    - `audio_edit_list` (string): Audio Edit List reason indicates that the input file's audio track contains a complex Edit Decision List. Possible values: `"non-standard"`.
    - `unexpected_media_file_parameters` (string): A catch-all reason when the input file in created with non-standard encoding parameters. Possible values: `"non-standard"`.
    - `unsupported_pixel_format` (string): The video pixel format, as a string, returned by libav. Considered non-standard if not one of yuv420p or yuvj420p. HEVC inputs additionally permit yuv420p10le.
  - `test` (boolean, format: 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.
  - `ingest_type` (string): The type of ingest used to create the asset. Possible values: `"on_demand_url"`, `"on_demand_direct_upload"`, `"on_demand_clip"`, `"live_rtmp"`, `"live_srt"`.
  - `meta` (object): Customer provided metadata about this asset. Note: This metadata may be publicly available via the video player. Do not include PII or sensitive information.
    - `title` (string, maxLength: 512): The asset title. Max 512 code points.
    - `creator_id` (string, maxLength: 128): This is an identifier you provide to keep track of the creator of the asset. Max 128 code points.
    - `external_id` (string, maxLength: 128): This is an identifier you provide to link the asset to your own data. Max 128 code points.
  - `progress` (object, required): Detailed state information about the asset ingest process.
    - `state` (string, required): The detailed state of the asset ingest process. This field is useful for relaying more granular processing information to end users when a [non-standard input is encountered](https://www.mux.com/docs/guides/minimize-processing-time#non-standard-input). - `ingesting`: Asset is being ingested (initial processing before or after transcoding). While in this state, the `progress` percentage will be 0. - `transcoding`: Asset is undergoing non-standard transcoding. - `completed`: Asset processing is complete (`status` is `ready`). While in this state, the `progress` percentage will be 100. - `live`: Asset is a live stream currently in progress. While in this state, the `progress` percentage will be -1. - `errored`: Asset has encountered an error (`status` is `errored`). While in this state, the `progress` percentage will be -1. Possible values: `"ingesting"`, `"transcoding"`, `"completed"`, `"live"`, `"errored"`.
    - `progress` (number, required, format: double, minimum: -1, maximum: 100): Represents the estimated completion percentage. Returns `0 - 100` when in `ingesting`, `transcoding`, or `completed` state, and `-1` when in `live` or `errored` state.
  - `directives` (array of object): The Mux Robots directives applied to the asset.
    - `id` (string, required): The Mux Robots directive identifier.
  - `generate_shots` (boolean, default: false): Whether to perform shot detection on this asset. Shots are only generated for video assets and will not be generated for audio-only assets.
  - `shots` (object): The results of generating shots on the video
    - `status` (string, required): The status of the shot detection process Possible values: `"pending"`, `"completed"`, `"errored"`, `"skipped"`, `"deleted"`.
    - `created_at` (string, required, format: int64): Time the shot detection process was created, defined as a Unix timestamp (seconds since epoch).
    - `shots_manifest_url` (string): A URL to a JSON manifest describing the shot changes detected in the video along with shot preview images for each shot. This field is only present when `status` is `completed`.
    - `errors` (object): An object describing any errors encountered during the shot detection process. This field is only present when `status` is `errored`.
      - `type` (string): The type of error that occurred
      - `messages` (array of string): A list of error messages describing the errors that occurred in more detail
  - `thumbnail_time` (number, format: float): The media time within the asset used when a thumbnail without an explicit time is requested.

## Create a static rendition for an asset

`POST https://api.mux.com/video/v1/assets/{ASSET_ID}/static-renditions`

Creates a static rendition (i.e. MP4) for an asset

Operation ID: `create-asset-static-rendition`. HTML version: https://www.mux.com/docs/api-reference/video/assets/create-asset-static-rendition

### Path parameters

- `ASSET_ID` (string, required): The asset ID.

### Request body

- `resolution` (string, required) Possible values: `"highest"`, `"audio-only"`, `"2160p"`, `"1440p"`, `"1080p"`, `"720p"`, `"540p"`, `"480p"`, `"360p"`, `"270p"`.
- `passthrough` (string): Arbitrary user-supplied metadata set for the static rendition. Max 255 characters.

Example request body:

```json
{
  "resolution": "highest"
}
```

### Response `201`

Created

- `data` (object, required)
  - `name` (string): Name of the static rendition file Possible values: `"low.mp4"`, `"medium.mp4"`, `"high.mp4"`, `"highest.mp4"`, `"audio.m4a"`, `"capped-1080p.mp4"`, `"2160p.mp4"`, `"1440p.mp4"`, `"1080p.mp4"`, `"720p.mp4"`, `"540p.mp4"`, `"480p.mp4"`, `"360p.mp4"`, `"270p.mp4"`.
  - `ext` (string): Extension of the static rendition file Possible values: `"mp4"`, `"m4a"`.
  - `height` (integer, format: int32): The height of the static rendition's file in pixels
  - `width` (integer, format: int32): The width of the static rendition's file in pixels
  - `bitrate` (integer, format: int64): The bitrate in bits per second
  - `filesize` (string, format: int64): The file size in bytes
  - `type` (string): Indicates the static rendition type of this specific MP4 version of this asset. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option. Possible values: `"standard"`, `"advanced"`.
  - `status` (string): Indicates the status of this specific MP4 version of this asset. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option. For `mp4_support` renditions, see the top-level `static_renditions.status` field on the asset instead. * `ready` indicates the MP4 has been generated and is ready for download * `preparing` indicates the asset has not been ingested or the static rendition is still being generated after an asset is ready * `skipped` indicates the static rendition will not be generated because the requested resolution conflicts with the asset attributes after the asset has been ingested * `errored` indicates the static rendition cannot be generated. For example, an asset could not be ingested Possible values: `"ready"`, `"preparing"`, `"skipped"`, `"errored"`.
  - `resolution_tier` (string): Indicates the resolution tier of this specific MP4 version of this asset. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option. Possible values: `"2160p"`, `"1440p"`, `"1080p"`, `"720p"`, `"audio-only"`.
  - `resolution` (string): Indicates the resolution of this specific MP4 version of this asset. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option. Possible values: `"highest"`, `"audio-only"`.
  - `id` (string): The ID of this static rendition, used in managing this static rendition. Only present for static renditions created with the Static Renditions API. Not set for renditions created with the deprecated `mp4_support` option.
  - `passthrough` (string): Arbitrary user-supplied metadata set for the static rendition. Max 255 characters.

## Delete a single static rendition for an asset

`DELETE https://api.mux.com/video/v1/assets/{ASSET_ID}/static-renditions/{STATIC_RENDITION_ID}`

Deletes a single static rendition for an asset

Operation ID: `delete-asset-static-rendition`. HTML version: https://www.mux.com/docs/api-reference/video/assets/delete-asset-static-rendition

### Path parameters

- `ASSET_ID` (string, required): The asset ID.
- `STATIC_RENDITION_ID` (string, required): The static rendition ID.

### Response `204`

No Content

## Unset the thumbnail time for an asset

`DELETE https://api.mux.com/video/v1/assets/{ASSET_ID}/thumbnail-time`

Unset the thumbnail time for an asset, returning the thumbnail to default behavior

Operation ID: `delete-asset-thumbnail-time`. HTML version: https://www.mux.com/docs/api-reference/video/assets/delete-asset-thumbnail-time

### Path parameters

- `ASSET_ID` (string, required): The asset ID.

### Response `204`

No Content

## Create an asset track

`POST https://api.mux.com/video/v1/assets/{ASSET_ID}/tracks`

Adds an asset track (for example, subtitles, or an alternate audio track) to an asset. Assets must be in the `ready` state before tracks can be added.

Operation ID: `create-asset-track`. HTML version: https://www.mux.com/docs/api-reference/video/assets/create-asset-track

### Path parameters

- `ASSET_ID` (string, required): The asset ID.

### Request body

- `url` (string, required): The URL of the file that Mux should download and use. * For `audio` tracks, the URL is the location of the audio file for Mux to download, for example an M4A, WAV, or MP3 file. Mux supports most audio file formats and codecs, but for fastest processing, you should [use standard inputs wherever possible](https://docs.mux.com/guides/minimize-processing-time). * For `text` tracks, the URL is the location of subtitle/captions file. Mux supports [SubRip Text (SRT)](https://en.wikipedia.org/wiki/SubRip) and [Web Video Text Tracks](https://www.w3.org/TR/webvtt1/) formats for ingesting Subtitles and Closed Captions.
- `type` (string, required) Possible values: `"text"`, `"audio"`.
- `text_type` (string): The type of text track. Required when `type` is `text`. Use `subtitles` for subtitles and closed captions, or `chapters` for a chapters track. Possible values: `"subtitles"`, `"chapters"`.
- `language_code` (string, required): The language code of this track. The value must be a valid BCP 47 specification compliant value. For example, en for English or en-US for the US version of English.
- `name` (string): The name of the track containing a human-readable description. This value must be unique within each group of `text` or `audio` track types. The HLS manifest will associate the `text` or `audio` track with this value. For example, set the value to "English" for subtitles text track with `language_code` as en-US. If this parameter is not included, Mux will auto-populate a value based on the `language_code` value.
- `closed_captions` (boolean): Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
- `passthrough` (string): Arbitrary user-supplied metadata set for the track either when creating the asset or track.

Example request body:

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

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

### Response `201`

Created

- `data` (object, required)
  - `id` (string): Unique identifier for the Track
  - `type` (string): The type of track Possible values: `"video"`, `"audio"`, `"text"`.
  - `duration` (number, format: double): 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.
  - `max_width` (integer, format: int64): The maximum width in pixels available for the track. Only set for the `video` type track.
  - `max_height` (integer, format: int64): The maximum height in pixels available for the track. Only set for the `video` type track.
  - `max_frame_rate` (number, format: double): 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.
  - `max_channels` (integer, format: int64): The maximum number of audio channels the track supports. Only set for the `audio` type track.
  - `text_type` (string): This parameter is only set for `text` type tracks. Possible values: `"subtitles"`, `"chapters"`.
  - `text_source` (string): 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. Possible values: `"uploaded"`, `"embedded"`, `"generated_live"`, `"generated_live_final"`, `"generated_vod"`.
  - `language_code` (string): The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value, or 'auto'. 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. During automatic language detection for generated subtitles, this value will be set to `auto` until the language is determined.
  - `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.
  - `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`.
  - `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.
  - `status` (string): The status of the track. `skipped` means the track was not created because the asset doesn't support it, for example generated subtitles on an asset with no audio. Possible values: `"preparing"`, `"ready"`, `"errored"`, `"deleted"`, `"skipped"`.
  - `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.
  - `auto_language_confidence` (number, format: double): The confidence value (0-1) of the determined language. This value only is available when automatic language detection is utilized in generated subtitles.

## Delete an asset track

`DELETE https://api.mux.com/video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID}`

Removes a text or additional audio track from an asset. Neither video nor the primary audio track can be removed.

Operation ID: `delete-asset-track`. HTML version: https://www.mux.com/docs/api-reference/video/assets/delete-asset-track

### Path parameters

- `ASSET_ID` (string, required): The asset ID.
- `TRACK_ID` (string, required): The ID of the track for an asset.

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

### Response `204`

No Content

## Update an asset track

`PATCH https://api.mux.com/video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID}`

Updates the details of an existing Asset Track with the provided Asset ID and Track ID.

Operation ID: `update-asset-track`. HTML version: https://www.mux.com/docs/api-reference/video/assets/update-asset-track

### Path parameters

- `ASSET_ID` (string, required): The asset ID.
- `TRACK_ID` (string, required): The ID of the track for an asset.

### Request body

- `language_code` (string): The language code of this track. The value must be a valid BCP 47 specification compliant value. For example, en for English or en-US for the US version of English.
- `name` (string): The name of the track containing a human-readable description. This value must be unique within each group of `text` or `audio` track types. The HLS manifest will associate the `text` or `audio` track with this value. For example, set the value to "English" for subtitles text track with `language_code` as en-US. If this parameter is not included, Mux will auto-populate a value based on the `language_code` value.
- `closed_captions` (boolean): Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH).
- `passthrough` (string): Arbitrary user-supplied metadata set for the track either when creating the asset or track.

Example request body:

```json
{
  "language_code": "en-US",
  "name": "English"
}
```

### Response `200`

OK

- `data` (object, required)
  - `id` (string): Unique identifier for the Track
  - `type` (string): The type of track Possible values: `"video"`, `"audio"`, `"text"`.
  - `duration` (number, format: double): 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.
  - `max_width` (integer, format: int64): The maximum width in pixels available for the track. Only set for the `video` type track.
  - `max_height` (integer, format: int64): The maximum height in pixels available for the track. Only set for the `video` type track.
  - `max_frame_rate` (number, format: double): 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.
  - `max_channels` (integer, format: int64): The maximum number of audio channels the track supports. Only set for the `audio` type track.
  - `text_type` (string): This parameter is only set for `text` type tracks. Possible values: `"subtitles"`, `"chapters"`.
  - `text_source` (string): 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. Possible values: `"uploaded"`, `"embedded"`, `"generated_live"`, `"generated_live_final"`, `"generated_vod"`.
  - `language_code` (string): The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value, or 'auto'. 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. During automatic language detection for generated subtitles, this value will be set to `auto` until the language is determined.
  - `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.
  - `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`.
  - `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.
  - `status` (string): The status of the track. `skipped` means the track was not created because the asset doesn't support it, for example generated subtitles on an asset with no audio. Possible values: `"preparing"`, `"ready"`, `"errored"`, `"deleted"`, `"skipped"`.
  - `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.
  - `auto_language_confidence` (number, format: double): The confidence value (0-1) of the determined language. This value only is available when automatic language detection is utilized in generated subtitles.

## Generate track subtitles

`POST https://api.mux.com/video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID}/generate-subtitles`

Generates subtitles (captions) for a given audio track. [See docs for more information.](https://mux.com/docs/guides/add-autogenerated-captions-and-use-transcripts#retroactively-enable-auto-generated-captions)

Operation ID: `generate-asset-track-subtitles`. HTML version: https://www.mux.com/docs/api-reference/video/assets/generate-asset-track-subtitles

### Path parameters

- `ASSET_ID` (string, required): The asset ID.
- `TRACK_ID` (string, required): The ID of the track for an asset.

### Request body

- `generated_subtitles` (array of object, required): Generate subtitle tracks using automatic speech recognition with this configuration.
  - `name` (string): A name for this subtitle track.
  - `passthrough` (string): Arbitrary metadata set for the subtitle track. Max 255 characters.
  - `language_code` (string, default: "en"): The language of the audio from which subtitles are generated. Selecting a language of "auto" will allow language detection to set the language code automatically. Possible values: `"en"`, `"es"`, `"it"`, `"pt"`, `"de"`, `"fr"`, `"pl"`, `"ru"`, `"nl"`, `"ca"`, `"tr"`, `"sv"`, `"uk"`, `"no"`, `"fi"`, `"sk"`, `"el"`, `"cs"`, `"hr"`, `"da"`, `"ro"`, `"bg"`, `"auto"`.

Example request body:

```json
{
  "generated_subtitles": [
    {
      "language_code": "en",
      "name": "English (generated)",
      "passthrough": "English (generated)"
    }
  ]
}
```

### Response `201`

Created

- `data` (array of object, required)
  - `id` (string): Unique identifier for the Track
  - `type` (string): The type of track Possible values: `"video"`, `"audio"`, `"text"`.
  - `duration` (number, format: double): 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.
  - `max_width` (integer, format: int64): The maximum width in pixels available for the track. Only set for the `video` type track.
  - `max_height` (integer, format: int64): The maximum height in pixels available for the track. Only set for the `video` type track.
  - `max_frame_rate` (number, format: double): 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.
  - `max_channels` (integer, format: int64): The maximum number of audio channels the track supports. Only set for the `audio` type track.
  - `text_type` (string): This parameter is only set for `text` type tracks. Possible values: `"subtitles"`, `"chapters"`.
  - `text_source` (string): 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. Possible values: `"uploaded"`, `"embedded"`, `"generated_live"`, `"generated_live_final"`, `"generated_vod"`.
  - `language_code` (string): The language code value represents [BCP 47](https://tools.ietf.org/html/bcp47) specification compliant value, or 'auto'. 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. During automatic language detection for generated subtitles, this value will be set to `auto` until the language is determined.
  - `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.
  - `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`.
  - `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.
  - `status` (string): The status of the track. `skipped` means the track was not created because the asset doesn't support it, for example generated subtitles on an asset with no audio. Possible values: `"preparing"`, `"ready"`, `"errored"`, `"deleted"`, `"skipped"`.
  - `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.
  - `auto_language_confidence` (number, format: double): The confidence value (0-1) of the determined language. This value only is available when automatic language detection is utilized in generated subtitles.

## Get asset shots

`GET https://api.mux.com/video/v1/assets/{ASSET_ID}/shots`

Retrieves the shot manifest URL containing shot boundaries and shot preview image URLs.

Operation ID: `get-asset-shots`. HTML version: https://www.mux.com/docs/api-reference/video/assets/get-asset-shots

### Path parameters

- `ASSET_ID` (string, required): The asset ID.

### Response `200`

OK

- `data` (object, required): The results of generating shots on the video
  - `status` (string, required): The status of the shot detection process Possible values: `"pending"`, `"completed"`, `"errored"`, `"skipped"`, `"deleted"`.
  - `created_at` (string, required, format: int64): Time the shot detection process was created, defined as a Unix timestamp (seconds since epoch).
  - `shots_manifest_url` (string): A URL to a JSON manifest describing the shot changes detected in the video along with shot preview images for each shot. This field is only present when `status` is `completed`.
  - `errors` (object): An object describing any errors encountered during the shot detection process. This field is only present when `status` is `errored`.
    - `type` (string): The type of error that occurred
    - `messages` (array of string): A list of error messages describing the errors that occurred in more detail

## Generate shots

`POST https://api.mux.com/video/v1/assets/{ASSET_ID}/shots`

Generate shot boundaries and shot preview images.

Operation ID: `generate-asset-shots`. HTML version: https://www.mux.com/docs/api-reference/video/assets/generate-asset-shots

### Path parameters

- `ASSET_ID` (string, required): The asset ID.

### Request body


Example request body:

```json
{}
```

### Response `201`

Created

- `data` (object, required): The results of generating shots on the video
  - `status` (string, required): The status of the shot detection process Possible values: `"pending"`, `"completed"`, `"errored"`, `"skipped"`, `"deleted"`.
  - `created_at` (string, required, format: int64): Time the shot detection process was created, defined as a Unix timestamp (seconds since epoch).
  - `shots_manifest_url` (string): A URL to a JSON manifest describing the shot changes detected in the video along with shot preview images for each shot. This field is only present when `status` is `completed`.
  - `errors` (object): An object describing any errors encountered during the shot detection process. This field is only present when `status` is `errored`.
    - `type` (string): The type of error that occurred
    - `messages` (array of string): A list of error messages describing the errors that occurred in more detail

## Delete asset shots

`DELETE https://api.mux.com/video/v1/assets/{ASSET_ID}/shots`

Deletes detected shot boundaries and shot preview images on the asset.

Operation ID: `delete-asset-shots`. HTML version: https://www.mux.com/docs/api-reference/video/assets/delete-asset-shots

### Path parameters

- `ASSET_ID` (string, required): The asset ID.

### Response `204`

No Content
