Mux · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mux Captions and Transcripts API

3 actions 3 updates phrasing extends openapi/mux-com-captions-and-transcripts-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}/text/{TRACK_ID}.vtt'].get
$.paths['/{PLAYBACK_ID}/text/{TRACK_ID}.txt'].get

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 Captions and Transcripts API
  version: 1.0.0
extends: openapi/mux-com-captions-and-transcripts-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}/text/{TRACK_ID}.vtt'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a text track as a WebVTT file
      effect: read
      questions:
      - How do I download the captions of a video as a .vtt file?
      - Can I fetch a WebVTT file for a signed playback ID?
      instructions:
      - text: Download the WebVTT file for track {track_id} of playback {playback_id}.
        slots:
          track_id: path.TRACK_ID
          playback_id: path.PLAYBACK_ID
      - text: Get the .vtt captions for track {track_id} on playback {playback_id} with token {token}.
        slots:
          track_id: path.TRACK_ID
          playback_id: path.PLAYBACK_ID
          token: query.TOKEN
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{PLAYBACK_ID}/text/{TRACK_ID}.txt'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a plain-text transcript of a video
      effect: read
      questions:
      - Can I get a plain text transcript of what's said in my video?
      - Which videos can I fetch a .txt transcript for?
      instructions:
      - text: Get the plain-text transcript for track {track_id} of playback {playback_id}.
        slots:
          track_id: path.TRACK_ID
          playback_id: path.PLAYBACK_ID
      - text: Download the transcript .txt of playback {playback_id} track {track_id} using token {token}.
        slots:
          playback_id: path.PLAYBACK_ID
          track_id: path.TRACK_ID
          token: query.TOKEN
      method: generated
      generated: '2026-09-26'