Mux · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mux Transcription Vocabularies API

6 actions 6 updates phrasing extends openapi/mux-com-transcription-vocabularies-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 6

$.info

$.paths['/video/v1/transcription-vocabularies'].get

$.paths['/video/v1/transcription-vocabularies'].post

$.paths['/video/v1/transcription-vocabularies/{TRANSCRIPTION_VOCABULARY_ID}'].get

$.paths['/video/v1/transcription-vocabularies/{TRANSCRIPTION_VOCABULARY_ID}'].put

$.paths['/video/v1/transcription-vocabularies/{TRANSCRIPTION_VOCABULARY_ID}'].delete

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 Transcription Vocabularies API
  version: 1.0.0
extends: openapi/mux-com-transcription-vocabularies-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: 5
- target: $.paths['/video/v1/transcription-vocabularies'].get
  update:
    x-apievangelist-phrasing:
      intent: List transcription vocabularies
      effect: read
      questions:
      - Which custom transcription vocabularies have I created?
      - Can I page through my transcription vocabularies?
      instructions:
      - text: List my transcription vocabularies.
      - text: List transcription vocabularies, {limit} per page.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/transcription-vocabularies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom transcription vocabulary
      effect: write
      questions:
      - How do I teach auto-captions brand names and jargon they keep getting wrong?
      - Can I give live captions a list of custom phrases to recognize?
      instructions:
      - text: Create a transcription vocabulary with phrases {phrases}.
        slots:
          phrases: requestBody.phrases
      - text: Create a vocabulary named {name} containing {phrases}.
        slots:
          name: requestBody.name
          phrases: requestBody.phrases
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/transcription-vocabularies/{TRANSCRIPTION_VOCABULARY_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a transcription vocabulary
      effect: read
      questions:
      - What phrases are in one of my transcription vocabularies?
      - Can I look up a transcription vocabulary by ID?
      instructions:
      - text: Show transcription vocabulary {transcription_vocabulary_id}.
        slots:
          transcription_vocabulary_id: path.TRANSCRIPTION_VOCABULARY_ID
      - text: List the phrases in vocabulary {transcription_vocabulary_id}.
        slots:
          transcription_vocabulary_id: path.TRANSCRIPTION_VOCABULARY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/transcription-vocabularies/{TRANSCRIPTION_VOCABULARY_ID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a transcription vocabulary's phrases
      effect: write
      questions:
      - Can I change a vocabulary while a live stream is using it?
      - How do I add new phrases to an existing transcription vocabulary?
      instructions:
      - text: Replace the phrases in vocabulary {transcription_vocabulary_id} with {phrases}.
        slots:
          transcription_vocabulary_id: path.TRANSCRIPTION_VOCABULARY_ID
          phrases: requestBody.phrases
      - text: Rename vocabulary {transcription_vocabulary_id} to {name} with phrases {phrases}.
        slots:
          transcription_vocabulary_id: path.TRANSCRIPTION_VOCABULARY_ID
          name: requestBody.name
          phrases: requestBody.phrases
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/transcription-vocabularies/{TRANSCRIPTION_VOCABULARY_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a transcription vocabulary
      effect: destructive
      questions:
      - What happens to live streams using a vocabulary when I delete it?
      - How do I remove a transcription vocabulary?
      instructions:
      - text: Delete transcription vocabulary {transcription_vocabulary_id}.
        slots:
          transcription_vocabulary_id: path.TRANSCRIPTION_VOCABULARY_ID
      - text: Remove vocabulary {transcription_vocabulary_id} from my account.
        slots:
          transcription_vocabulary_id: path.TRANSCRIPTION_VOCABULARY_ID
      method: generated
      generated: '2026-09-26'