Cvent Registration · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cvent REST Video API

8 actions 8 updates phrasing extends openapi/cvent-registration-video-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Cvent Registration's API. It is a proposal applied on top of the contract, not a document Cvent Registration publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info

$.paths['/videos'].get

$.paths['/videos/views'].get

$.paths['/videos/{videoId}/audio-tracks'].get

$.paths['/videos/{videoId}/renditions'].get

$.paths['/videos/{videoId}/text-tracks'].get

$.paths['/videos/{videoId}/text-tracks'].post

$.paths['/videos/{videoId}/text-tracks/{textTrackId}'].put

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 Video API
  version: 1.0.0
extends: openapi/cvent-registration-video-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: 7
- target: $.paths['/videos'].get
  update:
    x-apievangelist-phrasing:
      intent: List videos in the account or event
      effect: read
      questions:
      - What videos are in my Cvent account?
      - Can I include deleted videos when listing them?
      instructions:
      - text: List videos matching {filter}.
        slots:
          filter: query.filter
      - text: Show videos added after {after}, including deleted ones set to {deleted}.
        slots:
          after: query.after
          deleted: query.deleted
      method: generated
      generated: '2026-09-26'
- target: $.paths['/videos/views'].get
  update:
    x-apievangelist-phrasing:
      intent: List video views
      effect: read
      questions:
      - Who has watched our event videos?
      - Can I get video views recorded within a date range?
      instructions:
      - text: List video views since {after}.
        slots:
          after: query.after
      - text: Show video views matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/videos/{videoId}/audio-tracks'].get
  update:
    x-apievangelist-phrasing:
      intent: List a video's audio tracks
      effect: read
      questions:
      - Which audio tracks or language dubs does a video have?
      - Can I see the audio tracks for one video?
      instructions:
      - text: List audio tracks for video {videoId}.
        slots:
          videoId: path.videoId
      - text: Show the available audio languages on video {videoId}.
        slots:
          videoId: path.videoId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/videos/{videoId}/renditions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a video's renditions
      effect: read
      questions:
      - What resolutions or renditions exist for a video?
      - Can I get the encoded versions of a video?
      instructions:
      - text: List renditions of video {videoId}.
        slots:
          videoId: path.videoId
      - text: Show the encoded quality versions available for video {videoId}.
        slots:
          videoId: path.videoId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/videos/{videoId}/text-tracks'].get
  update:
    x-apievangelist-phrasing:
      intent: List a video's captions and subtitles
      effect: read
      questions:
      - Does a video already have captions or subtitles?
      - Which text tracks are attached to a video?
      instructions:
      - text: List text tracks for video {videoId}.
        slots:
          videoId: path.videoId
      - text: Show the caption and subtitle tracks on video {videoId}.
        slots:
          videoId: path.videoId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/videos/{videoId}/text-tracks'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a caption track to a video
      effect: write
      questions:
      - How do I add a VTT caption file to a video?
      - Does creating a text track give me an upload URL for the VTT file?
      instructions:
      - text: Create a {language} {kind} text track on video {videoId}.
        slots:
          language: requestBody.language
          kind: requestBody.kind
          videoId: path.videoId
      - text: Add a new {language} caption track labeled {label} to video {videoId} and get its upload link.
        slots:
          language: requestBody.language
          label: requestBody.label
          videoId: path.videoId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/videos/{videoId}/text-tracks/{textTrackId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update or replace a video's text track
      effect: write
      questions:
      - Can I replace the VTT file on an existing caption track?
      - How do I publish or relabel a text track that already exists?
      instructions:
      - text: Set text track {textTrackId} on video {videoId} to status {status} to get a new upload link.
        slots:
          textTrackId: path.textTrackId
          videoId: path.videoId
          status: requestBody.status
      - text: Relabel existing text track {textTrackId} on video {videoId} as {label}.
        slots:
          textTrackId: path.textTrackId
          videoId: path.videoId
          label: requestBody.label
      method: generated
      generated: '2026-09-26'