Skip to content

docs(api): document the machine-readable /apis.json index #403

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jirkasemmler merged 1 commit into from
Jul 15, 2026
+26 −0
Merged

docs(api): document the machine-readable /apis.json index #403

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions overview/api/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,32 @@ for your own stack — tokens are not valid across stacks, and using the wrong p
| EU Frankfurt GCP | [api.europe-west3.gcp.keboola.com](https://api.europe-west3.gcp.keboola.com/) |
| US Virginia GCP | [api.us-east4.gcp.keboola.com](https://api.us-east4.gcp.keboola.com/) |

### Machine-Readable API Index

For agentic usage and tooling (AI agents, MCP servers, CI), each stack's API portal also publishes a
machine-readable index of its APIs at `https://api.<stack>/apis.json` — for example,
[api.keboola.com/apis.json](https://api.keboola.com/apis.json). The index lists each available service with
its base `apiUrl` and a link to its OpenAPI specification (`openApiSpecUrl`), so tools can discover and load
the specs programmatically:

{% highlight json %}
{
"stack": "keboola.com",
"services": [
{
"id": "storage",
"name": "Storage API",
"apiUrl": "https://connection.keboola.com",
"openApiSpecUrl": "https://api.keboola.com/specs/storage.json"
}
]
}
{% endhighlight %}

The index is stack-specific (excluded services are omitted). The raw specs under `/specs/` keep their original
`servers`, so consumers should use the `apiUrl` from the index as the base URL. The `openApiSpecUrl` extension
mirrors the source document (`.json` or `.yaml`) — use the exact URL from the index rather than assuming one.

### Service Endpoints

If you are calling the APIs directly (not through the portal), modify the hostname accordingly.
Expand Down
Loading