Openapi-Reference

# OpenAPI Reference

The AeThex KAEL API publishes an OpenAPI 3.1 contract for public and user-facing routes.

| Field | Value |
|---|---|
| API version | 4.0 |
| OpenAPI version | 3.1 |
| Base URL | `https://api.aethex.tech` |
| Contract | [openapi.yaml](/static/custom/openapi.yaml) |
| Last source review | 2026-06-26 |

## Download

[Download the OpenAPI YAML](/static/custom/openapi.yaml)

You can import this file into tools such as Swagger UI, Redocly, Postman, Insomnia, or an OpenAPI client generator.

## Scope

The public contract includes:

- Health and discovery.
- Chat and Server-Sent Events streaming.
- Authentication.
- Conversation history.
- Keyed memory.
- Identity and profile summaries.
- Generated documents.
- Feed and leaderboard reads.

It intentionally excludes owner-only deployment, operator creation, tenant administration, and world-model mutation routes.

## Validate locally

Using Redocly:

```bash
npx @redocly/cli lint openapi.yaml
```

Using Swagger CLI:

```bash
npx swagger-cli validate openapi.yaml
```

## Generate a client

Example with OpenAPI Generator:

```bash
openapi-generator-cli generate \
  -i https://docs.aethex.support/static/custom/openapi.yaml \
  -g typescript-fetch \
  -o aethex-kael-client
```

## Streaming caveat

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]].

## Related documentation

- [[KAEL API]]
- [[API Reference]]
- [[Authentication]]
- [[Rate Limits]]
- [[KAEL Safety]]