API Evangelist conversational phrasing for Cvent REST Speakers 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 Speakers API
  version: 1.0.0
extends: openapi/cvent-speakers-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: 19
- target: $.paths['/program-items/speakers'].get
  update:
    x-apievangelist-phrasing:
      intent: List program item and speaker links
      effect: read
      questions:
      - Which speakers are assigned to which talks inside sessions?
      - Can I filter the program item speaker assignments with a query filter?
      instructions:
      - text: List all session program item speaker assignments.
      - text: List program item speaker links matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/program-items/speakers/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Search program item speakers with a body filter
      effect: read
      questions:
      - My filter for program item speakers is long — can I send it in the request body?
      - Can I search program item speaker assignments in a given locale?
      instructions:
      - text: Search program item speaker assignments using body filter {filter}.
        slots:
          filter: requestBody.filter
      - text: Find program speakers matching body filter {filter} in locale {locale}.
        slots:
          filter: requestBody.filter
          locale: query.locale
      method: generated
      generated: '2026-09-26'
- target: $.paths['/program-items/{programItemId}/speakers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one program item speaker link
      effect: read
      questions:
      - How do I check whether a speaker is on a particular program item?
      - Can I look up a single speaker's assignment to a talk?
      instructions:
      - text: Get the assignment of speaker {id} to program item {programItemId}.
        slots:
          id: path.id
          programItemId: path.programItemId
      - text: Check if speaker {id} is linked to program item {programItemId}.
        slots:
          id: path.id
          programItemId: path.programItemId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/program-items/{programItemId}/speakers/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Add a speaker to a program item
      effect: write
      questions:
      - How do I assign a speaker to a specific talk within a session?
      - How many speakers can one session program item have?
      instructions:
      - text: Add speaker {id} to program item {programItemId}.
        slots:
          id: path.id
          programItemId: path.programItemId
      - text: Put speaker {id} on the talk {programItemId}.
        slots:
          id: path.id
          programItemId: path.programItemId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/program-items/{programItemId}/speakers/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a speaker from a program item
      effect: destructive
      questions:
      - How do I take a speaker off one talk without removing them from the whole session?
      - Can I delete a program item's speaker link?
      instructions:
      - text: Remove speaker {id} from program item {programItemId}.
        slots:
          id: path.id
          programItemId: path.programItemId
      - text: Unlink speaker {id} from talk {programItemId}.
        slots:
          id: path.id
          programItemId: path.programItemId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/speaker-categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List speaker categories
      effect: read
      questions:
      - What speaker categories like keynote or panelist are set up?
      - Can I sort speaker categories by name?
      instructions:
      - text: List all speaker categories.
      - text: List speaker categories sorted by {sort}.
        slots:
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/speaker-categories'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a speaker category
      effect: write
      questions:
      - How do I add a new speaker category such as moderator?
      - Can I create my own labels for grouping speakers?
      instructions:
      - text: Create a speaker category named {name}.
        slots:
          name: requestBody.name
      - text: Add {name} as a new speaker category.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/speakers'].get
  update:
    x-apievangelist-phrasing:
      intent: List speakers
      effect: read
      questions:
      - How do I get all the speakers across my events?
      - Can I list speakers sorted by last name?
      instructions:
      - text: List all speakers.
      - text: List speakers matching the query filter {filter}.
        slots:
          filter: query.filter
      - text: List speakers sorted by {sort}.
        slots:
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/speakers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a speaker
      effect: write
      questions:
      - How do I add a new speaker to an event?
      - Can I include a biography and company when creating a speaker?
      instructions:
      - text: Create speaker {firstName} {lastName} for event {event}.
        slots:
          firstName: requestBody.firstName
          lastName: requestBody.lastName
          event: requestBody.event
      - text: Add speaker {firstName} {lastName} from {company} with email {email} to event {event}.
        slots:
          firstName: requestBody.firstName
          lastName: requestBody.lastName
          company: requestBody.company
          email: requestBody.email
          event: requestBody.event
      method: generated
      generated: '2026-09-26'
- target: $.paths['/speakers/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Search speakers with a long body filter
      effect: read
      questions:
      - My speaker filter is too long for the query string — can I post it instead?
      - Can I search speakers with a complex filter and sort the results?
      instructions:
      - text: Search speakers using the body filter {filter}.
        slots:
          filter: requestBody.filter
      - text: Find speakers matching body filter {filter}, sorted by {sort}.
        slots:
          filter: requestBody.filter
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/speakers/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a speaker
      effect: write
      questions:
      - How do I edit a speaker's bio or job title?
      - Can I mark an existing speaker as featured?
      instructions:
      - text: Update the biography of speaker {id} to {biography}.
        slots:
          id: path.id
          biography: requestBody.biography
      - text: Change speaker {id}'s title to {title}.
        slots:
          id: path.id
          title: requestBody.title
      - text: 'Mark speaker {id} as featured: {featured}.'
        slots:
          id: path.id
          featured: requestBody.featured
      method: generated
      generated: '2026-09-26'
- target: $.paths['/speakers/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a speaker
      effect: destructive
      questions:
      - How do I delete a speaker who dropped out?
      - Can I permanently remove a speaker record from an event?
      instructions:
      - text: Delete speaker {id}.
        slots:
          id: path.id
      - text: Remove speaker {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/speakers/{id}/docs'].get
  update:
    x-apievangelist-phrasing:
      intent: List a speaker's documents
      effect: read
      questions:
      - What documents are attached to a speaker, like their headshot or slides?
      - Can I get the document URLs for one speaker?
      instructions:
      - text: List the documents for speaker {id}.
        slots:
          id: path.id
      - text: Show document URLs attached to speaker {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/speakers/{id}/docs/{fileId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one document on a speaker
      effect: read
      questions:
      - How do I retrieve a specific file assigned to a speaker?
      - Can I fetch one of a speaker's documents by its file ID?
      instructions:
      - text: Get document {fileId} for speaker {id}.
        slots:
          fileId: path.fileId
          id: path.id
      - text: Fetch speaker {id}'s file {fileId}.
        slots:
          id: path.id
          fileId: path.fileId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/speakers/{id}/docs/{fileId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Attach an uploaded document to a speaker
      effect: write
      questions:
      - How do I attach an uploaded file to a speaker's profile?
      - Does a speaker document need to be uploaded before I add it?
      instructions:
      - text: Attach uploaded file {fileId} to speaker {id}.
        slots:
          fileId: path.fileId
          id: path.id
      - text: Add document {fileId} to speaker {id}'s materials.
        slots:
          fileId: path.fileId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/speakers/{id}/docs/{fileId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a document from a speaker
      effect: destructive
      questions:
      - How do I remove a file from a speaker's profile?
      - Can I delete one speaker document by its upload ID?
      instructions:
      - text: Remove document {fileId} from speaker {id}.
        slots:
          fileId: path.fileId
          id: path.id
      - text: Delete speaker {id}'s file {fileId}.
        slots:
          id: path.id
          fileId: path.fileId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/speakers/{id}/profile-images'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a speaker's profile picture
      effect: write
      questions:
      - How do I add a headshot to a speaker?
      - Will a new speaker profile picture replace the current one?
      instructions:
      - text: Set uploaded file {file} as speaker {id}'s profile picture.
        slots:
          file: requestBody.file
          id: path.id
      - text: Assign headshot {file} at {href} to speaker {id}.
        slots:
          file: requestBody.file
          href: requestBody.href
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/speakers/{id}/profile-images'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a speaker's profile picture
      effect: destructive
      questions:
      - How do I delete a speaker's headshot?
      - Can I clear a speaker's photo without deleting the speaker?
      instructions:
      - text: Delete the profile picture of speaker {id}.
        slots:
          id: path.id
      - text: Remove speaker {id}'s headshot.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/speakers/{id}/sessions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a speaker's sessions
      effect: read
      questions:
      - Which sessions is a particular speaker presenting?
      - Can I see every session assigned to one speaker?
      instructions:
      - text: List the sessions for speaker {id}.
        slots:
          id: path.id
      - text: Show what sessions speaker {id} is presenting.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'