Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.opencoven.ai/llms.txt

Use this file to discover all available pages before exploring further.

Coven’s local API is versioned as a named contract. The current value is coven.daemon.v1.

​
Compatibility rules

  • New fields can be added inside an existing contract version. Clients must ignore unknown fields.
  • New endpoints can be added inside an existing contract version. Clients must not assume the full URL space is fixed.
  • New capabilities are advertised through GET /api/v1/capabilities.
  • Breaking changes — field removal, type change, semantics change — require a new contract version (coven.daemon.v2, …).
  • The daemon will advertise both the current and previous version during a transition.

​
Negotiation

GET /api/v1/health

{
  "apiVersion": "coven.daemon.v1",
  "supportedVersions": ["coven.daemon.v1"],
  "capabilities": {
    "sessions": true,
    "events": true,
    "actions": true,
    "harnesses": ["codex", "claude"]
  }
}
If a client requires a capability the daemon does not advertise, the client should fail loudly with a remediation hint (upgrade Coven to >= N).

​
Error envelope

All errors use the structured shape: 
{
  "error": {
    "code": "<dotted.code>",
    "message": "<human-readable>",
    "details": { "<context>": "<value>" }
  }
}
See Error envelope for the full code list.