Mux · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mux Animated Images API

2 actions 2 updates phrasing extends openapi/mux-com-animated-images-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 2

$.info
$.paths['/{PLAYBACK_ID}/animated.{EXTENSION}'].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 Animated Images API
  version: 1.0.0
extends: openapi/mux-com-animated-images-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: 1
- target: $.paths['/{PLAYBACK_ID}/animated.{EXTENSION}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an animated GIF or WebP clip from a video
      effect: read
      questions:
      - How do I turn a segment of my Mux video into an animated GIF?
      - Can I choose the start and end time of an animated preview from a video?
      - What frame rate and size options exist for animated WebP images from a video?
      instructions:
      - text: Make an animated {extension} from playback ID {playback_id}.
        slots:
          extension: path.EXTENSION
          playback_id: path.PLAYBACK_ID
      - text: Create an animated GIF of playback {playback_id} from second {start} to {end}.
        slots:
          playback_id: path.PLAYBACK_ID
          start: query.start
          end: query.end
      - text: Render an animated {extension} of playback {playback_id} at {width} pixels wide and {fps} fps.
        slots:
          extension: path.EXTENSION
          playback_id: path.PLAYBACK_ID
          width: query.width
          fps: query.fps
      method: generated
      generated: '2026-09-26'