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/coverage | — | Where you can sell |
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}/provisioning | customers:read | What is being set up, and who owes the next move |
POST | /v1/customers/{id}/provisioning | customers:write | Ask Kleos to start setting this customer up |
GET | /v1/customers/{id}/numbers | numbers:read | The numbers and caller IDs this customer rents |
POST | /v1/customers/{id}/numbers | numbers:order | Rent a number, or display your customer's own |
GET | /v1/customers/{id}/numbers/{number_id} | numbers:read | One rented number |
DELETE | /v1/customers/{id}/numbers/{number_id} | numbers:order | Give a number back — permanently |
GET | /v1/customers/{id}/websites | sites:read | The websites this customer has |
POST | /v1/customers/{id}/websites | sites:order | Order a website for your customer |
GET | /v1/customers/{id}/websites/{build_id} | sites:read | One website |
DELETE | /v1/customers/{id}/websites/{build_id} | sites:order | Cancel a build and get the fee back |
POST | /v1/customers/{id}/websites/{build_id}/revision | sites:order | Ask for a change before it goes live |
POST | /v1/customers/{id}/websites/{build_id}/domain | sites:order | Point your customer's own domain at their site |
POST | /v1/customers/{id}/onboarding_link | customers:write | Mint the link your customer accepts calling terms through |
GET | /v1/customers/{id}/onboarding_link | customers:read | See whether they accepted, and who accepted |
POST | /v1/customers/{id}/sessions | chat:write | Mint a chat session for one of your customer's staff |
GET | /v1/customers/{id}/sessions | customers:read | See who has a live session, and how much they have used it |
DELETE | /v1/customers/{id}/sessions | chat:write | End a session, or every session for one person |
POST | /v1/chat | session token | Ask the assistant a question |
POST | /v1/calls | calls:write | Queue a call to one business |
GET | /v1/calls | calls:read | Read what came of the calls |
GET | /v1/calls/{id} | calls:read | One call, or one queued request |
DELETE | /v1/calls/{id} | calls:write | Cancel a queued call |
GET | /v1/appointments | calls:read | The meetings your customers got |
GET | /v1/appointments/{id} | calls:read | One meeting |
GET | /v1/events | events:read | The event stream, readable on demand |
GET | /v1/events/{id} | events:read | One event |
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 |
GET | /v1/dsar/export | dsar:read | Everything your customers hold about one person |
POST | /v1/dsar/erase | dsar:erase | Erase a person's records. Irreversible |
GET | /v1/tax_profile | billing:read | What tax treatment your invoices carry |
By area
- Account — who a key belongs to and what it may do.
- Customers — create, list, retrieve, readiness, provisioning, onboarding links.
- Numbers and caller IDs — rent a number in your customer's country, or display one they already own.
- Websites — order a built and hosted one-page site, revise it, point their own domain at it.
- Calls and appointments — queue a call, read outcomes, cancel a queued one, list the meetings that came of them.
- Events — the stream your webhook endpoints receive, readable on demand.
- Billing — balance, usage ledger, per-customer caps.
- Brand — read and change your branding.
- Assistant — mint a session for one of your customer's staff, and let them ask the assistant questions from your own front end.
Everything on this page is live. New surfaces are announced in the changelog, and each one arrives with its own permission — a key you issued yesterday can never gain a capability without you granting it.