Wistia · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Wistia Webinars API

7 actions 7 updates phrasing extends openapi/wistia-webinars-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 7

$.info

$.paths['/webinars'].get

$.paths['/webinars'].post

$.paths['/webinars/{id}'].get

$.paths['/webinars/{id}'].put

$.paths['/webinars/{id}'].delete

$.paths['/webinars/{id}/registrations'].post

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 Wistia Webinars API
  version: 1.0.0
extends: openapi/wistia-webinars-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: 6
- target: $.paths['/webinars'].get
  update:
    x-apievangelist-phrasing:
      intent: List my webinars
      effect: read
      questions:
      - What webinars have I set up?
      - Can I list only the webinars that have already started?
      instructions:
      - text: List all my webinars.
      - text: Fetch webinars {hashed_ids} in one call.
        slots:
          hashed_ids: query.hashed_ids[]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webinars'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a new webinar
      effect: write
      questions:
      - Can I schedule a new webinar?
      - What do I need to provide to create a webinar, like its time zone and duration?
      instructions:
      - text: Schedule webinar {title} for {scheduled_for} lasting {duration} in {time_zone}.
        slots:
          title: requestBody.title
          scheduled_for: requestBody.scheduled_for
          duration: requestBody.event_duration
          time_zone: requestBody.time_zone
      - text: Create a webinar called {title} at {scheduled_for} ({time_zone}, {duration}) in folder {folder}.
        slots:
          title: requestBody.title
          scheduled_for: requestBody.scheduled_for
          time_zone: requestBody.time_zone
          duration: requestBody.event_duration
          folder: requestBody.folder_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webinars/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a webinar
      effect: read
      questions:
      - What are the details of one of my webinars?
      - When is a particular webinar scheduled for?
      instructions:
      - text: Show webinar {webinar}.
        slots:
          webinar: path.id
      - text: Get the schedule and details of webinar {webinar}.
        slots:
          webinar: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webinars/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a webinar
      effect: write
      questions:
      - Can I reschedule or retitle an existing webinar?
      - Is it possible to change a webinar's description after creating it?
      instructions:
      - text: Update webinar {webinar} with {changes}.
        slots:
          webinar: path.id
          changes: requestBody.webinar
      - text: Reschedule webinar {webinar}.
        slots:
          webinar: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webinars/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webinar
      effect: destructive
      questions:
      - Can I delete a webinar I no longer need?
      - Is there a way to remove an old webinar from my account?
      instructions:
      - text: Delete webinar {webinar}.
        slots:
          webinar: path.id
      - text: Remove webinar {webinar} from my account.
        slots:
          webinar: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webinars/{id}/registrations'].post
  update:
    x-apievangelist-phrasing:
      intent: Register someone for a webinar
      effect: write
      questions:
      - How do I sign someone up for one of my webinars?
      - Can I add a registrant to a webinar through the API?
      instructions:
      - text: Register an attendee for webinar {webinar}.
        slots:
          webinar: path.id
      - text: Sign up a new registrant for webinar {webinar}.
        slots:
          webinar: path.id
      method: generated
      generated: '2026-10-01'