AI Applyd · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Aiapplyd Referrals API

4 actions 4 updates phrasing extends openapi/aiapplyd-referrals-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 4

$.info

$.paths['/referrals/stats'].get

$.paths['/referrals/track'].post

$.paths['/referrals/convert'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Aiapplyd Referrals API
  version: 1.0.0
extends: openapi/aiapplyd-referrals-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: 3
- target: $.paths['/referrals/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my referral program stats
      effect: read
      questions:
      - How many people signed up through my referral link?
      - How many tokens have I earned from referrals?
      instructions:
      - text: Show my referral stats.
      - text: Get my referral clicks and signups.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/referrals/track'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a click on a referral link
      effect: write
      questions:
      - What gets recorded when someone opens a referral link?
      - How is a referral link visit tracked?
      instructions:
      - text: Track a referral click for code {referralCode}.
        slots:
          referralCode: requestBody.referralCode
      - text: Log a visit on referral link {referralCode}.
        slots:
          referralCode: requestBody.referralCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/referrals/convert'].post
  update:
    x-apievangelist-phrasing:
      intent: Credit a signup to a referral
      effect: write
      questions:
      - How does a new signup get linked to the person who referred them?
      - Can a referral be converted after the referred user signs up?
      instructions:
      - text: Convert referral {referralCode} for my new account.
        slots:
          referralCode: requestBody.referralCode
      - text: Link my signup to referral code {referralCode}.
        slots:
          referralCode: requestBody.referralCode
      method: generated
      generated: '2026-09-26'