# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Nylas Notetaker API
  version: 1.0.0
extends: openapi/nylas-notetaker-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: 9
- target: $.paths['/v3/grants/{grant_id}/notetakers'].get
  update:
    x-apievangelist-phrasing:
      intent: List Notetaker bots for a grant
      effect: read
      questions:
      - Which Notetaker bots are scheduled to join my upcoming meetings?
      - Can I filter my Notetaker bots by meeting state or join time?
      - What note-taking bots has this account sent to meetings so far?
      instructions:
      - text: List all Notetaker bots for grant {grant}.
        slots:
          grant: path.grant_id
      - text: Show Notetaker bots for {grant} in meeting state {state}.
        slots:
          grant: path.grant_id
          state: query.state
      - text: List Notetakers for {grant} joining at or after {join_time_start}.
        slots:
          grant: path.grant_id
          join_time_start: query.join_time_start
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/grants/{grant_id}/notetakers'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite a Notetaker bot to a meeting
      effect: write
      questions:
      - How do I send a Nylas Notetaker bot into a video meeting to record it?
      - Can I schedule the note-taking bot to join a meeting at a later time?
      - Does inviting a Notetaker twice to the same meeting create two bots?
      instructions:
      - text: Send a Notetaker to the meeting at {meeting_link} for grant {grant}.
        slots:
          meeting_link: requestBody.meeting_link
          grant: path.grant_id
      - text: Invite a Notetaker named {name} to {meeting_link} to join at {join_time} for {grant}.
        slots:
          name: requestBody.name
          meeting_link: requestBody.meeting_link
          join_time: requestBody.join_time
          grant: path.grant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/grants/{grant_id}/notetakers/{notetaker_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Notetaker bot's details
      effect: read
      questions:
      - What are the details and current state of a specific Notetaker bot?
      - Can I look up a single note-taking bot by its ID?
      instructions:
      - text: Show me Notetaker {notetaker} on grant {grant}.
        slots:
          notetaker: path.notetaker_id
          grant: path.grant_id
      - text: Get the details of Notetaker bot {notetaker} for {grant}.
        slots:
          notetaker: path.notetaker_id
          grant: path.grant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/grants/{grant_id}/notetakers/{notetaker_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Permanently delete a Notetaker and its data
      effect: destructive
      questions:
      - How can I permanently erase a Notetaker along with its recordings and transcripts?
      - Does deleting a Notetaker also remove its summaries and action items?
      - Can I delete a Notetaker bot even after the meeting has finished?
      instructions:
      - text: Permanently delete Notetaker {notetaker} and all its recordings for grant {grant}.
        slots:
          notetaker: path.notetaker_id
          grant: path.grant_id
      - text: Wipe Notetaker {notetaker} and its transcripts from {grant}.
        slots:
          notetaker: path.notetaker_id
          grant: path.grant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/grants/{grant_id}/notetakers/{notetaker_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Reschedule or rename a scheduled Notetaker
      effect: write
      questions:
      - Can I change when a scheduled Notetaker bot joins the meeting?
      - Is it possible to rename a Notetaker bot before it joins?
      instructions:
      - text: Change the join time of scheduled Notetaker {notetaker} on {grant} to {join_time}.
        slots:
          notetaker: path.notetaker_id
          grant: path.grant_id
          join_time: requestBody.join_time
      - text: Rename scheduled Notetaker {notetaker} for grant {grant} to {name}.
        slots:
          notetaker: path.notetaker_id
          grant: path.grant_id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/grants/{grant_id}/notetakers/{notetaker_id}/history'].get
  update:
    x-apievangelist-phrasing:
      intent: View a Notetaker's event and state history
      effect: read
      questions:
      - What state changes has a Notetaker bot gone through during a meeting?
      - Where can I see the full event timeline for a note-taking bot?
      instructions:
      - text: Show the event history of Notetaker {notetaker} for grant {grant}.
        slots:
          notetaker: path.notetaker_id
          grant: path.grant_id
      - text: Trace every state change for Notetaker {notetaker} on {grant}.
        slots:
          notetaker: path.notetaker_id
          grant: path.grant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/grants/{grant_id}/notetakers/{notetaker_id}/cancel'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a Notetaker before it joins
      effect: destructive
      questions:
      - How can I stop a scheduled Notetaker from joining a meeting it hasn't entered yet?
      - Can I cancel a note-taking bot that's still waiting in the lobby?
      instructions:
      - text: Cancel Notetaker {notetaker} on grant {grant} before it joins the meeting.
        slots:
          notetaker: path.notetaker_id
          grant: path.grant_id
      - text: Stop scheduled Notetaker {notetaker} for {grant} from entering the call.
        slots:
          notetaker: path.notetaker_id
          grant: path.grant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/grants/{grant_id}/notetakers/{notetaker_id}/leave'].post
  update:
    x-apievangelist-phrasing:
      intent: Make a Notetaker leave an ongoing meeting
      effect: write
      questions:
      - How do I pull a Notetaker bot out of a meeting it's currently attending?
      - Can I tell the recording bot to leave the call early?
      instructions:
      - text: Have Notetaker {notetaker} on grant {grant} leave the meeting it's in now.
        slots:
          notetaker: path.notetaker_id
          grant: path.grant_id
      - text: Remove Notetaker {notetaker} for {grant} from the live meeting.
        slots:
          notetaker: path.notetaker_id
          grant: path.grant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/grants/{grant_id}/notetakers/{notetaker_id}/media'].get
  update:
    x-apievangelist-phrasing:
      intent: Get links to a Notetaker's recordings and media
      effect: read
      questions:
      - Where do I download the recording and transcript a Notetaker produced?
      - What media files did the note-taking bot generate for a meeting?
      instructions:
      - text: Get the media links for Notetaker {notetaker} on grant {grant}.
        slots:
          notetaker: path.notetaker_id
          grant: path.grant_id
      - text: Fetch the recording and transcript URLs from Notetaker {notetaker} for {grant}.
        slots:
          notetaker: path.notetaker_id
          grant: path.grant_id
      method: generated
      generated: '2026-09-26'