Mux · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mux Jobs API

3 actions 3 updates phrasing extends openapi/mux-com-jobs-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'].get

$.paths['/robots/v0/jobs/{JOB_ID}/cancel'].post

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 Jobs API
  version: 1.0.0
extends: openapi/mux-com-jobs-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'].get
  update:
    x-apievangelist-phrasing:
      intent: List AI robot jobs
      effect: read
      questions:
      - Which AI jobs have I run against my video assets?
      - Can I filter robot jobs by workflow, status or asset?
      instructions:
      - text: List my robot jobs.
      - text: List {workflow} jobs with status {status}.
        slots:
          workflow: query.workflow
          status: query.status
      - text: List all AI jobs run on asset {asset_id}.
        slots:
          asset_id: query.asset_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/robots/v0/jobs/{JOB_ID}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a pending or running AI job
      effect: destructive
      questions:
      - How do I stop an AI job that's still processing?
      - Can I cancel a robot job once it has already finished?
      instructions:
      - text: Cancel job {job_id}.
        slots:
          job_id: path.JOB_ID
      - text: Stop the running robot job {job_id}.
        slots:
          job_id: path.JOB_ID
      method: generated
      generated: '2026-09-26'