Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.katalo.ai/llms.txt

Use this file to discover all available pages before exploring further.

The human docs explain how to integrate. The OpenAPI YAML is the canonical machine-readable contract.

Local spec

The repository copy lives at docs/external-api-v1.openapi.yaml.

Public download

Download the currently deployed API contract.

Current public endpoints

PathPurpose
/api/v1/source-assetsCreate a source asset ingest job.
/api/v1/source-assets/{ingest_id}Read a source asset ingest job.
/api/v1/generationsCreate a generation job.
/api/v1/generations/{job_id}Read a generation job.
/api/v1/generations/{job_id}/regenerateCreate a new job from the same source asset.
/api/v1/usage/summaryRead the current billing-period summary.
/api/v1/billing/eventsRead the API billing ledger.
/api/v1/openapiDownload the YAML spec.

Keep docs aligned

If the request or response model changes, update docs/external-api-v1.openapi.yaml first, then update the human guide pages that explain the integration flow.