Akahu · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Akahu Apply Referrals API

7 actions 7 updates phrasing extends openapi/akahu-referrals-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Akahu's API. It is a proposal applied on top of the contract, not a document Akahu publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/v1/applications/{applicationId}/referrals'].get
$.paths['/v1/applications/{applicationId}/referrals'].post
$.paths['/v1/applications/{applicationId}/referrals/{referralId}'].get
$.paths['/v1/applications/{applicationId}/referrals/{referralId}/revoke'].put
$.paths['/v1/referral-redemptions'].post
$.paths['/v1/referral-redemptions/{redemptionId}'].get

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 Akahu Apply Referrals API
  version: 1.0.0
extends: openapi/akahu-referrals-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-11-18'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/v1/applications/{applicationId}/referrals'].get
  update:
    x-apievangelist-phrasing:
      intent: List referrals from an application
      effect: read
      questions:
      - Which referral codes have been created from my application?
      - Can I see the referral history for an application?
      instructions:
      - text: List referrals for application {applicationId}.
        slots:
          applicationId: path.applicationId
      - text: Show every referral code created from application {applicationId}.
        slots:
          applicationId: path.applicationId
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v1/applications/{applicationId}/referrals'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a referral code for an application
      effect: write
      questions:
      - How do I generate a referral code so others can apply with my data?
      - Can I set a custom reference on a referral I create?
      instructions:
      - text: Create a referral for application {applicationId}.
        slots:
          applicationId: path.applicationId
      - text: Create a referral for {applicationId} with reference {reference}.
        slots:
          applicationId: path.applicationId
          reference: requestBody.reference
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v1/applications/{applicationId}/referrals/{referralId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a referral's code and expiry
      effect: read
      questions:
      - What is the redemption code and expiry of a referral?
      - Where do I find the referral code I created?
      instructions:
      - text: Get referral {referralId} on application {applicationId}.
        slots:
          referralId: path.referralId
          applicationId: path.applicationId
      - text: Show the code and expiry of referral {referralId} for {applicationId}.
        slots:
          referralId: path.referralId
          applicationId: path.applicationId
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v1/applications/{applicationId}/referrals/{referralId}/revoke'].put
  update:
    x-apievangelist-phrasing:
      intent: Revoke a referral code
      effect: destructive
      questions:
      - Can I stop a referral code from being redeemed?
      - Is revoking a referral permanent?
      instructions:
      - text: Revoke referral {referralId} on application {applicationId}.
        slots:
          referralId: path.referralId
          applicationId: path.applicationId
      - text: Invalidate referral code {referralId} for {applicationId}.
        slots:
          referralId: path.referralId
          applicationId: path.applicationId
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v1/referral-redemptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Redeem a referral code into a new application
      effect: write
      questions:
      - How do I turn a referral code into a new application?
      - Can I choose the report type when redeeming a referral?
      instructions:
      - text: Redeem referral code {code}.
        slots:
          code: requestBody.code
      - text: Redeem {code} as a new application with reference {reference} and report type {report_type}.
        slots:
          code: requestBody.code
          reference: requestBody.reference
          report_type: requestBody.report_type
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v1/referral-redemptions/{redemptionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a referral redemption's status
      effect: read
      questions:
      - Has my referral redemption finished processing?
      - What is the status of a referral redemption?
      instructions:
      - text: Get referral redemption {redemptionId}.
        slots:
          redemptionId: path.redemptionId
      - text: Check whether redemption {redemptionId} succeeded or failed.
        slots:
          redemptionId: path.redemptionId
      method: generated
      generated: '2026-11-18'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/akahu-referrals-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.