Mux · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mux Moderate API

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

$.paths['/robots/v0/jobs/moderate/{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 Moderate API
  version: 1.0.0
extends: openapi/mux-com-moderate-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/moderate'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a video for inappropriate content
      effect: write
      questions:
      - Can AI screen my uploaded videos for inappropriate content?
      - How do I run content moderation on a video asset?
      instructions:
      - text: Start a moderate job with parameters {parameters}.
        slots:
          parameters: requestBody.parameters
      - text: Screen a video for unsafe content using {parameters}, tagged {passthrough}.
        slots:
          parameters: requestBody.parameters
          passthrough: requestBody.passthrough
      method: generated
      generated: '2026-09-26'
- target: $.paths['/robots/v0/jobs/moderate/{JOB_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a moderation job's results
      effect: read
      questions:
      - Did the moderation job flag anything in my video?
      - How long are moderation results kept?
      instructions:
      - text: Get moderation job {job_id}.
        slots:
          job_id: path.JOB_ID
      - text: Check the moderation results for job {job_id}.
        slots:
          job_id: path.JOB_ID
      method: generated
      generated: '2026-09-26'