# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Wistia Customizations API
  version: 1.0.0
extends: openapi/wistia-customizations-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: 28
- target: $.paths['/medias/{mediaId}/customizations'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a video's player customizations
      effect: read
      questions:
      - What player customizations are applied to a specific video?
      - Can I see the embed options set on one video's player?
      instructions:
      - text: Show the player customizations for media {media}.
        slots:
          media: path.mediaId
      - text: Get the current embed options on video {media}.
        slots:
          media: path.mediaId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{mediaId}/customizations'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a video's player customizations
      effect: write
      questions:
      - How do I tweak the player settings already customized on a video?
      - Can I change one existing customization without resetting the rest?
      instructions:
      - text: Update the existing player customizations on media {media}.
        slots:
          media: path.mediaId
      - text: Modify the customized player options for video {media}.
        slots:
          media: path.mediaId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{mediaId}/customizations'].post
  update:
    x-apievangelist-phrasing:
      intent: Set player customizations on a video
      effect: write
      questions:
      - How do I customize the player for a video that uses the defaults?
      - Can I set a whole new group of player options for a video?
      instructions:
      - text: Create player customizations for media {media}.
        slots:
          media: path.mediaId
      - text: Set a fresh set of player options on video {media}.
        slots:
          media: path.mediaId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{mediaId}/customizations'].delete
  update:
    x-apievangelist-phrasing:
      intent: Reset a video's player customizations
      effect: destructive
      questions:
      - How do I reset a video's player back to the account defaults?
      - Can I clear all customizations from one video?
      instructions:
      - text: Delete the player customizations on media {media}.
        slots:
          media: path.mediaId
      - text: Reset video {media} to the default player.
        slots:
          media: path.mediaId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{mediaId}/customizations/appearance'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a video's appearance customizations
      effect: read
      questions:
      - What player color, rounded corners and logo settings are set on a video?
      - Is a customer logo configured on one of my video players?
      instructions:
      - text: Show the appearance customizations for video {media}.
        slots:
          media: path.mediaId
      - text: Get the player color and logo settings on media {media}.
        slots:
          media: path.mediaId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{mediaId}/customizations/appearance'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a video's player appearance
      effect: write
      questions:
      - Can I change the player color and add a gradient on just one video?
      - How do I put my company logo in the corner of a video player?
      instructions:
      - text: Set the player color on video {media} to {color}.
        slots:
          media: path.mediaId
          color: requestBody.playerColor
      - text: Show customer logo {logo} on video {media} linking to {target}.
        slots:
          logo: requestBody.customerLogoImageUrl
          media: path.mediaId
          target: requestBody.customerLogoTargetUrl
      - text: Make the player for video {media} rounded with opaque controls.
        slots:
          media: path.mediaId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{mediaId}/customizations/playback'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a video's playback customizations
      effect: read
      questions:
      - Is autoplay or mute turned on for a particular video?
      - Which player control buttons and quality limits are set on a video?
      instructions:
      - text: Show the playback customizations for video {media}.
        slots:
          media: path.mediaId
      - text: Check whether autoplay and looping are set on media {media}.
        slots:
          media: path.mediaId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{mediaId}/customizations/playback'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a video's playback settings
      effect: write
      questions:
      - Can I make one video autoplay muted?
      - Is it possible to cap the playback quality of a single video?
      - What happens at the end of a video, and can I change it per video?
      instructions:
      - text: Turn on autoplay for video {media}.
        slots:
          media: path.mediaId
      - text: Set the end-of-video behavior on media {media} to {behavior}.
        slots:
          media: path.mediaId
          behavior: requestBody.endVideoBehavior
      - text: Limit video {media} to a maximum quality of {quality_max}.
        slots:
          media: path.mediaId
          quality_max: requestBody.qualityMax
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{mediaId}/customizations/thumbnail'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a video's thumbnail customizations
      effect: read
      questions:
      - Which still image and alt text is a video using as its thumbnail?
      - Does a video have a looping thumbnail or text overlay configured?
      instructions:
      - text: Show the thumbnail customizations on video {media}.
        slots:
          media: path.mediaId
      - text: Get the thumbnail alt text and still image for media {media}.
        slots:
          media: path.mediaId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{mediaId}/customizations/thumbnail'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a video's thumbnail
      effect: write
      questions:
      - Can I set a custom still image as a video's thumbnail?
      - How do I add alt text to a video thumbnail for screen readers?
      instructions:
      - text: Use image {still_url} as the thumbnail for video {media}.
        slots:
          still_url: requestBody.stillUrl
          media: path.mediaId
      - text: Set the thumbnail alt text on media {media} to {alt_text}.
        slots:
          media: path.mediaId
          alt_text: requestBody.thumbnailAltText
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{mediaId}/customizations/accessibility'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a video's accessibility customizations
      effect: read
      questions:
      - What styling do the captions use on one of my videos?
      - Is the transcript or audio description turned on for a video?
      instructions:
      - text: Show the accessibility customizations for video {media}.
        slots:
          media: path.mediaId
      - text: Get the caption styling and transcript settings on media {media}.
        slots:
          media: path.mediaId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{mediaId}/customizations/accessibility'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a video's caption and transcript display
      effect: write
      questions:
      - Can I change the caption font, size and colors on a video?
      - Is it possible to show the transcript with speaker names under a video?
      instructions:
      - text: Set the caption text color on video {media} to {text_color}.
        slots:
          media: path.mediaId
          text_color: requestBody.captionsTextColor
      - text: Change the caption font on media {media} to {font}.
        slots:
          media: path.mediaId
          font: requestBody.captionsFontFamily
      - text: Turn on the transcript for video {media}.
        slots:
          media: path.mediaId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{mediaId}/customizations/chapters'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a video's chapters
      effect: read
      questions:
      - What chapters are defined on a video?
      - Are chapters visible to viewers on one of my videos?
      instructions:
      - text: List the chapters configured on video {media}.
        slots:
          media: path.mediaId
      - text: Show the chapter customizations for media {media}.
        slots:
          media: path.mediaId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{mediaId}/customizations/chapters'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a video's chapters
      effect: write
      questions:
      - Can I add or rename chapters on a video?
      - Is there a way to hide the chapter list on a video?
      instructions:
      - text: Update the chapters on video {media} with {chapters}.
        slots:
          media: path.mediaId
          chapters: requestBody.plugin
      - text: Hide the chapter list on media {media}.
        slots:
          media: path.mediaId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{mediaId}/customizations/engagement'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a video's calls to action and annotations
      effect: read
      questions:
      - What call to action appears at the end of a video?
      - Which timed annotation links are set on one of my videos?
      instructions:
      - text: Show the engagement customizations on video {media}.
        slots:
          media: path.mediaId
      - text: Get the call to action and annotation links for media {media}.
        slots:
          media: path.mediaId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{mediaId}/customizations/engagement'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a video's call to action and annotations
      effect: write
      questions:
      - Can I add a call to action when a viewer pauses a video?
      - How do I put a timed annotation link on a video?
      instructions:
      - text: Set the end-of-video call to action on video {media} using {cta}.
        slots:
          media: path.mediaId
          cta: requestBody.plugin
      - text: Add a timed annotation link to media {media}.
        slots:
          media: path.mediaId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{mediaId}/customizations/related_media'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a video's related media settings
      effect: read
      questions:
      - Which videos does a video recommend when it ends?
      - What label and button text does the discover-more panel use on a video?
      instructions:
      - text: Show the related media customizations for video {media}.
        slots:
          media: path.mediaId
      - text: Get the recommended videos configured on media {media}.
        slots:
          media: path.mediaId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{mediaId}/customizations/related_media'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a video's recommended videos
      effect: write
      questions:
      - Can I choose which videos get recommended after one of mine finishes?
      - Is it possible to change when the discover-more panel appears?
      instructions:
      - text: Update the related media on video {media} with {related}.
        slots:
          media: path.mediaId
          related: requestBody.plugin
      - text: Change the recommended videos shown after media {media}.
        slots:
          media: path.mediaId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{mediaId}/customizations/sharing'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a video's share bar settings
      effect: read
      questions:
      - Which social channels are enabled on a video's share bar?
      - Does a video allow downloads from its share options?
      instructions:
      - text: Show the sharing customizations for video {media}.
        slots:
          media: path.mediaId
      - text: Get the share bar channels and tweet text on media {media}.
        slots:
          media: path.mediaId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{mediaId}/customizations/sharing'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a video's share bar
      effect: write
      questions:
      - Can I let viewers download a video from its share bar?
      - What tweet text gets used when someone shares a video, and can I change it?
      instructions:
      - text: Update the share bar on video {media} with {sharing}.
        slots:
          media: path.mediaId
          sharing: requestBody.plugin
      - text: Enable social sharing on media {media}.
        slots:
          media: path.mediaId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{mediaId}/customizations/lead_capture'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a video's lead capture forms
      effect: read
      questions:
      - Is an email gate or form set up on a video?
      - Which marketing form is attached to one of my videos?
      instructions:
      - text: Show the lead capture customizations for video {media}.
        slots:
          media: path.mediaId
      - text: Get the form embeds configured on media {media}.
        slots:
          media: path.mediaId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{mediaId}/customizations/lead_capture'].put
  update:
    x-apievangelist-phrasing:
      intent: Set up lead capture on a video
      effect: write
      questions:
      - Can I require an email before someone watches a video?
      - Is it possible to attach a marketing automation form to a single video?
      instructions:
      - text: Enable the {provider} lead capture form on video {media}.
        slots:
          provider: requestBody.provider
          media: path.mediaId
      - text: Turn off lead capture provider {provider} on media {media}.
        slots:
          provider: requestBody.provider
          media: path.mediaId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{mediaId}/customizations/access'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a video's password protection
      effect: read
      questions:
      - Is a particular video password protected?
      - What password is stored on one of my protected videos?
      instructions:
      - text: Show the access customizations for video {media}.
        slots:
          media: path.mediaId
      - text: Get the password protection settings on media {media}.
        slots:
          media: path.mediaId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{mediaId}/customizations/access'].put
  update:
    x-apievangelist-phrasing:
      intent: Password-protect a video
      effect: write
      questions:
      - Can I put a password on a single video?
      - Is it possible to make a video private and encrypted?
      instructions:
      - text: Password-protect video {media} with {password_settings}.
        slots:
          media: path.mediaId
          password_settings: requestBody.plugin
      - text: Make media {media} private.
        slots:
          media: path.mediaId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{hashedId}/customizations'].get
  update:
    x-apievangelist-phrasing:
      intent: Show customizations via the legacy route
      effect: read
      questions:
      - Does the older hashed-ID customizations route still return a video's full player setup?
      - Which legacy endpoint reads every customization on a video by hashed ID?
      instructions:
      - text: Read all customizations for video {media} using the legacy hashedId route.
        slots:
          media: path.hashedId
      - text: Fetch the legacy customizations record for hashed ID {media}.
        slots:
          media: path.hashedId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{hashedId}/customizations'].put
  update:
    x-apievangelist-phrasing:
      intent: Patch customizations via the legacy route
      effect: write
      questions:
      - Can the legacy hashed-ID route still patch a video's customizations?
      - Which older endpoint partially updates customizations by hashed ID?
      instructions:
      - text: Patch customizations on video {media} through the legacy hashedId route.
        slots:
          media: path.hashedId
      - text: Send a partial customization change for hashed ID {media} to the older update endpoint.
        slots:
          media: path.hashedId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{hashedId}/customizations'].post
  update:
    x-apievangelist-phrasing:
      intent: Replace customizations via the legacy route
      effect: write
      questions:
      - Does the legacy hashed-ID route let me replace all of a video's customizations?
      - Which older endpoint creates a full customization set by hashed ID?
      instructions:
      - text: Replace every customization on video {media} through the legacy create route.
        slots:
          media: path.hashedId
      - text: Post a complete customization set for hashed ID {media} to the older create endpoint.
        slots:
          media: path.hashedId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/medias/{hashedId}/customizations'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear customizations via the legacy route
      effect: destructive
      questions:
      - Can the legacy hashed-ID route wipe a video's customizations?
      - Which older endpoint clears customizations from a video by hashed ID?
      instructions:
      - text: Wipe all customizations from video {media} via the legacy hashedId route.
        slots:
          media: path.hashedId
      - text: Clear hashed ID {media} back to defaults with the older delete endpoint.
        slots:
          media: path.hashedId
      method: generated
      generated: '2026-10-01'