Akahu · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Akahu Apply Applications API

6 actions 6 updates phrasing extends openapi/akahu-applications-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 6

$.info
$.paths['/v1/applications'].post
$.paths['/v1/applications/{applicationId}'].get
$.paths['/v1/applications/{applicationId}'].put
$.paths['/v1/applications/{applicationId}/archive'].put
$.paths['/v1/applications/{applicationId}/unarchive'].put

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 Applications API
  version: 1.0.0
extends: openapi/akahu-applications-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: 5
- target: $.paths['/v1/applications'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a credit application
      effect: write
      questions:
      - How do I start a new credit application for a customer?
      - Can I set a reference and report type when creating an application?
      instructions:
      - text: Create an application with reference {reference}.
        slots:
          reference: requestBody.reference
      - text: Create application {reference} using report type {report_type}.
        slots:
          reference: requestBody.reference
          report_type: requestBody.report_type
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v1/applications/{applicationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a credit application
      effect: read
      questions:
      - What is the status of a credit application?
      - Can I look up an application by its ID?
      instructions:
      - text: Get application {applicationId}.
        slots:
          applicationId: path.applicationId
      - text: Show the status of credit application {applicationId}.
        slots:
          applicationId: path.applicationId
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v1/applications/{applicationId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a credit application
      effect: write
      questions:
      - Can I change the reference on an existing application?
      - Does changing the report type restart the application's report?
      instructions:
      - text: Update application {applicationId} with reference {reference}.
        slots:
          applicationId: path.applicationId
          reference: requestBody.reference
      - text: Change the report type of application {applicationId} to {report_type}.
        slots:
          applicationId: path.applicationId
          report_type: requestBody.report_type
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v1/applications/{applicationId}/archive'].put
  update:
    x-apievangelist-phrasing:
      intent: Archive a credit application
      effect: destructive
      questions:
      - Can I stop adding data to an application by archiving it?
      - How long are archived applications kept before deletion?
      instructions:
      - text: Archive application {applicationId}.
        slots:
          applicationId: path.applicationId
      - text: Stop adding resources to credit application {applicationId} by archiving it.
        slots:
          applicationId: path.applicationId
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v1/applications/{applicationId}/unarchive'].put
  update:
    x-apievangelist-phrasing:
      intent: Restore an archived credit application
      effect: write
      questions:
      - Can I restore an application after it has been archived?
      - Is it possible to add more data to an archived application?
      instructions:
      - text: Restore application {applicationId}.
        slots:
          applicationId: path.applicationId
      - text: Unarchive credit application {applicationId} so I can add more data.
        slots:
          applicationId: path.applicationId
      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-applications-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.