Mux · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mux Edit Captions API

3 actions 3 updates phrasing extends openapi/mux-com-edit-captions-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/edit-captions'].post
$.paths['/robots/v0/jobs/edit-captions/{JOB_ID}'].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 Edit Captions API
  version: 1.0.0
extends: openapi/mux-com-edit-captions-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/edit-captions'].post
  update:
    x-apievangelist-phrasing:
      intent: Edit captions with replacements or censoring
      effect: write
      questions:
      - Can I automatically bleep out profanity in my video's captions?
      - How do I find-and-replace words across an existing caption track?
      instructions:
      - text: Start an edit-captions job with parameters {parameters}.
        slots:
          parameters: requestBody.parameters
      - text: Censor profanity in captions using {parameters} and tag it {passthrough}.
        slots:
          parameters: requestBody.parameters
          passthrough: requestBody.passthrough
      method: generated
      generated: '2026-09-26'
- target: $.paths['/robots/v0/jobs/edit-captions/{JOB_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the result of an edit-captions job
      effect: read
      questions:
      - Is my caption editing job done yet?
      - Where can I see what an edit-captions job changed?
      instructions:
      - text: Get edit-captions job {job_id}.
        slots:
          job_id: path.JOB_ID
      - text: Check the status of caption edit job {job_id}.
        slots:
          job_id: path.JOB_ID
      method: generated
      generated: '2026-09-26'