Developer Resources
Developer Resources
The exact references behind the concept pages — data model, credentials and scopes, API conventions — and the tooling that talks to the API, from the SDKs to the CLI.
The concept pages carry the mental model; this section carries the exactness. Every page here is verified against the OpenAPI specification the API publishes and against the database schema, and is meant to be read next to the generated API reference, which lists every operation with its request and response shapes.
The reference
Architecture
The pieces of the system and how a request travels through them — gateway, API, PostgreSQL, event pipeline.
Data model
Entities, columns, enums, constraints, and the ERD — the single exact reference every concept page links to.
Authentication
The identity model, service accounts, and the ksh_ token lifecycle — how every call proves who it is.
Scopes
The permission grammar for tokens: modules, actions, wildcards, and what each operation requires.
API conventions
What every endpoint shares — cursor pagination, the problem+json error envelope, slug rules, and bringing your own identifiers.
The tooling
Two ways to call the API without writing HTTP by hand. Both are built on the OpenAPI specification the API publishes, and each covers its own share of it.
SDKs
The Go and Python clients and the two @kaitencloud TypeScript packages — what each covers, the browser/server boundary, and OpenFeature for flag evaluation.
CLI
Manage customers, licenses, entitlements, flags, and releases from the terminal, with JSON or YAML output for scripting.
Where to start
- No token yet? Authentication creates a service account and issues one; Scopes tells you which to grant.
- Nothing running yet? The quickstart sets up a stack and walks the whole chain — entitlement, license, customer, instance, usage, flag — in about ten minutes.
- Looking for a column or an enum? The data model is the only page that carries them.