API Reference
Every Kite server serves the reference for its own API.
Your Kite server documents its own API. Because it's generated from the code that's running, it always matches your server's version: no endpoint you don't have, none missing.
| URL | What it is |
|---|---|
https://<your server>/openapi | The interactive reference: every endpoint, with examples. |
https://<your server>/openapi/json | The OpenAPI spec, for code generators and API tools. |
The server prints the reference's URL when it starts.
Reading an endpoint
Endpoints are grouped by what they act on: apps, payment links, transfers and so on. Each shows its body, its responses, and a request in the language you pick.
Every endpoint needs authentication. To try requests from the page, choose rootKey as the auth type and paste your root key; signed API-key requests are easier to make with the SDK, which signs them for you.
The root key can do anything on your server. Only paste it into the reference on a server and browser you trust.
Configuring it
The reference is on by default. Two environment variables control it:
KITE_ENABLE_OPENAPI_UI_SPECS=falseturns off both/openapiand/openapi/json.KITE_ENABLE_OPENAPI_UI_PROVIDER=swaggerserves Swagger UI instead of Scalar.
To get the spec without running a server, such as in CI, print it from a checkout of the server:
bun run spec > kite.json