Mux · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mux Generate Chapters API

3 actions 3 updates phrasing extends openapi/mux-com-generate-chapters-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['/robots/v0/jobs/generate-chapters'].post

$.paths['/robots/v0/jobs/generate-chapters/{JOB_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 Generate Chapters API
  version: 1.0.0
extends: openapi/mux-com-generate-chapters-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['/robots/v0/jobs/generate-chapters'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate video chapters with AI
      effect: write
      questions:
      - Can Mux automatically split my video into chapters?
      - How do I start AI chapter generation for an asset?
      instructions:
      - text: Start a generate-chapters job with parameters {parameters}.
        slots:
          parameters: requestBody.parameters
      - text: Create chapters for a video using {parameters}, tagged {passthrough}.
        slots:
          parameters: requestBody.parameters
          passthrough: requestBody.passthrough
      method: generated
      generated: '2026-09-26'
- target: $.paths['/robots/v0/jobs/generate-chapters/{JOB_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get chapters from a generate-chapters job
      effect: read
      questions:
      - Where can I get the chapter list an AI job produced for my video?
      - How long do generate-chapters job results stick around?
      instructions:
      - text: Get the chapters from job {job_id}.
        slots:
          job_id: path.JOB_ID
      - text: Check the status of chapter generation job {job_id}.
        slots:
          job_id: path.JOB_ID
      method: generated
      generated: '2026-09-26'