Reference
OpenAPI reference
The canonical machine-readable contract for validation, tooling, and client generation.
Reference
OpenAPI is the canonical contract
The human docs explain how to integrate. The OpenAPI YAML is the canonical machine-readable contract.
Download
Fetch the YAML from the public route or download it from the docs site and feed it into your own tooling.
Contract
The spec defines paths, schemas, examples, enums, error payloads, and the docs metadata used to render the human reference pages.
Why
Why this matters
Human-written docs drift easily. The Katalo docs are generated around the same source contract that the API uses internally.
Alignment
If the request or response model changes, the OpenAPI file changes with it. Treat the YAML as the first place to verify exact field names, enums, and schema shapes.
Paths
Current public endpoints
These are the public API routes currently available.
| Path | Purpose |
|---|---|
| /api/v1/source-assets | Create a source asset ingest job. |
| /api/v1/source-assets/{ingest_id} | Read a source asset ingest job. |
| /api/v1/generations | Create a generation job. |
| /api/v1/generations/{job_id} | Read a generation job. |
| /api/v1/generations/{job_id}/regenerate | Create a new job from the same source asset. |
| /api/v1/usage/summary | Read the current billing-period summary. |
| /api/v1/billing/events | Read the API billing ledger. |
| /api/v1/openapi | Download the YAML spec. |