Mux · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mux Streaming API

3 actions 3 updates phrasing extends openapi/mux-com-streaming-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 3

$.info

$.paths['/{PLAYBACK_ID}.m3u8'].get

$.paths['/{PLAYBACK_ID}/{FILENAME}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mux Streaming API
  version: 1.0.0
extends: openapi/mux-com-streaming-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: 2
- target: $.paths['/{PLAYBACK_ID}.m3u8'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the HLS playlist for a video
      effect: read
      questions:
      - How do I get the .m3u8 stream URL to play a Mux video?
      - Can I cap the maximum resolution viewers get in the HLS playlist?
      - Is there a way to play just a clip of a video by start and end time?
      instructions:
      - text: Get the HLS manifest for playback {playback_id}.
        slots:
          playback_id: path.PLAYBACK_ID
      - text: Get the HLS playlist for playback {playback_id} capped at {max_resolution}.
        slots:
          playback_id: path.PLAYBACK_ID
          max_resolution: query.max_resolution
      - text: Play playback {playback_id} from {asset_start_time} to {asset_end_time} seconds via HLS.
        slots:
          playback_id: path.PLAYBACK_ID
          asset_start_time: query.asset_start_time
          asset_end_time: query.asset_end_time
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{PLAYBACK_ID}/{FILENAME}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a static MP4 or M4A rendition
      effect: read
      questions:
      - How do I download an MP4 file of my video?
      - Does MP4 support need to be enabled before I can fetch a static rendition?
      instructions:
      - text: Download static rendition {filename} for playback {playback_id}.
        slots:
          filename: path.FILENAME
          playback_id: path.PLAYBACK_ID
      - text: Fetch the MP4 file {filename} of signed playback {playback_id} with token {token}.
        slots:
          filename: path.FILENAME
          playback_id: path.PLAYBACK_ID
          token: query.TOKEN
      method: generated
      generated: '2026-09-26'