API reference
Every endpoint on the Kleos API, and the permission each one needs.
Base URL
ALLhttps://api.kleos.click/v1
The machine-readable spec is at /openapi.json — generated from the same source as these pages, so the two cannot disagree.
Endpoints
| Method | Path | Permission | |
|---|---|---|---|
GET | /v1/me | — | Who this key belongs to |
GET | /v1/customers | customers:read | List your customers |
POST | /v1/customers | customers:write | Create a customer |
GET | /v1/customers/{id} | customers:read | Retrieve one customer |
GET | /v1/customers/{id}/readiness | customers:read | Can this customer take a live call yet? |
GET | /v1/customers/{id}/limits | customers:read | Read one customer's spending limits |
PATCH | /v1/customers/{id}/limits | customers:write | Cap one customer's spending |
GET | /v1/balance | billing:read | What is in the pool, and what a minute costs |
GET | /v1/usage | billing:read | Every movement of money, itemised |
GET | /v1/brand | brand:read | Read your branding |
PATCH | /v1/brand | brand:write | Change your branding |
By area
- Account — who a key belongs to and what it may do.
- Customers — create, list, retrieve, readiness.
- Billing — balance, usage ledger, per-customer caps.
- Brand — read and change your branding.
More surfaces are coming — placing calls, reading outcomes, ordering numbers and Kleos AI chat. They are listed in the changelog as they ship, and the scopes for them already exist so you can request them on a key today.