Cvent · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Cvent REST Webcasts API
12 actions
12 updates
phrasing
extends
openapi/cvent-webcasts-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Cvent's API. It is a proposal applied on top of the contract, not a document Cvent publishes.
What the actions change
x-apievangelist-phrasing
Targets 12
$.info
$.paths['/webcasts'].get
$.paths['/webcasts'].post
$.paths['/webcasts/attendee-links'].get
$.paths['/webcasts/players'].get
$.paths['/webcasts/{id}'].get
$.paths['/webcasts/{id}'].put
$.paths['/webcasts/{id}'].delete
$.paths['/webcasts/{id}/attendee-links'].get
$.paths['/webcasts/{id}/attendee-links'].put
$.paths['/webcasts/{id}/attendee-links'].post
$.paths['/webcasts/{id}/attendee-links/{attendeeLinkId}'].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 Cvent REST Webcasts API
version: 1.0.0
extends: openapi/cvent-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 events?
- Can I list only webcasts updated since a certain date?
instructions:
- text: List all 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
effect: write
questions:
- How do I set up a live stream for a session in my event?
- Can a webcast be simulated live or recorded automatically?
instructions:
- text: Create a webcast titled {title} for session {session} in event {event}.
slots:
title: requestBody.title
session: requestBody.session
event: requestBody.event
- text: Create a {format} webcast {title} for event {event} using provider {provider}.
slots:
format: requestBody.format
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 all webcasts
effect: read
questions:
- How do I see every attendee's personal webcast join link across my account?
- Can I filter attendee links across all webcasts?
instructions:
- text: List attendee links across all webcasts.
- text: List attendee join 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 player details
effect: read
questions:
- Which video players are configured for my webcasts?
- Can I filter the webcast player details?
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:
- How do I check the settings and status of one webcast?
- What provider and format does a given webcast use?
instructions:
- text: Get webcast {id}.
slots:
id: path.id
- text: Show details 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 turn on live-stream recording for a webcast that's already set up?
instructions:
- text: Rename webcast {id} to {title}.
slots:
id: path.id
title: requestBody.title
- text: Set the status of 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?
- Can I remove a webcast I set up by mistake?
instructions:
- text: Delete webcast {id}.
slots:
id: path.id
- text: Remove webcast {id} permanently.
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:
- What join links have been issued for attendees of a specific webcast?
- Can I filter one webcast's attendee links?
instructions:
- text: List attendee links for webcast {id}.
slots:
id: path.id
- text: Show 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 change several existing attendee links for a webcast at once?
- Can I update attendee join links in bulk?
instructions:
- text: Bulk update the existing attendee links on webcast {id}.
slots:
id: path.id
- text: Update these attendee links for webcast {id} in one batch.
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 attendee links for a webcast in one request?
instructions:
- text: Create attendee links in bulk for webcast {id}.
slots:
id: path.id
- text: Generate new attendee join links 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 link to 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'