Blame
|
1 | # KAEL API |
||||||
| 2 | ||||||||
| 3 | The KAEL API is served from `https://api.aethex.tech`. |
|||||||
| 4 | ||||||||
| 5 | | Field | Value | |
|||||||
| 6 | |---|---| |
|||||||
| 7 | | Product maturity | Live / evolving | |
|||||||
| 8 | | Documentation status | Active | |
|||||||
| 9 | | Base URL | `https://api.aethex.tech` | |
|||||||
| 10 | | Machine-readable contract | `/static/custom/openapi.yaml` | |
|||||||
| 11 | | Last source review | 2026-06-26 | |
|||||||
| 12 | ||||||||
| 13 | ## API groups |
|||||||
| 14 | ||||||||
| 15 | | Group | Purpose | |
|||||||
| 16 | |---|---| |
|||||||
| 17 | | Health | Service health, ping, and active-session counts | |
|||||||
| 18 | | Models and chat | Model catalog, non-streaming chat, and SSE streaming | |
|||||||
| 19 | | Authentication | Session inspection, login, logout, email code, and verification | |
|||||||
| 20 | | History | Save, list, load, and delete conversations | |
|||||||
| 21 | | Memory | List, save, delete, and clear keyed memory | |
|||||||
| 22 | | Identity and profile | Linked identity and usage summaries | |
|||||||
| 23 | | Documents | Generate and manage KAEL-produced documents | |
|||||||
| 24 | | Feed | Featured conversations and activity highlights | |
|||||||
| 25 | | Integrations | Signed Discord interactions and deployment webhooks | |
|||||||
| 26 | ||||||||
| 27 | ## Public versus privileged routes |
|||||||
| 28 | ||||||||
| 29 | The machine-readable public contract intentionally excludes owner-only operations such as deployment, world-model mutation, operator creation, and tenant administration. |
|||||||
| 30 | ||||||||
| 31 | Those routes are operational interfaces—not browser APIs. |
|||||||
| 32 | ||||||||
| 33 | ## Streaming |
|||||||
| 34 | ||||||||
| 35 | `POST /kael/stream` uses Server-Sent Events: |
|||||||
| 36 | ||||||||
| 37 | - Model metadata is emitted first. |
|||||||
| 38 | - Generated text arrives in JSON token events. |
|||||||
| 39 | - Errors can arrive as JSON events. |
|||||||
| 40 | - `[DONE]` closes the logical stream. |
|||||||
| 41 | ||||||||
| 42 | See [[API Quickstart]] for a complete request. |
|||||||
| 43 | ||||||||
| 44 | ## Authentication |
|||||||
| 45 | ||||||||
| 46 | KAEL uses secure cookies for signed-in browser sessions. Tenant keys can be supplied to tenant-aware requests through the dedicated tenant field or header. Operator tokens are separate and must remain server-side. |
|||||||
| 47 | ||||||||
| 48 | ## Reference files |
|||||||
| 49 | ||||||||
| 50 | - [Download OpenAPI YAML](/static/custom/openapi.yaml) |
|||||||
| 51 | - [[API Reference]] |
|||||||
| 52 | - [[Authentication]] |
|||||||
| 53 | - [[Rate Limits]] |
|||||||
| 54 | - [[KAEL Memory]] |
|||||||
| 55 | - [[KAEL Safety]] |
|||||||