Mux · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mux Com Assets API

18 actions 18 updates phrasing extends openapi/mux-com-assets-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Mux's API. It is a proposal applied on top of the contract, not a document Mux publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 18 · first 16 shown; the file carries all of them

$.info
$.paths['/video/v1/assets'].get
$.paths['/video/v1/assets'].post
$.paths['/video/v1/assets/{ASSET_ID}'].get
$.paths['/video/v1/assets/{ASSET_ID}'].delete
$.paths['/video/v1/assets/{ASSET_ID}'].patch
$.paths['/video/v1/assets/{ASSET_ID}/input-info'].get
$.paths['/video/v1/assets/{ASSET_ID}/playback-ids'].post
$.paths['/video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID}'].get
$.paths['/video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID}'].delete
$.paths['/video/v1/assets/{ASSET_ID}/mp4-support'].put
$.paths['/video/v1/assets/{ASSET_ID}/master-access'].put
$.paths['/video/v1/assets/{ASSET_ID}/static-renditions'].post
$.paths['/video/v1/assets/{ASSET_ID}/static-renditions/{STATIC_RENDITION_ID}'].delete
$.paths['/video/v1/assets/{ASSET_ID}/tracks'].post
$.paths['/video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID}'].delete

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mux Com Assets API
  version: 1.0.0
extends: openapi/mux-com-assets-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 17
- target: $.paths['/video/v1/assets'].get
  update:
    x-apievangelist-phrasing:
      intent: List video assets
      effect: read
      questions:
      - Which video assets are in my Mux environment?
      - Can I page through all my uploaded videos?
      instructions:
      - text: List my video assets.
      - text: List video assets page {page}, {limit} per page.
        slots:
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/assets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a video asset
      effect: write
      questions:
      - How do I create a new video asset in Mux from a file?
      - What's the call to ingest a new video so it becomes an asset?
      instructions:
      - text: Create a new video asset.
      - text: Ingest a new video and make it an asset.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/assets/{ASSET_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a video asset's details
      effect: read
      questions:
      - Is my video asset ready to play yet?
      - What details can I see for one video asset?
      instructions:
      - text: Show me asset {asset_id}.
        slots:
          asset_id: path.ASSET_ID
      - text: Check the status of video asset {asset_id}.
        slots:
          asset_id: path.ASSET_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/assets/{ASSET_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a video asset
      effect: destructive
      questions:
      - How do I permanently delete a video from Mux?
      - Can I remove an asset I no longer need?
      instructions:
      - text: Delete asset {asset_id}.
        slots:
          asset_id: path.ASSET_ID
      - text: Permanently remove video asset {asset_id}.
        slots:
          asset_id: path.ASSET_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/assets/{ASSET_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a video asset
      effect: write
      questions:
      - Can I change settings on a video asset after it's created?
      - How do I edit an existing asset's details?
      instructions:
      - text: Update asset {asset_id}.
        slots:
          asset_id: path.ASSET_ID
      - text: Edit the settings of video asset {asset_id}.
        slots:
          asset_id: path.ASSET_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/assets/{ASSET_ID}/input-info'].get
  update:
    x-apievangelist-phrasing:
      intent: See the inputs used to create an asset
      effect: read
      questions:
      - What source files and input settings were used to build this asset?
      - Can I check which input settings were applied when an asset was created?
      instructions:
      - text: Show the input info for asset {asset_id}.
        slots:
          asset_id: path.ASSET_ID
      - text: List the source inputs and their settings for asset {asset_id}.
        slots:
          asset_id: path.ASSET_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/assets/{ASSET_ID}/playback-ids'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a playback ID to an asset
      effect: write
      questions:
      - How do I get a new playback ID so viewers can stream my asset?
      - Can I add a signed or DRM playback ID to an existing asset?
      instructions:
      - text: Add a playback ID to asset {asset_id}.
        slots:
          asset_id: path.ASSET_ID
      - text: Create a {policy} playback ID on asset {asset_id}.
        slots:
          policy: requestBody.policy
          asset_id: path.ASSET_ID
      - text: Add a DRM playback ID to asset {asset_id} using configuration {drm_configuration_id}.
        slots:
          asset_id: path.ASSET_ID
          drm_configuration_id: requestBody.drm_configuration_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an asset's playback ID details
      effect: read
      questions:
      - What policy is set on a particular playback ID of my asset?
      - Can I look up one playback ID belonging to an asset?
      instructions:
      - text: Show playback ID {playback_id} on asset {asset_id}.
        slots:
          playback_id: path.PLAYBACK_ID
          asset_id: path.ASSET_ID
      - text: Check the policy of asset {asset_id}'s playback ID {playback_id}.
        slots:
          asset_id: path.ASSET_ID
          playback_id: path.PLAYBACK_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/assets/{ASSET_ID}/playback-ids/{PLAYBACK_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a playback ID from an asset
      effect: destructive
      questions:
      - How do I stop people watching an asset through one specific playback ID?
      - Does deleting an asset's playback ID cut off viewers already watching?
      instructions:
      - text: Delete playback ID {playback_id} from asset {asset_id}.
        slots:
          playback_id: path.PLAYBACK_ID
          asset_id: path.ASSET_ID
      - text: Revoke viewing access via playback {playback_id} on asset {asset_id}.
        slots:
          playback_id: path.PLAYBACK_ID
          asset_id: path.ASSET_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/assets/{ASSET_ID}/mp4-support'].put
  update:
    x-apievangelist-phrasing:
      intent: Change MP4 support on an asset (deprecated)
      effect: write
      questions:
      - Can I still turn MP4 downloads on or off using the old mp4-support setting?
      - What replaced the deprecated MP4 support endpoint for assets?
      instructions:
      - text: Set MP4 support on asset {asset_id} to {mp4_support}.
        slots:
          asset_id: path.ASSET_ID
          mp4_support: requestBody.mp4_support
      - text: Use the legacy mp4-support call to disable MP4 on asset {asset_id} with {mp4_support}.
        slots:
          asset_id: path.ASSET_ID
          mp4_support: requestBody.mp4_support
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/assets/{ASSET_ID}/master-access'].put
  update:
    x-apievangelist-phrasing:
      intent: Enable temporary master file download
      effect: write
      questions:
      - How do I download the highest-quality master MP4 of my video?
      - How long does a master access download URL stay valid?
      instructions:
      - text: Set master access on asset {asset_id} to {master_access}.
        slots:
          asset_id: path.ASSET_ID
          master_access: requestBody.master_access
      - text: Turn on the 24-hour master MP4 download for asset {asset_id} with {master_access}.
        slots:
          asset_id: path.ASSET_ID
          master_access: requestBody.master_access
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/assets/{ASSET_ID}/static-renditions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an MP4 static rendition for an asset
      effect: write
      questions:
      - Can I generate a downloadable MP4 of my asset at a specific resolution?
      - How do I add a static rendition to a video that already exists?
      instructions:
      - text: Create a {resolution} static rendition for asset {asset_id}.
        slots:
          resolution: requestBody.resolution
          asset_id: path.ASSET_ID
      - text: Add a {resolution} MP4 rendition to asset {asset_id} tagged {passthrough}.
        slots:
          resolution: requestBody.resolution
          asset_id: path.ASSET_ID
          passthrough: requestBody.passthrough
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/assets/{ASSET_ID}/static-renditions/{STATIC_RENDITION_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one static rendition of an asset
      effect: destructive
      questions:
      - How do I remove a single MP4 rendition from an asset without deleting the video?
      - Can I delete just one static rendition I created?
      instructions:
      - text: Delete static rendition {static_rendition_id} from asset {asset_id}.
        slots:
          static_rendition_id: path.STATIC_RENDITION_ID
          asset_id: path.ASSET_ID
      - text: Remove the MP4 rendition {static_rendition_id} on asset {asset_id}.
        slots:
          static_rendition_id: path.STATIC_RENDITION_ID
          asset_id: path.ASSET_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/assets/{ASSET_ID}/tracks'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a subtitle or audio track to an asset
      effect: write
      questions:
      - How do I attach a subtitles file to a video that's already uploaded?
      - Can I add an alternate-language audio track to an asset?
      - Does an asset need to be ready before I add a track to it?
      instructions:
      - text: Add a {type} track from {url} in {language_code} to asset {asset_id}.
        slots:
          type: requestBody.type
          url: requestBody.url
          language_code: requestBody.language_code
          asset_id: path.ASSET_ID
      - text: Attach subtitles from {url} in {language_code} named {name} to asset {asset_id}.
        slots:
          url: requestBody.url
          language_code: requestBody.language_code
          name: requestBody.name
          asset_id: path.ASSET_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a text or audio track from an asset
      effect: destructive
      questions:
      - How do I remove a subtitle track from my video?
      - Can I delete the primary audio or video track of an asset?
      instructions:
      - text: Delete track {track_id} from asset {asset_id}.
        slots:
          track_id: path.TRACK_ID
          asset_id: path.ASSET_ID
      - text: Remove the extra audio track {track_id} on asset {asset_id}.
        slots:
          track_id: path.TRACK_ID
          asset_id: path.ASSET_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit an existing asset track
      effect: write
      questions:
      - Can I rename a subtitle track or change its language after adding it?
      - How do I mark an existing text track as closed captions?
      instructions:
      - text: Rename track {track_id} on asset {asset_id} to {name}.
        slots:
          track_id: path.TRACK_ID
          asset_id: path.ASSET_ID
          name: requestBody.name
      - text: Change the language of track {track_id} on asset {asset_id} to {language_code}.
        slots:
          track_id: path.TRACK_ID
          asset_id: path.ASSET_ID
          language_code: requestBody.language_code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/assets/{ASSET_ID}/tracks/{TRACK_ID}/generate-subtitles'].post
  update:
    x-apievangelist-phrasing:
      intent: Auto-generate subtitles from an audio track
      effect: write
      questions:
      - Can Mux auto-generate captions for a video I uploaded earlier?
      - How do I create subtitles from an asset's audio track after the fact?
      instructions:
      - text: Generate subtitles for audio track {track_id} on asset {asset_id} with {generated_subtitles}.
        slots:
          track_id: path.TRACK_ID
          asset_id: path.ASSET_ID
          generated_subtitles: requestBody.generated_subtitles
      - text: Auto-caption asset {asset_id} from audio track {track_id} using {generated_subtitles}.
        slots:
          asset_id: path.ASSET_ID
          track_id: path.TRACK_ID
          generated_subtitles: requestBody.generated_subtitles
      method: generated
      generated: '2026-09-26'