Akahu · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Akahu Enduring Auth API

4 actions 4 updates phrasing extends openapi/akahu-auth-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 4

$.info
$.paths['/par'].post
$.paths['/token'].post
$.paths['/token'].delete

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 Enduring Auth API
  version: 1.0.0
extends: openapi/akahu-auth-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: 3
- target: $.paths['/par'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an enduring authorisation request
      effect: write
      questions:
      - How do I get a user's bank data for my app with enduring access?
      - Can I suggest a user when starting an authorisation request?
      instructions:
      - text: Start an enduring authorisation request for app {client_id} with secret {client_secret} redirecting to {redirect_uri}.
        slots:
          client_id: requestBody.client_id
          client_secret: requestBody.client_secret
          redirect_uri: requestBody.redirect_uri
      - text: Start an authorisation request for {client_id} suggesting user {login_hint}.
        slots:
          client_id: requestBody.client_id
          login_hint: requestBody.login_hint
      method: generated
      generated: '2026-11-18'
- target: $.paths['/token'].post
  update:
    x-apievangelist-phrasing:
      intent: Exchange an authorisation code for a user access token
      effect: write
      questions:
      - How do I turn an authorisation code into a user access token?
      - What grant type do I need to exchange an OAuth code?
      instructions:
      - text: Exchange authorisation code {code} for a user access token using grant type {grant_type}.
        slots:
          code: requestBody.code
          grant_type: requestBody.grant_type
      - text: Complete the OAuth flow and get a user access token for app {client_id}.
        slots:
          client_id: requestBody.client_id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/token'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a user access token
      effect: destructive
      questions:
      - How do I revoke a user's access to my app?
      - Does revoking a user access token remove all of their account data?
      instructions:
      - text: Revoke the user access token for app {X-Akahu-Id}.
        slots:
          X-Akahu-Id: header.X-Akahu-Id
      - text: Revoke the user's access to my app.
      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-auth-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.