Mux · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mux Video Views API

3 actions 3 updates phrasing extends openapi/mux-com-video-views-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['/data/v1/video-views'].get

$.paths['/data/v1/video-views/{VIDEO_VIEW_ID}'].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 Video Views API
  version: 1.0.0
extends: openapi/mux-com-video-views-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['/data/v1/video-views'].get
  update:
    x-apievangelist-phrasing:
      intent: List individual video views
      effect: read
      questions:
      - Can I see every view a particular viewer had?
      - Which views hit a specific playback error?
      - How do I list views that ended within a certain timeframe?
      instructions:
      - text: List video views.
      - text: List views by viewer {viewer_id}.
        slots:
          viewer_id: query.viewer_id
      - text: List views that hit error {error_id} over {timeframe}.
        slots:
          error_id: query.error_id
          timeframe: query.timeframe[]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v1/video-views/{VIDEO_VIEW_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the details of one video view
      effect: read
      questions:
      - What happened during one specific playback session?
      - Can I see the full event details of a single view?
      instructions:
      - text: Show video view {video_view_id}.
        slots:
          video_view_id: path.VIDEO_VIEW_ID
      - text: Get the full details of view {video_view_id}.
        slots:
          video_view_id: path.VIDEO_VIEW_ID
      method: generated
      generated: '2026-09-26'