Wistia · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Wistia Channel Episodes API

9 actions 9 updates phrasing extends openapi/wistia-channel-episodes-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 9

$.info
$.paths['/channels/{channelHashedId}/channel_episodes/{channelEpisodeId}'].get
$.paths['/channels/{channelHashedId}/channel_episodes'].get
$.paths['/channels/{channelHashedId}/channel_episodes'].post
$.paths['/channel_episodes'].get
$.paths['/channel_episodes/{channelEpisodeHashedId}'].put
$.paths['/channel_episodes/{channelEpisodeHashedId}'].delete
$.paths['/channel_episodes/{channelEpisodeHashedId}/publish'].put
$.paths['/channel_episodes/{channelEpisodeHashedId}/unpublish'].put

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 Wistia Channel Episodes API
  version: 1.0.0
extends: openapi/wistia-channel-episodes-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: 8
- target: $.paths['/channels/{channelHashedId}/channel_episodes/{channelEpisodeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show one episode within a channel
      effect: read
      questions:
      - How do I look up a single episode by its id inside a specific channel?
      - Where can I see the details of one channel episode, such as its title and publish status?
      instructions:
      - text: Show episode {channelEpisodeId} from channel {channelHashedId}.
        slots:
          channelEpisodeId: path.channelEpisodeId
          channelHashedId: path.channelHashedId
      - text: Get the details of episode {channelEpisodeId} in channel {channelHashedId}.
        slots:
          channelEpisodeId: path.channelEpisodeId
          channelHashedId: path.channelHashedId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/channels/{channelHashedId}/channel_episodes'].get
  update:
    x-apievangelist-phrasing:
      intent: List the episodes of one channel
      effect: read
      questions:
      - What episodes are in this particular channel?
      - Can I list only the published episodes of one channel?
      instructions:
      - text: List the episodes in channel {channelHashedId}.
        slots:
          channelHashedId: path.channelHashedId
      - text: Show episodes of channel {channelHashedId} with published set to {published}.
        slots:
          channelHashedId: path.channelHashedId
          published: query.published
      method: generated
      generated: '2026-10-01'
- target: $.paths['/channels/{channelHashedId}/channel_episodes'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new episode to a channel
      effect: write
      questions:
      - How do I add a video as a new episode in my Wistia channel?
      - Can I schedule a new channel episode to publish at a later time?
      instructions:
      - text: Create an episode titled {title} in channel {channelHashedId} from media {media_id}.
        slots:
          title: requestBody.title
          channelHashedId: path.channelHashedId
          media_id: requestBody.media_id
      - text: Add a new episode to channel {channelHashedId} scheduled to publish at {publish_at}.
        slots:
          channelHashedId: path.channelHashedId
          publish_at: requestBody.publish_at
      method: generated
      generated: '2026-10-01'
- target: $.paths['/channel_episodes'].get
  update:
    x-apievangelist-phrasing:
      intent: List channel episodes across the account
      effect: read
      questions:
      - How do I list every channel episode across all my channels?
      - Can I batch fetch several episodes at once by their hashed ids?
      - Which episodes account-wide use a particular media?
      instructions:
      - text: List all channel episodes in my account.
      - text: Fetch the episodes with hashed ids {hashed_ids} across my account.
        slots:
          hashed_ids: query.hashed_ids[]
      - text: Find account-wide episodes titled {title}.
        slots:
          title: query.title
      method: generated
      generated: '2026-10-01'
- target: $.paths['/channel_episodes/{channelEpisodeHashedId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a channel episode
      effect: write
      questions:
      - How do I change the title or description of an existing episode?
      - Can I add episode notes or swap the media behind an episode?
      instructions:
      - text: Rename episode {channelEpisodeHashedId} to {title}.
        slots:
          channelEpisodeHashedId: path.channelEpisodeHashedId
          title: requestBody.title
      - text: Set the episode notes on {channelEpisodeHashedId} to {episode_notes}.
        slots:
          channelEpisodeHashedId: path.channelEpisodeHashedId
          episode_notes: requestBody.episode_notes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/channel_episodes/{channelEpisodeHashedId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a channel episode
      effect: destructive
      questions:
      - How do I permanently delete an episode from a channel?
      - What happens if I delete a channel episode rather than unpublishing it?
      instructions:
      - text: Delete channel episode {channelEpisodeHashedId}.
        slots:
          channelEpisodeHashedId: path.channelEpisodeHashedId
      - text: Remove episode {channelEpisodeHashedId} from its channel for good.
        slots:
          channelEpisodeHashedId: path.channelEpisodeHashedId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/channel_episodes/{channelEpisodeHashedId}/publish'].put
  update:
    x-apievangelist-phrasing:
      intent: Publish a channel episode
      effect: write
      questions:
      - How do I make a draft episode live on my channel?
      - Can I publish an episode at a specific future time?
      instructions:
      - text: Publish episode {channelEpisodeHashedId}.
        slots:
          channelEpisodeHashedId: path.channelEpisodeHashedId
      - text: Publish episode {channelEpisodeHashedId} at {publish_at}.
        slots:
          channelEpisodeHashedId: path.channelEpisodeHashedId
          publish_at: requestBody.publish_at
      method: generated
      generated: '2026-10-01'
- target: $.paths['/channel_episodes/{channelEpisodeHashedId}/unpublish'].put
  update:
    x-apievangelist-phrasing:
      intent: Unpublish a channel episode
      effect: write
      questions:
      - How do I take an episode off my channel without deleting it?
      - Can I hide a published episode from viewers temporarily?
      instructions:
      - text: Unpublish episode {channelEpisodeHashedId}.
        slots:
          channelEpisodeHashedId: path.channelEpisodeHashedId
      - text: Pull episode {channelEpisodeHashedId} back to unpublished but keep it.
        slots:
          channelEpisodeHashedId: path.channelEpisodeHashedId
      method: generated
      generated: '2026-10-01'