Akahu · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Akahu Apply Documents API

6 actions 6 updates phrasing extends openapi/akahu-documents-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/{applicationId}/documents'].get
$.paths['/v1/applications/{applicationId}/documents'].post
$.paths['/v1/applications/{applicationId}/documents/{documentId}'].get
$.paths['/v1/applications/{applicationId}/documents/{documentId}'].delete
$.paths['/v1/applications/{applicationId}/documents/{documentId}/download'].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 Documents API
  version: 1.0.0
extends: openapi/akahu-documents-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/{applicationId}/documents'].get
  update:
    x-apievangelist-phrasing:
      intent: List documents attached to an application
      effect: read
      questions:
      - What documents have been uploaded for an application?
      - Can I see all the supporting documents on an application?
      instructions:
      - text: List documents for application {applicationId}.
        slots:
          applicationId: path.applicationId
      - text: Show every document on application {applicationId}.
        slots:
          applicationId: path.applicationId
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v1/applications/{applicationId}/documents'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a pending document record
      effect: write
      questions:
      - How do I add a new supporting document to an application?
      - How long do I have to upload a document after creating it?
      instructions:
      - text: Create document {name} for application {applicationId}.
        slots:
          name: requestBody.name
          applicationId: path.applicationId
      - text: Add a pending document {name} to application {applicationId}.
        slots:
          name: requestBody.name
          applicationId: path.applicationId
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v1/applications/{applicationId}/documents/{documentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a document's details
      effect: read
      questions:
      - What state is a document in, and when does it expire?
      - Can I look up one document on an application?
      instructions:
      - text: Get document {documentId} on application {applicationId}.
        slots:
          documentId: path.documentId
          applicationId: path.applicationId
      - text: Show the details of document {documentId} for application {applicationId}.
        slots:
          documentId: path.documentId
          applicationId: path.applicationId
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v1/applications/{applicationId}/documents/{documentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a document
      effect: destructive
      questions:
      - How do I remove a document from an application?
      - Can I delete a document I no longer need?
      instructions:
      - text: Delete document {documentId} from application {applicationId}.
        slots:
          documentId: path.documentId
          applicationId: path.applicationId
      - text: Remove document {documentId} on application {applicationId}.
        slots:
          documentId: path.documentId
          applicationId: path.applicationId
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v1/applications/{applicationId}/documents/{documentId}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a document
      effect: read
      questions:
      - How do I download a document attached to an application?
      - Can I fetch the file behind a document?
      instructions:
      - text: Download document {documentId} from application {applicationId}.
        slots:
          documentId: path.documentId
          applicationId: path.applicationId
      - text: Fetch the file for document {documentId} on application {applicationId}.
        slots:
          documentId: path.documentId
          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-documents-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.