AI Applyd · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Aiapplyd Follow Ups API

6 actions 6 updates phrasing extends openapi/aiapplyd-follow-ups-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for AI Applyd's API. It is a proposal applied on top of the contract, not a document AI Applyd publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/follow-ups/history'].get
$.paths['/follow-ups'].get
$.paths['/follow-ups/{applicationId}/draft'].get
$.paths['/follow-ups/{applicationId}/sent'].post
$.paths['/follow-ups/{applicationId}/send-gmail'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Aiapplyd Follow Ups API
  version: 1.0.0
extends: openapi/aiapplyd-follow-ups-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: 5
- target: $.paths['/follow-ups/history'].get
  update:
    x-apievangelist-phrasing:
      intent: List follow-ups I've already sent
      effect: read
      questions:
      - Which follow-up emails have I sent so far?
      - Can I scroll back through my follow-up send history?
      instructions:
      - text: Show my sent follow-up history.
      - text: Show the next {limit} sent follow-ups after {cursor}.
        slots:
          limit: query.limit
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/follow-ups'].get
  update:
    x-apievangelist-phrasing:
      intent: List applications due a follow-up
      effect: read
      questions:
      - Which applications should I follow up on now?
      - What follow-ups are most urgent?
      instructions:
      - text: List my pending follow-ups by urgency.
      - text: Show the applications I still need to chase.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/follow-ups/{applicationId}/draft'].get
  update:
    x-apievangelist-phrasing:
      intent: Draft a follow-up email for an application
      effect: read
      questions:
      - Can AI write a follow-up email for one of my applications?
      - What should I say when chasing a particular application?
      instructions:
      - text: Draft a follow-up email for application {applicationId}.
        slots:
          applicationId: path.applicationId
      - text: Write me a follow-up message for application {applicationId}.
        slots:
          applicationId: path.applicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/follow-ups/{applicationId}/sent'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a follow-up I sent myself
      effect: write
      questions:
      - How do I log a follow-up I sent outside the app?
      - Can I record which channel I used, like LinkedIn or phone, for a follow-up?
      instructions:
      - text: 'Record that I followed up on application {applicationId} via {channel} with: {body}.'
        slots:
          applicationId: path.applicationId
          channel: requestBody.channel
          body: requestBody.body
      - text: 'Log a {channel} follow-up to {recipient} for application {applicationId}: {body}.'
        slots:
          channel: requestBody.channel
          recipient: requestBody.recipient
          applicationId: path.applicationId
          body: requestBody.body
      method: generated
      generated: '2026-09-26'
- target: $.paths['/follow-ups/{applicationId}/send-gmail'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a follow-up through my Gmail
      effect: write
      questions:
      - Can the app send my follow-up email from my connected Gmail?
      - What happens if my Gmail isn't connected when I send a follow-up?
      instructions:
      - text: Send a follow-up for application {applicationId} to {to} via Gmail with subject {subject} and body {body}.
        slots:
          applicationId: path.applicationId
          to: requestBody.to
          subject: requestBody.subject
          body: requestBody.body
      - text: 'Email {to} from my Gmail about application {applicationId}: {subject} / {body}.'
        slots:
          to: requestBody.to
          applicationId: path.applicationId
          subject: requestBody.subject
          body: requestBody.body
      method: generated
      generated: '2026-09-26'