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-event-cloud-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 program items across my sessions?
      - Can I filter the program item to speaker associations?
      instructions:
      - text: List all program item speaker associations.
      - text: Show program item speaker associations 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:
      - Can I search program item speaker links with a long filter sent in the body?
      - Is there a POST version of the program speakers lookup that supports locale?
      instructions:
      - text: Search program item speakers using body filter {filter}.
        slots:
          filter: requestBody.filter
      - text: Search program speakers with 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's speaker link
      effect: read
      questions:
      - Is a particular speaker attached to a given program item?
      - Can I read one program item to speaker relationship?
      instructions:
      - text: Get the link between program item {programItemId} and speaker {speaker}.
        slots:
          programItemId: path.programItemId
          speaker: path.id
      - text: Check if speaker {speaker} is on program item {programItemId}.
        slots:
          speaker: 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:
      - Can I put a speaker on a specific talk inside a session?
      - How many speakers can a single program item have?
      instructions:
      - text: Add speaker {speaker} to program item {programItemId}.
        slots:
          speaker: path.id
          programItemId: path.programItemId
      - text: Link program item {programItemId} with presenter {speaker}.
        slots:
          programItemId: path.programItemId
          speaker: path.id
      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:
      - Can I take a speaker off one talk without removing them from the whole session?
      - How do I delete a program item to speaker relationship?
      instructions:
      - text: Remove speaker {speaker} from program item {programItemId}.
        slots:
          speaker: path.id
          programItemId: path.programItemId
      - text: Unlink program item {programItemId} and speaker {speaker}.
        slots:
          programItemId: path.programItemId
          speaker: 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 are set up, like Keynote or Panelist?
      - Can I sort or filter 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:
      - Can I add a new category for grouping speakers?
      - How do I make a speaker category such as Moderator?
      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 all the speakers across my events?
      - Can I sort speakers or get their details in another language?
      instructions:
      - text: List speakers matching {filter}.
        slots:
          filter: query.filter
      - text: List speakers sorted by {sort} in locale {locale}.
        slots:
          sort: query.sort
          locale: query.locale
      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 my 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 body filter
      effect: read
      questions:
      - Can I search speakers using a filter too long for the query string?
      - Which call returns the same speakers list but takes a filter in the body?
      instructions:
      - text: Search speakers using body filter {filter}.
        slots:
          filter: requestBody.filter
      - text: Search speakers with 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:
      - Can I edit a speaker's biography or job title?
      - How do I mark an existing speaker as featured?
      instructions:
      - text: Update the biography of speaker {speaker} to {biography}.
        slots:
          speaker: path.id
          biography: requestBody.biography
      - text: Change speaker {speaker}'s company to {company}.
        slots:
          speaker: path.id
          company: requestBody.company
      method: generated
      generated: '2026-09-26'
- target: $.paths['/speakers/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a speaker
      effect: destructive
      questions:
      - Can I delete a speaker who is no longer presenting?
      - Is deleting a speaker by ID permanent?
      instructions:
      - text: Delete speaker {speaker}.
        slots:
          speaker: path.id
      - text: Remove speaker {speaker} from the event.
        slots:
          speaker: 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 files, such as headshots or slides, are attached to a speaker?
      - Where do I get document URLs for one speaker?
      instructions:
      - text: List documents for speaker {speaker}.
        slots:
          speaker: path.id
      - text: Get the document URLs attached to speaker {speaker}.
        slots:
          speaker: 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:
      - Can I retrieve a specific file that is assigned to a speaker?
      - Is a certain document still attached to a speaker?
      instructions:
      - text: Get document {fileId} for speaker {speaker}.
        slots:
          fileId: path.fileId
          speaker: path.id
      - text: Show speaker {speaker}'s document {fileId}.
        slots:
          speaker: path.id
          fileId: path.fileId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/speakers/{id}/docs/{fileId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Attach a document to a speaker
      effect: write
      questions:
      - Can I attach an uploaded file to a speaker's profile?
      - Do I need to upload a file before adding it to a speaker?
      instructions:
      - text: Attach uploaded document {fileId} to speaker {speaker}.
        slots:
          fileId: path.fileId
          speaker: path.id
      - text: Add file {fileId} to speaker {speaker}'s documents.
        slots:
          fileId: path.fileId
          speaker: 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:
      - Can I remove an outdated file from a speaker?
      - How do I delete a document that was added to a speaker?
      instructions:
      - text: Remove document {fileId} from speaker {speaker}.
        slots:
          fileId: path.fileId
          speaker: path.id
      - text: Delete speaker {speaker}'s file {fileId}.
        slots:
          speaker: 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:
      - Can I set a headshot for a speaker from an uploaded file?
      - Does assigning a new speaker photo replace the old one?
      instructions:
      - text: Set uploaded file {file} at {href} as speaker {speaker}'s profile picture.
        slots:
          file: requestBody.file
          href: requestBody.href
          speaker: path.id
      - text: Replace the headshot of speaker {speaker} with file {file} ({href}).
        slots:
          speaker: 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:
      - Can I delete a speaker's headshot?
      - How do I clear the profile image on a speaker?
      instructions:
      - text: Delete the profile picture of speaker {speaker}.
        slots:
          speaker: path.id
      - text: Remove speaker {speaker}'s headshot.
        slots:
          speaker: 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 given speaker presenting in?
      - Can I see all sessions assigned to one speaker?
      instructions:
      - text: List the sessions for speaker {speaker}.
        slots:
          speaker: path.id
      - text: Show every session speaker {speaker} is assigned to.
        slots:
          speaker: path.id
      method: generated
      generated: '2026-09-26'