Akahu · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Akahu Apply Reports API
9 actions
9 updates
phrasing
extends
openapi/akahu-reports-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.
What the actions change
x-apievangelist-phrasing
Targets 9
$.info
$.paths['/v1/applications/{applicationId}/reports'].post
$.paths['/v1/applications/{applicationId}/reports/{reportId}'].get
$.paths['/v1/applications/{applicationId}/reports/{reportId}/accounts'].get
$.paths['/v1/applications/{applicationId}/reports/{reportId}/data-sources'].get
$.paths['/v1/applications/{applicationId}/reports/{reportId}/html'].get
$.paths['/v1/applications/{applicationId}/reports/{reportId}/insights'].get
$.paths['/v1/applications/{applicationId}/reports/{reportId}/json'].get
$.paths['/v1/applications/{applicationId}/reports/{reportId}/transactions'].get
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 Akahu Apply Reports API
version: 1.0.0
extends: openapi/akahu-reports-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: 8
- target: $.paths['/v1/applications/{applicationId}/reports'].post
update:
x-apievangelist-phrasing:
intent: Generate an aggregate report for an application
effect: write
questions:
- How do I get an enriched summary of all documents in an application?
- Can I choose which documents go into a report?
instructions:
- text: Create a report for application {applicationId}.
slots:
applicationId: path.applicationId
- text: Generate a report for application {applicationId} including only {documents}.
slots:
applicationId: path.applicationId
documents: requestBody._documents
method: generated
generated: '2026-11-18'
- target: $.paths['/v1/applications/{applicationId}/reports/{reportId}'].get
update:
x-apievangelist-phrasing:
intent: Check an application report's status
effect: read
questions:
- Has my application report finished processing?
- What status is an application report in?
instructions:
- text: Get report {reportId} for application {applicationId}.
slots:
reportId: path.reportId
applicationId: path.applicationId
- text: Check the status of application {applicationId} report {reportId}.
slots:
applicationId: path.applicationId
reportId: path.reportId
method: generated
generated: '2026-11-18'
- target: $.paths['/v1/applications/{applicationId}/reports/{reportId}/accounts'].get
update:
x-apievangelist-phrasing:
intent: List accounts in an application report
effect: read
questions:
- Which accounts are included in an application report?
- Can I page through the accounts of an application report?
instructions:
- text: List the accounts in report {reportId} of application {applicationId}.
slots:
reportId: path.reportId
applicationId: path.applicationId
- text: Get the next page of accounts for application {applicationId} report {reportId} using cursor {cursor}.
slots:
applicationId: path.applicationId
reportId: path.reportId
cursor: query.cursor
method: generated
generated: '2026-11-18'
- target: $.paths['/v1/applications/{applicationId}/reports/{reportId}/data-sources'].get
update:
x-apievangelist-phrasing:
intent: List data sources in an application report
effect: read
questions:
- Which financial statements back an application report?
- How many data sources does an application report have?
instructions:
- text: List the data sources in report {reportId} of application {applicationId}.
slots:
reportId: path.reportId
applicationId: path.applicationId
- text: Get the next page of data sources for application {applicationId} report {reportId} using cursor {cursor}.
slots:
applicationId: path.applicationId
reportId: path.reportId
cursor: query.cursor
method: generated
generated: '2026-11-18'
- target: $.paths['/v1/applications/{applicationId}/reports/{reportId}/html'].get
update:
x-apievangelist-phrasing:
intent: Download an application report as HTML
effect: read
questions:
- Can I download an application report as an HTML document?
- Where do I get the human-readable version of an application report?
instructions:
- text: Download the HTML version of report {reportId} for application {applicationId}.
slots:
reportId: path.reportId
applicationId: path.applicationId
- text: Open the human-readable report {reportId} in application {applicationId}.
slots:
reportId: path.reportId
applicationId: path.applicationId
method: generated
generated: '2026-11-18'
- target: $.paths['/v1/applications/{applicationId}/reports/{reportId}/insights'].get
update:
x-apievangelist-phrasing:
intent: List insights in an application report
effect: read
questions:
- What insights does an application report contain?
- Can I page through the insights of an application report?
instructions:
- text: List the insights in report {reportId} of application {applicationId}.
slots:
reportId: path.reportId
applicationId: path.applicationId
- text: Get the next page of insights for application {applicationId} report {reportId} using cursor {cursor}.
slots:
applicationId: path.applicationId
reportId: path.reportId
cursor: query.cursor
method: generated
generated: '2026-11-18'
- target: $.paths['/v1/applications/{applicationId}/reports/{reportId}/json'].get
update:
x-apievangelist-phrasing:
intent: Download all application report data as JSON
effect: read
questions:
- Can I download every data point from an application report in one JSON file?
- Is there a redirect to the full JSON payload of an application report?
instructions:
- text: Download all data from report {reportId} of application {applicationId} as JSON.
slots:
reportId: path.reportId
applicationId: path.applicationId
- text: Get the JSON redirect for application {applicationId} report {reportId}.
slots:
applicationId: path.applicationId
reportId: path.reportId
method: generated
generated: '2026-11-18'
- target: $.paths['/v1/applications/{applicationId}/reports/{reportId}/transactions'].get
update:
x-apievangelist-phrasing:
intent: List transactions in an application report
effect: read
questions:
- Which transactions are in an application report?
- Can I page through the transactions of an application report?
instructions:
- text: List the transactions in report {reportId} of application {applicationId}.
slots:
reportId: path.reportId
applicationId: path.applicationId
- text: Get the next page of transactions for application {applicationId} report {reportId} using cursor {cursor}.
slots:
applicationId: path.applicationId
reportId: path.reportId
cursor: query.cursor
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.
Call it yourself
curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/akahu-reports-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.