API & architecture

OpenAPI contracts, stable errors, and runtime boundaries.

Browse the contracts#

The repository publishes merged API contracts. Download OpenAPI JSON or the browser-facing OpenAPI JSON from this site. They describe endpoints and data types; the generated frontend client is built from these contracts.

For a running deployment, inspect /api/v1/info to identify its build, and use /api/v1/health/live and /api/v1/health/ready for runtime probes. See observability for what each health result means.

Stable errors#

Read the generated error-code reference for HTTP statuses, retryability, areas, and meanings. A retryable transport failure is different from a permission refusal or invalid operation.

Runtime architecture#

KUI supports an all-in-one backend or a gateway with independent domain services. The frontend remains a separate nginx image in both shapes. Domains share contracts while keeping application boundaries explicit; the gateway composes their capabilities.

Read the architecture document for the module graph, fault isolation, streaming behavior, and architectural decisions.

Contribute to the microsite#

The microsite lives in website/. Its build renders static HTML from Markdown, imports the existing operations guides, and emits the screenshots, search index, and sitemap. Source and local build instructions explain how to update it.