Wistia · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Data Extended Audio Descriptions API

6 actions 6 updates phrasing extends openapi/wistia-extended-audio-descriptions-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Wistia's API. It is a proposal applied on top of the contract, not a document Wistia publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/media_extended_audio_descriptions'].get
$.paths['/media_extended_audio_descriptions/{id}'].get
$.paths['/media_extended_audio_descriptions/{id}'].delete
$.paths['/media_extended_audio_descriptions/order'].post
$.paths['/media_extended_audio_descriptions/order_status/{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 Data Extended Audio Descriptions API
  version: 1.0.0
extends: openapi/wistia-extended-audio-descriptions-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/media_extended_audio_descriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List extended audio descriptions
      effect: read
      questions:
      - Which extended audio descriptions exist in my account?
      - Can I page through all my audio descriptions sorted by date?
      instructions:
      - text: List the extended audio descriptions in my account.
      - text: Show extended audio descriptions sorted by {sort_by}.
        slots:
          sort_by: query.sort_by
      method: generated
      generated: '2026-10-01'
- target: $.paths['/media_extended_audio_descriptions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show an extended audio description
      effect: read
      questions:
      - How do I get the download links for an extended audio description?
      - Where can I see the details of one audio description track?
      instructions:
      - text: Show extended audio description {id}.
        slots:
          id: path.id
      - text: Get the download links for audio description {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/media_extended_audio_descriptions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an extended audio description
      effect: destructive
      questions:
      - How do I remove an extended audio description from my account?
      - Can I delete an audio description track I no longer need?
      instructions:
      - text: Delete extended audio description {id}.
        slots:
          id: path.id
      - text: Remove audio description track {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/media_extended_audio_descriptions/order'].post
  update:
    x-apievangelist-phrasing:
      intent: Order an extended audio description
      effect: write
      questions:
      - How do I order an extended audio description for a video?
      - Will ordering an audio description charge my card?
      - Can I request an AI-generated audio description in another language?
      instructions:
      - text: Order an extended audio description for media {media_id}.
        slots:
          media_id: requestBody.media_id
      - text: Order an AI audio description for media {media_id} in {ietf_language_tag}.
        slots:
          media_id: requestBody.media_id
          ietf_language_tag: requestBody.ietf_language_tag
      method: generated
      generated: '2026-10-01'
- target: $.paths['/media_extended_audio_descriptions/order_status/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an audio description order's status
      effect: read
      questions:
      - Is my extended audio description order ready yet?
      - How do I poll the progress of an audio description order?
      instructions:
      - text: Check the status of audio description order {id}.
        slots:
          id: path.id
      - text: Tell me whether audio description order {id} has finished.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'