# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cvent REST Webcasts API
  version: 1.0.0
extends: openapi/cvent-registration-webcasts-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 11
- target: $.paths['/webcasts'].get
  update:
    x-apievangelist-phrasing:
      intent: List webcasts
      effect: read
      questions:
      - What webcasts are set up for my Cvent events?
      - Can I filter webcasts by event or status?
      instructions:
      - text: List my webcasts.
      - text: List webcasts matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webcasts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a webcast for an event
      effect: write
      questions:
      - How do I create a webcast for a session in my event?
      - Can a new webcast record the live stream and add itself to the video library?
      instructions:
      - text: Create a webcast titled {title} for session {session} in event {event}.
        slots:
          title: requestBody.title
          session: requestBody.session
          event: requestBody.event
      - text: Set up webcast {title} for event {event} using provider {provider}.
        slots:
          title: requestBody.title
          event: requestBody.event
          provider: requestBody.provider
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webcasts/attendee-links'].get
  update:
    x-apievangelist-phrasing:
      intent: List attendee links across webcasts
      effect: read
      questions:
      - What personal webcast join links have been issued to attendees across all webcasts?
      - Can I search attendee webcast links account-wide with a filter?
      instructions:
      - text: List attendee links across all webcasts.
      - text: Find webcast attendee links account-wide matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webcasts/players'].get
  update:
    x-apievangelist-phrasing:
      intent: List webcast players
      effect: read
      questions:
      - Which video player details are associated with my webcasts?
      - Can I filter the webcast player list?
      instructions:
      - text: List webcast player details.
      - text: List webcast players matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webcasts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webcast
      effect: read
      questions:
      - What are the settings of one specific webcast?
      - Is a particular webcast set up as simulated live?
      instructions:
      - text: Get webcast {id}.
        slots:
          id: path.id
      - text: Show the format, provider and status of webcast {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webcasts/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a webcast
      effect: write
      questions:
      - How do I change the title or status of an existing webcast?
      - Can I switch an existing webcast to a different streaming provider?
      instructions:
      - text: Rename webcast {id} to {title}.
        slots:
          id: path.id
          title: requestBody.title
      - text: Set the status of existing webcast {id} to {status}.
        slots:
          id: path.id
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webcasts/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webcast
      effect: destructive
      questions:
      - How do I delete a webcast from an event?
      - Can I remove a webcast by its ID?
      instructions:
      - text: Delete webcast {id}.
        slots:
          id: path.id
      - text: Remove webcast {id} from the event.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webcasts/{id}/attendee-links'].get
  update:
    x-apievangelist-phrasing:
      intent: List attendee links for one webcast
      effect: read
      questions:
      - Which attendees have join links for one specific webcast?
      - Can I filter the attendee links of a single webcast?
      instructions:
      - text: List attendee links for webcast {id}.
        slots:
          id: path.id
      - text: List webcast {id}'s attendee links matching {filter}.
        slots:
          id: path.id
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webcasts/{id}/attendee-links'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk-update a webcast's attendee links
      effect: write
      questions:
      - How do I update many existing attendee links on a webcast at once?
      - Can I change attendee join links in bulk for one webcast?
      instructions:
      - text: Update the existing attendee links on webcast {id} in bulk.
        slots:
          id: path.id
      - text: Apply these changes to attendee links already on webcast {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webcasts/{id}/attendee-links'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk-create attendee links for a webcast
      effect: write
      questions:
      - How do I generate join links for attendees of a webcast?
      - Can I create many new attendee links for one webcast in a single request?
      instructions:
      - text: Create attendee links in bulk for webcast {id}.
        slots:
          id: path.id
      - text: Issue new join links for these attendees on webcast {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webcasts/{id}/attendee-links/{attendeeLinkId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webcast attendee link
      effect: destructive
      questions:
      - How do I revoke one attendee's join link for a webcast?
      - Can I delete a single attendee link from a webcast?
      instructions:
      - text: Delete attendee link {attendeeLinkId} from webcast {id}.
        slots:
          attendeeLinkId: path.attendeeLinkId
          id: path.id
      - text: Revoke join link {attendeeLinkId} on webcast {id}.
        slots:
          attendeeLinkId: path.attendeeLinkId
          id: path.id
      method: generated
      generated: '2026-09-26'