API Evangelist conversational phrasing for Aiapplyd Relay Inbox API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Aiapplyd Relay Inbox API
  version: 1.0.0
extends: openapi/aiapplyd-relay-inbox-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: 13
- target: $.paths['/relay-inbox'].get
  update:
    x-apievangelist-phrasing:
      intent: List emails in my job inbox
      effect: read
      questions:
      - What recruiter emails have come into my inbox recently?
      - Can I see only unread or starred messages in my inbox?
      - Which emails relate to a particular job application?
      instructions:
      - text: List my latest inbox emails.
      - text: Show unread inbox emails in category {category}.
        slots:
          category: query.category
      - text: Search my inbox for {search}.
        slots:
          search: query.search
      - text: Show the emails linked to job listing {jobListingId}.
        slots:
          jobListingId: query.jobListingId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/relay-inbox/counts'].get
  update:
    x-apievangelist-phrasing:
      intent: Get unread and category counts for my inbox
      effect: read
      questions:
      - How many unread emails do I have?
      - What's the breakdown of my inbox by category, like interviews or rejections?
      instructions:
      - text: Give me my inbox unread count.
      - text: Show how many active emails I have in each category.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/relay-inbox/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply one action to many inbox emails
      effect: write
      questions:
      - Can I archive or mark read a bunch of emails at once?
      - How many emails can a single bulk inbox action cover?
      instructions:
      - text: Apply {action} to emails {ids}.
        slots:
          action: requestBody.action
          ids: requestBody.ids
      - text: 'Bulk archive these inbox emails: {ids} using action {action}.'
        slots:
          ids: requestBody.ids
          action: requestBody.action
      method: generated
      generated: '2026-09-26'
- target: $.paths['/relay-inbox/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read one inbox email in full
      effect: read
      questions:
      - Can I read the full body of a recruiter's email, including the sender's real address?
      - What company or job did the classifier link an email to?
      instructions:
      - text: Open inbox email {id}.
        slots:
          id: path.id
      - text: Show the full contents of email {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/relay-inbox/{id}/thread'].get
  update:
    x-apievangelist-phrasing:
      intent: View the full conversation for an email
      effect: read
      questions:
      - Can I see the whole back-and-forth with a recruiter, including my replies?
      - What order are messages shown in an email thread?
      instructions:
      - text: Show the conversation thread for email {id}.
        slots:
          id: path.id
      - text: Load every message, mine and theirs, in the thread containing {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/relay-inbox/{id}/attachments/{partId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an attachment from an inbox email
      effect: read
      questions:
      - How do I download a file a recruiter attached to an email?
      - Where do I find the part ID needed to get an attachment?
      instructions:
      - text: Download attachment {partId} from email {id}.
        slots:
          partId: path.partId
          id: path.id
      - text: Save the file {partId} attached to inbox email {id}.
        slots:
          partId: path.partId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/relay-inbox/{id}/category'].patch
  update:
    x-apievangelist-phrasing:
      intent: Correct the category of an inbox email
      effect: write
      questions:
      - The classifier marked an interview invite as a rejection — can I fix it?
      - Does changing an email's category update the application stage too?
      instructions:
      - text: Recategorize email {id} as {signalType}.
        slots:
          id: path.id
          signalType: requestBody.signalType
      - text: Override the category of inbox email {id} to {signalType}.
        slots:
          id: path.id
          signalType: requestBody.signalType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/relay-inbox/{id}/read'].patch
  update:
    x-apievangelist-phrasing:
      intent: Mark an inbox email read or unread
      effect: write
      questions:
      - How do I mark one email as unread again?
      - Can I flag a single message as read?
      instructions:
      - text: Mark email {id} as read.
        slots:
          id: path.id
      - text: Set the read state of email {id} to {read}.
        slots:
          id: path.id
          read: requestBody.read
      method: generated
      generated: '2026-09-26'
- target: $.paths['/relay-inbox/{id}/archive'].patch
  update:
    x-apievangelist-phrasing:
      intent: Archive or restore an inbox email
      effect: write
      questions:
      - How do I move one email out of my active inbox?
      - Can I restore an archived email back to the inbox?
      instructions:
      - text: Archive email {id}.
        slots:
          id: path.id
      - text: Set archived to {archived} for email {id}.
        slots:
          archived: requestBody.archived
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/relay-inbox/{id}/star'].patch
  update:
    x-apievangelist-phrasing:
      intent: Star or unstar an inbox email
      effect: write
      questions:
      - Can I pin an important recruiter email with a star?
      - How do I remove the star from a message?
      instructions:
      - text: Star email {id}.
        slots:
          id: path.id
      - text: Set starred to {starred} on email {id}.
        slots:
          starred: requestBody.starred
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/relay-inbox/{id}/reply'].post
  update:
    x-apievangelist-phrasing:
      intent: Reply to a recruiter from my relay alias
      effect: write
      questions:
      - Can I reply to a recruiter without revealing my real email address?
      - Does a reply support rich HTML formatting as well as plain text?
      instructions:
      - text: 'Reply to email {id} with: {message}.'
        slots:
          id: path.id
          message: requestBody.message
      - text: Send {message} back to the recruiter who sent {id}, formatted as {messageHtml}.
        slots:
          message: requestBody.message
          id: path.id
          messageHtml: requestBody.messageHtml
      method: generated
      generated: '2026-09-26'
- target: $.paths['/relay-inbox/forwarding/stop'].get
  update:
    x-apievangelist-phrasing:
      intent: Show the mute-emails confirmation page
      effect: read
      questions:
      - What does the unsubscribe link at the bottom of a forwarded email show?
      - Does clicking the mute link in a forwarded email change anything by itself?
      instructions:
      - text: Open the mute confirmation page for token {token}.
        slots:
          token: query.token
      - text: Show the confirm-mute page from the forwarded email link {token}.
        slots:
          token: query.token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/relay-inbox/forwarding/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Mute non-essential forwarded emails
      effect: write
      questions:
      - How do I stop getting non-essential emails forwarded from my relay alias?
      - Can I confirm muting forwarding straight from the email link?
      instructions:
      - text: Confirm muting non-essential forwarding with token {token}.
        slots:
          token: query.token
      - text: Turn off non-essential relay forwarding using signed token {token}.
        slots:
          token: query.token
      method: generated
      generated: '2026-09-26'