Covendocs

Socket API

Operating the versioned local API boundary.

1 min read

The daemon serves /api/v1 over same-user local IPC, not a TCP port by default. Unix-like hosts use $COVEN_HOME/coven.sock; Windows uses an owner-only named pipe reported by health and coven daemon status. This keeps the default boundary local to the operating-system user that owns the daemon state.

Every client should call GET /api/v1/health before using another route. The response identifies the API version and available capabilities. A newer client must not assume that an older daemon supports a route simply because its own code knows about it.

The public session flow is health → capabilities → sessions → events → validated actions. For schemas, error codes, and local examples, use the local API reference.

GET /api/v1/api-version remains a legacy route-family diagnostic. Use the named apiVersion from health plus the advertised capabilities for compatibility decisions.

When the local IPC endpoint is missing or stale, use:

coven daemon status
coven daemon restart

For the local access posture, see Daemon security.

Was this page helpful?No

Last updated on