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.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Mux Storyboards API
version: 1.0.0
extends: openapi/mux-com-storyboards-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: 3
- target: $.paths['/{PLAYBACK_ID}/storyboard.{EXTENSION}'].get
update:
x-apievangelist-phrasing:
intent: Get a storyboard image for hover previews
effect: read
questions:
- How do I show thumbnail previews when viewers hover over the video timeline?
- Can I get a single sprite image of thumbnails across my video?
instructions:
- text: Get the {extension} storyboard image for playback {playback_id}.
slots:
extension: path.EXTENSION
playback_id: path.PLAYBACK_ID
- text: Fetch the storyboard sprite for playback {playback_id} from {asset_start_time} to {asset_end_time} as {extension}.
slots:
playback_id: path.PLAYBACK_ID
asset_start_time: query.asset_start_time
asset_end_time: query.asset_end_time
extension: path.EXTENSION
method: generated
generated: '2026-09-26'
- target: $.paths['/{PLAYBACK_ID}/storyboard.vtt'].get
update:
x-apievangelist-phrasing:
intent: Get storyboard tile coordinates as WebVTT
effect: read
questions:
- Where do I get the WebVTT file mapping storyboard tiles to timestamps?
- Can my player read storyboard coordinates from a .vtt file?
instructions:
- text: Get the WebVTT storyboard metadata for playback {playback_id}.
slots:
playback_id: path.PLAYBACK_ID
- text: Fetch storyboard.vtt for signed playback {playback_id} with token {token}.
slots:
playback_id: path.PLAYBACK_ID
token: query.TOKEN
method: generated
generated: '2026-09-26'
- target: $.paths['/{PLAYBACK_ID}/storyboard.json'].get
update:
x-apievangelist-phrasing:
intent: Get storyboard tile coordinates as JSON
effect: read
questions:
- Can I get storyboard thumbnail positions and time ranges as JSON?
- Which image format does the JSON storyboard point to, and can I change it?
instructions:
- text: Get the JSON storyboard metadata for playback {playback_id}.
slots:
playback_id: path.PLAYBACK_ID
- text: Fetch storyboard.json for playback {playback_id} with images in {format}.
slots:
playback_id: path.PLAYBACK_ID
format: query.format
method: generated
generated: '2026-09-26'
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.