API Evangelist conversational phrasing for Cvent Registration Sessions API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cvent Registration Sessions API
  version: 1.0.0
extends: openapi/cvent-registration-sessions-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: 30
- target: $.paths['/ea/events/{eventId}/sessions'].get
  update:
    x-apievangelist-phrasing:
      intent: List the sessions of one event
      effect: read
      questions:
      - What sessions are on the agenda of one specific event?
      - How do I get only a single event's sessions by its event ID?
      instructions:
      - text: List the sessions of event {eventId}.
        slots:
          eventId: path.eventId
      - text: Show the agenda sessions for event {eventId} only.
        slots:
          eventId: path.eventId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/events/{id}/session-locations'].get
  update:
    x-apievangelist-phrasing:
      intent: List an event's session locations
      effect: read
      questions:
      - Which rooms or session locations are set up for my Cvent event?
      - Where can I see every session location defined for one event?
      instructions:
      - text: List the session locations for event {id}.
        slots:
          id: path.id
      - text: Show the first {limit} session locations configured in event {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}/session-locations'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a session location to an event
      effect: write
      questions:
      - How do I add a new room as a session location for an event?
      - Does a new session location need both a code and a name?
      instructions:
      - text: Add session location {name} with code {code} to event {id}.
        slots:
          name: requestBody.name
          code: requestBody.code
          id: path.id
      - text: Create a room called {name} for sessions in event {id}, code {code}.
        slots:
          name: requestBody.name
          id: path.id
          code: requestBody.code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/program-items'].get
  update:
    x-apievangelist-phrasing:
      intent: List session program items
      effect: read
      questions:
      - What talks, workshops and panels are scheduled as program items inside my sessions?
      - Can I filter session program items with a short query-string filter?
      instructions:
      - text: List session program items.
      - text: List program items matching filter {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/program-items'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a program item within a session
      effect: write
      questions:
      - How do I add a talk or panel as a program item inside a session?
      - Is there a cap on how many program items one session can hold?
      instructions:
      - text: Create program item {name} in session {session} of event {event}.
        slots:
          name: requestBody.name
          session: requestBody.session
          event: requestBody.event
      - text: Add a {duration} program item named {name} to session {session} for event {event}.
        slots:
          duration: requestBody.duration
          name: requestBody.name
          session: requestBody.session
          event: requestBody.event
      method: generated
      generated: '2026-09-26'
- target: $.paths['/program-items/docs/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Filter documents linked to program items
      effect: read
      questions:
      - Which documents are attached to session program items across my events?
      - Can I search program item documents with a filter sent in the request body?
      instructions:
      - text: Find program item documents matching filter {filter}.
        slots:
          filter: requestBody.filter
      - text: List every document linked to any session program item.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/program-items/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Search program items with a long filter
      effect: read
      questions:
      - My program item filter is too long for the URL; is there a POST version?
      - Can I get session program items back in a specific locale while filtering?
      instructions:
      - text: Search program items with the body filter {filter}.
        slots:
          filter: requestBody.filter
      - text: Search program items using body filter {filter} and return them in locale {locale}.
        slots:
          filter: requestBody.filter
          locale: query.locale
      method: generated
      generated: '2026-09-26'
- target: $.paths['/program-items/{programItemId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a session program item
      effect: write
      questions:
      - How do I rename or change the duration of an existing program item?
      - Can I edit the description of a talk that is already in a session's program?
      instructions:
      - text: Rename program item {programItemId} to {name}.
        slots:
          programItemId: path.programItemId
          name: requestBody.name
      - text: Change the duration of program item {programItemId} to {duration}.
        slots:
          programItemId: path.programItemId
          duration: requestBody.duration
      method: generated
      generated: '2026-09-26'
- target: $.paths['/program-items/{programItemId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a session program item
      effect: destructive
      questions:
      - How do I remove a talk or workshop from a session's program?
      - What happens when I delete a program item from a session?
      instructions:
      - text: Delete program item {programItemId}.
        slots:
          programItemId: path.programItemId
      - text: Remove program item {programItemId} from its session schedule.
        slots:
          programItemId: path.programItemId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/program-items/{programItemId}/docs'].get
  update:
    x-apievangelist-phrasing:
      intent: List one program item's documents (deprecated)
      effect: read
      questions:
      - What documents are linked to one specific program item, using the older deprecated endpoint?
      - Is the per-program-item documents list still supported or deprecated?
      instructions:
      - text: Use the deprecated endpoint to list documents for program item {programItemId}.
        slots:
          programItemId: path.programItemId
      - text: Show all session documents attached to program item {programItemId}.
        slots:
          programItemId: path.programItemId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/program-items/{programItemId}/docs/{fileId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a program item's document link
      effect: read
      questions:
      - Is a particular file linked to a particular program item?
      - How do I check one program item to document relationship?
      instructions:
      - text: Get the link between program item {programItemId} and document {fileId}.
        slots:
          programItemId: path.programItemId
          fileId: path.fileId
      - text: Check whether document {fileId} is attached to program item {programItemId}.
        slots:
          fileId: path.fileId
          programItemId: path.programItemId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/program-items/{programItemId}/docs/{fileId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Attach a session document to a program item
      effect: write
      questions:
      - How do I attach a slide deck to a specific program item?
      - How many session documents can one program item have?
      instructions:
      - text: Attach document {fileId} to program item {programItemId}.
        slots:
          fileId: path.fileId
          programItemId: path.programItemId
      - text: Link session document {fileId} to the talk with program item ID {programItemId}.
        slots:
          fileId: path.fileId
          programItemId: path.programItemId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/program-items/{programItemId}/docs/{fileId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Detach a document from a program item
      effect: destructive
      questions:
      - How do I unlink a document from a program item without deleting it from the session?
      - Can I remove a handout from just one talk in a session?
      instructions:
      - text: Detach document {fileId} from program item {programItemId}.
        slots:
          fileId: path.fileId
          programItemId: path.programItemId
      - text: Remove the link between program item {programItemId} and file {fileId}.
        slots:
          programItemId: path.programItemId
          fileId: path.fileId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/session-categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List session categories
      effect: read
      questions:
      - What session categories exist for grouping my event sessions?
      - Can I sort the list of session categories?
      instructions:
      - text: List all session categories.
      - text: List session categories sorted by {sort}.
        slots:
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/session-categories'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a session category
      effect: write
      questions:
      - How do I add a new category like Keynotes or Breakouts for sessions?
      - Can a session category have a description as well as a name?
      instructions:
      - text: Create a session category named {name}.
        slots:
          name: requestBody.name
      - text: Add session category {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/session-segments'].get
  update:
    x-apievangelist-phrasing:
      intent: List session and audience segment links
      effect: read
      questions:
      - Which sessions are targeted at which audience segments?
      - Can I see the associations between sessions and audience segments?
      instructions:
      - text: List session to audience segment associations.
      - text: Show session segment associations matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions'].get
  update:
    x-apievangelist-phrasing:
      intent: List sessions
      effect: read
      questions:
      - What sessions are on the agenda across my Cvent events?
      - Can I list sessions changed within a date range and sorted?
      instructions:
      - text: List sessions matching filter {filter}.
        slots:
          filter: query.filter
      - text: List sessions modified after {after}, sorted by {sort}.
        slots:
          after: query.after
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a session in an event
      effect: write
      questions:
      - How do I add a new session to my event agenda?
      - Can I turn on a waitlist and set capacity when creating a session?
      instructions:
      - text: Create session {title} in event {event} from {start} to {end} with status {status}.
        slots:
          title: requestBody.title
          event: requestBody.event
          start: requestBody.start
          end: requestBody.end
          status: requestBody.status
      - text: Add a new session {title} to event {event} with capacity {capacity}, running {start} to {end}, status {status}.
        slots:
          title: requestBody.title
          event: requestBody.event
          capacity: requestBody.capacity
          start: requestBody.start
          end: requestBody.end
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Search sessions with a long filter
      effect: read
      questions:
      - Is there a way to search sessions when my filter is too long for a query string?
      - Can I send a session filter in the request body instead of the URL?
      instructions:
      - text: Search sessions using body filter {filter}.
        slots:
          filter: requestBody.filter
      - text: Search sessions with body filter {filter} in locale {locale}.
        slots:
          filter: requestBody.filter
          locale: query.locale
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a session's details
      effect: read
      questions:
      - How do I look up the full details of one session by its ID?
      - What time, location and capacity does a particular session have?
      instructions:
      - text: Get session {id}.
        slots:
          id: path.id
      - text: Show the start time, location and capacity of session {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a session
      effect: write
      questions:
      - How do I reschedule or retitle an existing session?
      - Can I change a session's capacity after it's been created?
      instructions:
      - text: Reschedule session {id} to run from {start} to {end}.
        slots:
          id: path.id
          start: requestBody.start
          end: requestBody.end
      - text: Rename existing session {id} to {title}.
        slots:
          id: path.id
          title: requestBody.title
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a session
      effect: destructive
      questions:
      - How do I remove a session from my event entirely?
      - Can I delete a session by its ID?
      instructions:
      - text: Delete session {id}.
        slots:
          id: path.id
      - text: Remove session {id} from the event agenda.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/{id}/custom-fields/{customFieldId}/answers'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a session's custom field answer
      effect: write
      questions:
      - How do I fill in a custom field answer on a session?
      - Can I update just one custom field value for one session?
      instructions:
      - text: Set custom field {customFieldId} on session {id} to {value}.
        slots:
          customFieldId: path.customFieldId
          id: path.id
          value: requestBody.value
      - text: Update the session {id} answer for custom field {customFieldId}.
        slots:
          id: path.id
          customFieldId: path.customFieldId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/{id}/docs'].get
  update:
    x-apievangelist-phrasing:
      intent: List a session's documents
      effect: read
      questions:
      - What documents and handouts are attached to a session?
      - Where do I get the document URLs for one session?
      instructions:
      - text: List the documents attached to session {id}.
        slots:
          id: path.id
      - text: Get document URLs for session {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/{id}/docs/{fileId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one document on a session
      effect: read
      questions:
      - How do I fetch a specific document assigned to a session?
      - Is a given file attached to this session?
      instructions:
      - text: Get document {fileId} from session {id}.
        slots:
          fileId: path.fileId
          id: path.id
      - text: Show session {id}'s document {fileId}.
        slots:
          id: path.id
          fileId: path.fileId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/{id}/docs/{fileId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Attach an uploaded document to a session
      effect: write
      questions:
      - How do I attach an uploaded file to a session?
      - Do I need to upload a document before I can add it to a session?
      instructions:
      - text: Attach uploaded document {fileId} to session {id}.
        slots:
          fileId: path.fileId
          id: path.id
      - text: Add file {fileId} to session {id}'s documents.
        slots:
          fileId: path.fileId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/{id}/docs/{fileId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a document from a session
      effect: destructive
      questions:
      - How do I take a document off a session?
      - Can I disassociate a file from a session without touching other sessions?
      instructions:
      - text: Remove document {fileId} from session {id}.
        slots:
          fileId: path.fileId
          id: path.id
      - text: Disassociate file {fileId} from session {id}.
        slots:
          fileId: path.fileId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/{id}/speakers'].get
  update:
    x-apievangelist-phrasing:
      intent: List a session's speakers
      effect: read
      questions:
      - Who is speaking at a particular session?
      - Which speaker categories are assigned within one session?
      instructions:
      - text: List the speakers assigned to session {id}.
        slots:
          id: path.id
      - text: Show who presents at session {id} and their speaker categories.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/{id}/speakers/{speakerId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Assign a speaker to a session
      effect: write
      questions:
      - How do I assign a speaker to a session?
      - Can I set a speaker's category and display order when adding them to a session?
      instructions:
      - text: Assign speaker {speakerId} to session {id}.
        slots:
          speakerId: path.speakerId
          id: path.id
      - text: Add speaker {speakerId} to session {id} as speaker category {speakerCategory}.
        slots:
          speakerId: path.speakerId
          id: path.id
          speakerCategory: requestBody.speakerCategory
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/{id}/speakers/{speakerId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a speaker from a session
      effect: destructive
      questions:
      - How do I take a speaker off a session's lineup?
      - Can I unassign a speaker from one session but keep them in the event?
      instructions:
      - text: Remove speaker {speakerId} from session {id}.
        slots:
          speakerId: path.speakerId
          id: path.id
      - text: Unassign speaker {speakerId} from session {id}.
        slots:
          speakerId: path.speakerId
          id: path.id
      method: generated
      generated: '2026-09-26'