Blame

be64c9 AeThex Docs 2026-06-27 00:39:17
Build out operational docs platform
1
# OpenAPI Reference
2
3
The AeThex KAEL API publishes an OpenAPI 3.1 contract for public and user-facing routes.
4
5
| Field | Value |
6
|---|---|
7
| API version | 4.0 |
8
| OpenAPI version | 3.1 |
9
| Base URL | `https://api.aethex.tech` |
10
| Contract | [openapi.yaml](/static/custom/openapi.yaml) |
11
| Last source review | 2026-06-26 |
12
13
## Download
14
15
[Download the OpenAPI YAML](/static/custom/openapi.yaml)
16
17
You can import this file into tools such as Swagger UI, Redocly, Postman, Insomnia, or an OpenAPI client generator.
18
19
## Scope
20
21
The public contract includes:
22
23
- Health and discovery.
24
- Chat and Server-Sent Events streaming.
25
- Authentication.
26
- Conversation history.
27
- Keyed memory.
28
- Identity and profile summaries.
29
- Generated documents.
30
- Feed and leaderboard reads.
31
32
It intentionally excludes owner-only deployment, operator creation, tenant administration, and world-model mutation routes.
33
34
## Validate locally
35
36
Using Redocly:
37
38
```bash
39
npx @redocly/cli lint openapi.yaml
40
```
41
42
Using Swagger CLI:
43
44
```bash
45
npx swagger-cli validate openapi.yaml
46
```
47
48
## Generate a client
49
50
Example with OpenAPI Generator:
51
52
```bash
53
openapi-generator-cli generate \
54
-i https://docs.aethex.support/static/custom/openapi.yaml \
55
-g typescript-fetch \
56
-o aethex-kael-client
57
```
58
59
## Streaming caveat
60
61
Generated OpenAPI clients do not always provide ergonomic Server-Sent Events handling. For `/kael/stream`, a small fetch-based stream parser may be preferable. See [[API Quickstart]].
62
63
## Related documentation
64
65
- [[KAEL API]]
66
- [[API Reference]]
67
- [[Authentication]]
68
- [[Rate Limits]]
69
- [[KAEL Safety]]