OpenAPI spec¶

This page points you at the machine-readable contract for the HTTP API. If you're an agent, this is the file to fetch instead of reading these pages by hand.

What it is¶

The daemon is a FastAPI app, so it describes itself in an OpenAPI 3.1 document — every HTTP route, its path and method, its request and response schemas, and the Pydantic models behind them, generated directly from the running code. It is the same source of truth these reference pages are written against; when code and prose ever disagree, the spec (and the code under it) wins.

The document's info block identifies it as Eternego, OpenAPI version 3.1.0.

Scope

The spec covers the HTTP endpoints under /api and /v1. The two WebSocket routes (/ws/{persona_id}, /ws/system) are not part of OpenAPI — document yourself from that page.

Where to get it¶

From the docs site — a generated, static copy ships with this manual:

https://docs.eternego.ai/openapi.json

Open it here.

From a running daemon — the live app serves its own, always matching the code you're actually running:

curl -s http://localhost:5000/openapi.json

Use the live one when you need certainty about your version; use the hosted one for reading or tooling when no daemon is up.

No Swagger UI / ReDoc

The interactive explorers are intentionally disabled — GET /docs and GET /redoc are off. Only the raw GET /openapi.json is served. Point your own viewer (Swagger UI, Postman, an OpenAPI client generator) at the JSON instead.

Using it¶

Feed the JSON to anything that speaks OpenAPI — a client generator, a request explorer, an LLM tool-calling layer. A quick look at what's covered:

# list every path + method
curl -s http://localhost:5000/openapi.json \
  | jq -r '.paths | to_entries[] | .key as $p | .value | keys[] | "\(ascii_upcase) \($p)"'

For agents¶

If you're an AI operating Eternego, the spec is one of four agent-friendly entry points — alongside /llms.txt, /llms-full.txt, and the .md form of any page. For agents lays out the whole fast path: fetch /llms.txt for the map, then /openapi.json for the exact HTTP contract.

For agents — the agent fast path; where this spec fits.
API overview — the human-readable companion: base URL, the persona_id concept, the error shape.
WebSockets — the live routes the spec doesn't cover.