Skip to content

REST API overview

Status: GA Access: token required API contract: 0.3.0 · capability 2026-09-03.1 View as Markdown Open in Claude Open in ChatGPT

Reference generated from the checked-in contract. The frozen machine-readable spec for this build is at openapi.json; the interactive explorer lives at https://entherium.duckdns.org:8443/reference.

  • Base URL: https://entherium.duckdns.org:8443; every path below is relative to it.
  • Auth: all data endpoints need Authorization: Bearer <token>. Humans log in with the OAuth2 password flow (POST /api/v1/auth/login); agents use a scoped agent token issued by the platform owner — see Authentication. Without a token only these answer: /healthz, /status.json, /api/status.json, /api/ (the machine map), /openapi.json, /reference, /redoc, /llms.txt, /mcp-info, the docs MCP at /mcp/docs/ and this portal.
  • Errors: JSON {"detail": "<human-readable>"}; some endpoints add a machine code. Full list: Errors reference.
  • Retries: the task and ticket intake endpoints honour an Idempotency-Key header (UUID); see Limits.
  • Groups vs domains: this reference groups operations by contract tag; the MCP discovery map (list_domains, GET /api/) names 28 capability domains — a different axis (a domain may span several tags or have no public operation), so the counts differ on purpose.
GroupOperations
agent2
analytics4
architecture2
auth6
chat1
cloudflare6
cockpit4
comments5
cycles4
docs3
entities12
errors1
health3
instances8
integrations3
lifecycles6
localizations1
metamodel2
metering4
ops3
publish3
runs17
specs6
sse6
tasks5
tickets3