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-registration-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 speaker assignments
      effect: read
      questions:
      - Which speakers are assigned to which session program items?
      - Can I see every talk-to-speaker pairing across my sessions?
      instructions:
      - text: List program item speaker assignments.
      - text: List program item speaker assignments 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 long filter
      effect: read
      questions:
      - Can I send a long filter in the body to find program item speaker pairings?
      - Is there a POST search for session program speakers with locale support?
      instructions:
      - text: Search program item speakers using body filter {filter}.
        slots:
          filter: requestBody.filter
      - text: Search program speakers with 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 a program item speaker link
      effect: read
      questions:
      - Is a given speaker attached to a specific program item?
      - How do I check one program item to speaker relationship?
      instructions:
      - text: Get the link between program item {programItemId} and speaker {id}.
        slots:
          programItemId: path.programItemId
          id: path.id
      - text: Check whether speaker {id} presents 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 single talk inside a session?
      - How many speakers can one program item have?
      instructions:
      - text: Add speaker {id} to program item {programItemId}.
        slots:
          id: path.id
          programItemId: path.programItemId
      - text: Make speaker {id} a presenter on program item {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 program item but leave them on the session?
      - Can I unlink a speaker from a single talk?
      instructions:
      - text: Remove speaker {id} from program item {programItemId}.
        slots:
          id: path.id
          programItemId: path.programItemId
      - text: Unlink program item {programItemId} from speaker {id}.
        slots:
          programItemId: path.programItemId
          id: path.id
      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 defined?
      - Can I sort the speaker categories list?
      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 speaker categories?
      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:
      - Who are the speakers across my Cvent events?
      - Can I get the speaker list in a particular locale?
      instructions:
      - text: List speakers matching {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 for an event
      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} to event {event} with email {email}.
        slots:
          firstName: requestBody.firstName
          lastName: requestBody.lastName
          company: requestBody.company
          event: requestBody.event
          email: requestBody.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/speakers/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Search speakers with a long filter
      effect: read
      questions:
      - My speaker filter is too long for the URL; can I POST it instead?
      - Is there a body-filter search for speakers that returns the same data as the list?
      instructions:
      - text: Search speakers using body filter {filter}.
        slots:
          filter: requestBody.filter
      - text: Search speakers with 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 an existing speaker's bio or title?
      - Can I mark an existing speaker as featured?
      instructions:
      - text: Update speaker {id}'s biography to {biography}.
        slots:
          id: path.id
          biography: requestBody.biography
      - text: Change the job title of existing speaker {id} to {title}.
        slots:
          id: path.id
          title: requestBody.title
      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 from an event?
      - Can I remove a speaker record by its ID?
      instructions:
      - text: Delete speaker {id}.
        slots:
          id: path.id
      - text: Remove the speaker record {id} entirely.
        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?
      - Where can I get the file URLs stored against one speaker?
      instructions:
      - text: List the documents for speaker {id}.
        slots:
          id: path.id
      - text: Get 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 fetch a specific document assigned to a speaker?
      - Is a certain file attached to this speaker?
      instructions:
      - text: Get document {fileId} for speaker {id}.
        slots:
          fileId: path.fileId
          id: path.id
      - text: Show speaker {id}'s document {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 a speaker's slides or headshot file to their record?
      - Do I need to upload the file before adding it to a speaker?
      instructions:
      - text: Attach uploaded document {fileId} to speaker {id}.
        slots:
          fileId: path.fileId
          id: path.id
      - text: Add file {fileId} to speaker {id}'s documents.
        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 delete a document from a speaker's record?
      - Can I remove one file from a speaker without touching their other documents?
      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 set a speaker's headshot as their profile picture?
      - Will a new speaker profile picture replace the existing one?
      instructions:
      - text: Set speaker {id}'s profile picture to uploaded file {file} at {href}.
        slots:
          id: path.id
          file: requestBody.file
          href: requestBody.href
      - text: Replace the headshot on speaker {id} with file {file} ({href}).
        slots:
          id: path.id
          file: requestBody.file
          href: requestBody.href
      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 remove a speaker's headshot?
      - Can I clear a speaker's profile picture?
      instructions:
      - text: Delete the profile picture of speaker {id}.
        slots:
          id: path.id
      - text: Clear 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 one speaker is assigned to?
      instructions:
      - text: List the sessions assigned to speaker {id}.
        slots:
          id: path.id
      - text: Show where speaker {id} is presenting.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'