API Evangelist conversational phrasing for Cvent REST 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 REST Sessions API
  version: 1.0.0
extends: openapi/cvent-sessions-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: 29
- target: $.paths['/events/{id}/session-locations'].get
  update:
    x-apievangelist-phrasing:
      intent: List an event's session locations
      effect: read
      questions:
      - Which rooms or locations are set up for sessions at my event?
      - Can I page through the session locations defined for one Cvent event?
      instructions:
      - text: List the session locations for event {event}.
        slots:
          event: path.id
      - text: Show the first {limit} session locations configured in event {event}.
        slots:
          limit: query.limit
          event: 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 where sessions can be held at my event?
      - What do I need to supply to create a session location, besides a name?
      instructions:
      - text: Add a session location named {name} with code {code} to event {event}.
        slots:
          name: requestBody.name
          code: requestBody.code
          event: path.id
      - text: Create room {name} as a session location for event {event}.
        slots:
          name: requestBody.name
          event: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/program-items'].get
  update:
    x-apievangelist-phrasing:
      intent: List session program items
      effect: read
      questions:
      - Where can I see the talks, workshops and panels scheduled inside my sessions?
      - Can I filter session program items with a short query-string filter?
      instructions:
      - text: List all session program items.
      - text: List program items matching the query 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 to a session's schedule?
      - Can I set a duration when I create a session program item?
      instructions:
      - text: Add a program item called {name} to session {session} in event {event}.
        slots:
          name: requestBody.name
          session: requestBody.session
          event: requestBody.event
      - text: Create a {duration}-minute program item {name} in session {session} of 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: Search program item documents with a filter
      effect: read
      questions:
      - How can I find which documents are attached to session program items across my events?
      - Is there a way to filter program item documents by date changed?
      instructions:
      - text: Find program item documents matching body filter {filter}.
        slots:
          filter: requestBody.filter
      - text: Search program item documents updated after {after}.
        slots:
          after: query.after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/program-items/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Search program items with a long body filter
      effect: read
      questions:
      - My program item filter is too long for the URL — can I send it in the request body instead?
      - Can I get session program items back in a specific locale when filtering?
      instructions:
      - text: Search program items using the body filter {filter}.
        slots:
          filter: requestBody.filter
      - text: Filter program items with {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 length of a talk already in a session's program?
      - Can I move an existing program item to a different session?
      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} minutes.
        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 panel from a session's program entirely?
      - What happens when I delete a program item from a session?
      instructions:
      - text: Delete program item {programItemId}.
        slots:
          programItemId: path.programItemId
      - text: Remove session program item {programItemId} from the schedule.
        slots:
          programItemId: path.programItemId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/program-items/{programItemId}/docs'].get
  update:
    x-apievangelist-phrasing:
      intent: List documents for one program item (deprecated)
      effect: read
      questions:
      - Which session documents are attached to a particular program item?
      - Is the older endpoint for a program item's documents still usable even though it's deprecated?
      instructions:
      - text: List every document attached to program item {programItemId} using the deprecated endpoint.
        slots:
          programItemId: path.programItemId
      - text: Show all session documents linked 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 one program item document link
      effect: read
      questions:
      - How do I check whether a specific document is linked to a program item?
      - Can I look up a single program item and session document relationship by their IDs?
      instructions:
      - text: Get the link between program item {programItemId} and document {fileId}.
        slots:
          programItemId: path.programItemId
          fileId: path.fileId
      - text: Check if 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 session document to a specific talk in the program?
      - How many documents can one session program item have?
      instructions:
      - text: Attach document {fileId} to program item {programItemId}.
        slots:
          fileId: path.fileId
          programItemId: path.programItemId
      - text: Link session document {fileId} with program item {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 session program item without deleting the file?
      - Can I remove just one document from a talk's attachments?
      instructions:
      - text: Detach document {fileId} from program item {programItemId}.
        slots:
          fileId: path.fileId
          programItemId: path.programItemId
      - text: Remove the relationship between program item {programItemId} and document {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 in my account?
      - 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 for grouping sessions like keynotes or breakouts?
      - Can a session category have a description?
      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 audience segments are tied to which sessions?
      - Can I see the session-to-segment associations for targeting agenda content?
      instructions:
      - text: List all session and 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:
      - How do I pull every session across my events?
      - Can I get only sessions changed since a certain date?
      instructions:
      - text: List all sessions.
      - text: List sessions updated after {after}, sorted by {sort}.
        slots:
          after: query.after
          sort: query.sort
      - text: List sessions matching the query filter {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a session
      effect: write
      questions:
      - How do I add a new session to an event's agenda?
      - Can I turn on a waitlist and set capacity when I create a session?
      - Which fields are required to create a Cvent 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 body filter
      effect: read
      questions:
      - My session filter is too long for a query string — can I post it in the body?
      - Can I search sessions with a complex filter and a chosen locale?
      instructions:
      - text: Search sessions using the body filter {filter}.
        slots:
          filter: requestBody.filter
      - text: Find sessions matching 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
      effect: read
      questions:
      - How do I look up the details of one session by its ID?
      - What time and capacity does a particular session have?
      instructions:
      - text: Get session {id}.
        slots:
          id: path.id
      - text: Show me the details 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 change the time or title of an existing session?
      - Can I raise the capacity of a session that's already published?
      instructions:
      - text: Change session {id} to run from {start} to {end}.
        slots:
          id: path.id
          start: requestBody.start
          end: requestBody.end
      - text: Rename session {id} to {title}.
        slots:
          id: path.id
          title: requestBody.title
      - text: Set the capacity of session {id} to {capacity}.
        slots:
          id: path.id
          capacity: requestBody.capacity
      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 delete a session from an event?
      - Can I permanently remove a cancelled session?
      instructions:
      - text: Delete session {id}.
        slots:
          id: path.id
      - text: Remove session {id} from the agenda permanently.
        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 value on a session?
      - Can I update the answer to one custom question for a single session?
      instructions:
      - text: Set custom field {customFieldId} on session {id} to {value}.
        slots:
          customFieldId: path.customFieldId
          id: path.id
          value: requestBody.value
      - text: Update session {id}'s 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 are attached to a session?
      - Can I get download URLs for a session's handouts?
      instructions:
      - text: List the documents for session {id}.
        slots:
          id: path.id
      - text: Show document URLs attached to 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?
      - Can I get one handout from a session by its file ID?
      instructions:
      - text: Get document {fileId} from session {id}.
        slots:
          fileId: path.fileId
          id: path.id
      - text: Fetch session {id}'s attached file {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 a slide deck I've uploaded to a session?
      - Does a document need to be uploaded before it can be added to a session?
      instructions:
      - text: Attach uploaded file {fileId} to session {id}.
        slots:
          fileId: path.fileId
          id: path.id
      - text: Add document {fileId} to session {id}'s materials.
        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 handout off a session?
      - Can I disassociate a document 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 speakers assigned to a session
      effect: read
      questions:
      - Who is speaking in a particular session?
      - Can I see the speaker categories for everyone on a session?
      instructions:
      - text: List the speakers assigned to session {id}.
        slots:
          id: path.id
      - text: Show who is presenting in session {id}.
        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 put a speaker on a session?
      - Can I set the speaker's category and display order when assigning 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 {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 they're no longer presenting?
      - Can I unassign one speaker from a session without deleting the speaker?
      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'