# 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-event-cloud-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?
      - Where can I see all the session locations defined for one 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:
      - Can I add a new room where sessions will take place at my event?
      - What do I need to register a session location, a code and 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 location {name} (code {code}) for sessions in event {event}.
        slots:
          name: requestBody.name
          code: requestBody.code
          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:
      - How do I see the talks, workshops and panels scheduled inside my sessions?
      - Can I filter the program items of a session with a query string?
      instructions:
      - text: List all session program items.
      - text: List program items matching the filter {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/program-items'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a program item to a session
      effect: write
      questions:
      - Can I add a talk or panel as part of a session's schedule?
      - What is required to create a program item, event, session and name?
      instructions:
      - text: Create a program item called {name} in session {session} of event {event}.
        slots:
          name: requestBody.name
          session: requestBody.session
          event: requestBody.event
      - text: Add a {duration}-minute program item {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 attached to program items
      effect: read
      questions:
      - Which documents are attached to my session program items?
      - Can I search program item documents with a long filter in the request body?
      instructions:
      - text: Find program item documents matching filter {filter}.
        slots:
          filter: requestBody.filter
      - text: List program item document links modified 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 body filter
      effect: read
      questions:
      - Is there a way to query session program items with a filter too long for the URL?
      - Can I get program items in a specific locale when searching by filter?
      instructions:
      - text: Search program items using the body filter {filter}.
        slots:
          filter: requestBody.filter
      - text: Search program items with 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:
      - Can I rename a talk or change its duration in a session's program?
      - How do I edit the description of an existing program item?
      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:
      - Can I remove a talk from a session's program?
      - What happens when I delete a program item from a session schedule?
      instructions:
      - text: Delete program item {programItemId}.
        slots:
          programItemId: path.programItemId
      - text: Remove the program item {programItemId} from its session.
        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 linked to a single program item, using the older deprecated endpoint?
      - Is the per-program-item documents lookup still supported or deprecated?
      instructions:
      - text: List the session documents for program item {programItemId} using the deprecated endpoint.
        slots:
          programItemId: path.programItemId
      - text: Get all 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 specific document linked to a given program item?
      - Can I look up one program item to document relationship by both IDs?
      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 document to a program item
      effect: write
      questions:
      - Can I attach a session document to a specific talk in the program?
      - How many 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} 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:
      - Can I unlink a document from a talk without deleting the document itself?
      - How do I remove a slide deck that was attached to a program item?
      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 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 in my Cvent 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:
      - Can I add a new category to group my sessions, like Keynote or Breakout?
      - What fields does a new session category take?
      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 filter the session to audience segment associations?
      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:
      - What sessions are on the agenda across my events?
      - Can I list sessions changed after a certain date?
      - Is it possible to sort sessions and get them in another language?
      instructions:
      - text: List sessions matching filter {filter}.
        slots:
          filter: query.filter
      - text: List sessions updated 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
      effect: write
      questions:
      - How do I add a new session to my event agenda?
      - Can I set a capacity and enable a waitlist when creating a session?
      - What is required to create a session, title, start, end and status?
      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 session {title} to event {event} with capacity {capacity}, starting {start} and ending {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 body filter
      effect: read
      questions:
      - Can I search sessions with a filter too long to fit in the query string?
      - Which endpoint lets me post a long session filter and page through results?
      instructions:
      - text: Search sessions using the body filter {filter}.
        slots:
          filter: requestBody.filter
      - text: Search sessions with filter {filter}, returning at most {limit} per page.
        slots:
          filter: requestBody.filter
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a session
      effect: read
      questions:
      - Can I pull the full details of one session by its ID?
      - What are the start time, capacity and status of a particular session?
      instructions:
      - text: Get session {session}.
        slots:
          session: path.id
      - text: Show me the details of session {session}.
        slots:
          session: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a session
      effect: write
      questions:
      - Can I move a session to a new time slot?
      - How do I change a session's title or capacity after it is created?
      instructions:
      - text: Reschedule session {session} to run from {start} to {end}.
        slots:
          session: path.id
          start: requestBody.start
          end: requestBody.end
      - text: Change the capacity of session {session} to {capacity}.
        slots:
          session: 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:
      - Can I remove a session from my event entirely?
      - Is deleting a session by ID permanent?
      instructions:
      - text: Delete session {session}.
        slots:
          session: path.id
      - text: Remove session {session} from the agenda.
        slots:
          session: 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:
      - Can I fill in a custom field value on a session?
      - How do I update the answer to one custom question for one session?
      instructions:
      - text: Set custom field {customFieldId} on session {session} to {value}.
        slots:
          customFieldId: path.customFieldId
          session: path.id
          value: requestBody.value
      - text: Update session {session}'s answer for custom field {customFieldId} to {value}.
        slots:
          session: path.id
          customFieldId: path.customFieldId
          value: requestBody.value
      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 handouts or files are attached to a session?
      - Where do I get document URLs for one session?
      instructions:
      - text: List the documents for session {session}.
        slots:
          session: path.id
      - text: Get document URLs attached to session {session}.
        slots:
          session: 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:
      - Can I retrieve a specific file that is assigned to a session?
      - Is a given document still assigned to a session?
      instructions:
      - text: Get document {fileId} from session {session}.
        slots:
          fileId: path.fileId
          session: path.id
      - text: Show document {fileId} as assigned to session {session}.
        slots:
          fileId: path.fileId
          session: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sessions/{id}/docs/{fileId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Attach a document to a session
      effect: write
      questions:
      - Can I attach an uploaded file to a session?
      - Do documents need to be uploaded before I link them to a session?
      instructions:
      - text: Attach uploaded document {fileId} to session {session}.
        slots:
          fileId: path.fileId
          session: path.id
      - text: Associate file {fileId} with session {session}.
        slots:
          fileId: path.fileId
          session: 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:
      - Can I take a handout off a session without deleting the upload?
      - How do I disassociate a document from a session?
      instructions:
      - text: Remove document {fileId} from session {session}.
        slots:
          fileId: path.fileId
          session: path.id
      - text: Disassociate file {fileId} from session {session}.
        slots:
          fileId: path.fileId
          session: 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?
      - Can I see the speaker categories assigned to a session's speakers?
      instructions:
      - text: List the speakers for session {session}.
        slots:
          session: path.id
      - text: Show who presents in session {session} and their speaker categories.
        slots:
          session: 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:
      - Can I add a speaker to a session and give them a speaker category?
      - How do I put a presenter on a session's lineup?
      instructions:
      - text: Assign speaker {speakerId} to session {session}.
        slots:
          speakerId: path.speakerId
          session: path.id
      - text: Add speaker {speakerId} to session {session} under speaker category {speakerCategory}.
        slots:
          speakerId: path.speakerId
          session: 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:
      - Can I take a speaker off a session they dropped out of?
      - Does removing a speaker from a session delete the speaker record?
      instructions:
      - text: Remove speaker {speakerId} from session {session}.
        slots:
          speakerId: path.speakerId
          session: path.id
      - text: Unassign speaker {speakerId} from session {session}.
        slots:
          speakerId: path.speakerId
          session: path.id
      method: generated
      generated: '2026-09-26'