Aetherin API documentation
Start here:
| Doc | What it covers |
|---|---|
| quickstart.md | Auth modes, first key, chat + streaming, usage, pagination, TS snippet |
| ../openapi/ERROR_CODES.md | Stable error codes and the ErrorResponse envelope |
| ../API_STABILITY.md | Stability tiers and the breaking-change process |
| ../openapi/openapi.yaml (../openapi/openapi.yaml) | OpenAPI 3.1 source of truth |
| ../CHANGELOG.md (../CHANGELOG.md) | Contract changes per version |
| ../schemas/ (../schemas/) | JSON Schema mirrors of key entities |
Conventions
- Versioned prefix: everything lives under
/v1. - Auth: operator session cookie for management routes; `Authorization: Bearer
sk-aetherin-… for client routes (/chat/completions, /embeddings, /models`).
- Errors:
{ "error": { code, message, type, param, request_id } }; branch
on code.
- Lists:
limit(1–200) +cursor; response hasnext_cursorand
has_more.
- Money: monetary amounts are returned in the subscription/invoice
currency (EUR by default); key budgets use budget_usd_monthly.
Generating clients
bash
npm run generate:ts # TypeScript (openapi-typescript)
oapi-codegen -config codegen/go.yaml openapi/openapi.yaml # GoRegenerate after every contract change; consumers commit the generated output so CI can detect drift.