Mux · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mux Com Direct Uploads API

5 actions 5 updates phrasing extends openapi/mux-com-direct-uploads-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 5

$.info

$.paths['/video/v1/uploads'].get

$.paths['/video/v1/uploads'].post

$.paths['/video/v1/uploads/{UPLOAD_ID}'].get

$.paths['/video/v1/uploads/{UPLOAD_ID}/cancel'].put

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 Com Direct Uploads API
  version: 1.0.0
extends: openapi/mux-com-direct-uploads-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: 4
- target: $.paths['/video/v1/uploads'].get
  update:
    x-apievangelist-phrasing:
      intent: List direct uploads
      effect: read
      questions:
      - Which direct uploads have been created in my environment?
      - Can I see all pending and completed browser uploads?
      instructions:
      - text: List my direct uploads.
      - text: Show all direct upload URLs I've created.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/uploads'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a direct upload URL
      effect: write
      questions:
      - How do I let users upload a video straight from their browser?
      - Can I get a signed URL that a client can upload a video file to?
      instructions:
      - text: Create a direct upload URL.
      - text: Generate a new URL my app can upload a video file to.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/uploads/{UPLOAD_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a direct upload's status
      effect: read
      questions:
      - Has a user's direct upload finished and turned into an asset?
      - What asset was created from a given upload?
      instructions:
      - text: Show direct upload {upload_id}.
        slots:
          upload_id: path.UPLOAD_ID
      - text: Check the status of upload {upload_id}.
        slots:
          upload_id: path.UPLOAD_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/video/v1/uploads/{UPLOAD_ID}/cancel'].put
  update:
    x-apievangelist-phrasing:
      intent: Cancel a pending direct upload
      effect: destructive
      questions:
      - How do I stop a direct upload that hasn't completed yet?
      - Will an asset still be created if a cancelled upload finishes later?
      instructions:
      - text: Cancel direct upload {upload_id}.
        slots:
          upload_id: path.UPLOAD_ID
      - text: Stop upload {upload_id} so no asset gets created.
        slots:
          upload_id: path.UPLOAD_ID
      method: generated
      generated: '2026-09-26'