Wistia · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Data Live Stream Events API

6 actions 6 updates phrasing extends openapi/wistia-live-stream-events-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['/live_stream_events'].get

$.paths['/live_stream_events'].post

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

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

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

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 Data Live Stream Events API
  version: 1.0.0
extends: openapi/wistia-live-stream-events-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['/live_stream_events'].get
  update:
    x-apievangelist-phrasing:
      intent: List live stream events
      effect: read
      questions:
      - What live stream events are set up in my account?
      - Can I list only the live events that have already started?
      instructions:
      - text: List my live stream events.
      - text: Show live events with started set to {started}.
        slots:
          started: query.started
      method: generated
      generated: '2026-10-01'
- target: $.paths['/live_stream_events'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a live stream event
      effect: write
      questions:
      - How do I schedule a new live stream event?
      - Do I get audience and host links when I create a live event?
      instructions:
      - text: Create a live event {title} scheduled for {scheduled_for} lasting {event_duration}.
        slots:
          title: requestBody.title
          scheduled_for: requestBody.scheduled_for
          event_duration: requestBody.event_duration
      - text: Schedule live stream {title} at {scheduled_for} for {event_duration} with description {description}.
        slots:
          title: requestBody.title
          scheduled_for: requestBody.scheduled_for
          event_duration: requestBody.event_duration
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/live_stream_events/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a live stream event
      effect: read
      questions:
      - How do I get the details of one live stream event?
      - Where can I find the host link for an existing live event?
      instructions:
      - text: Show live stream event {id}.
        slots:
          id: path.id
      - text: Get the details of live event {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/live_stream_events/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a live stream event
      effect: write
      questions:
      - How do I change the details of a live event I already scheduled?
      - Can I edit an existing live stream event?
      instructions:
      - text: Update live event {id} with {live_stream_event}.
        slots:
          id: path.id
          live_stream_event: requestBody.live_stream_event
      - text: Change the settings of live stream {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/live_stream_events/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a live stream event
      effect: destructive
      questions:
      - How do I cancel and delete a live stream event?
      - Can I remove a live event I no longer plan to run?
      instructions:
      - text: Delete live stream event {id}.
        slots:
          id: path.id
      - text: Cancel and remove live event {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'