Skip to content

API Reference

Per-tag HTTP and SSE reference for the Compozy daemon, generated from the canonical OpenAPI contract on every site build.

For people running agent work31 pages in this section

The Compozy daemon ships a single HTTP surface under /api. This reference is built from openapi/compozy.json at every site build and matches the daemon you build from this checkout. A separately deployed daemon can expose a different contract revision.

The CLI and the HTTP API operate the same daemon state. Use the CLI reference for end-to-end examples; use the per-tag pages here when you need request bodies, response schemas, status codes, or SSE event shapes.

Recommended Entry Points

Automating session work

  1. Sessions — create, prompt, attach, inspect, and stream session work; the generated page owns the exact methods, paths, and schemas.
  2. Agents — list and inspect resolved agent definitions.
  3. Memory — show, write, search, and run dream checks for persistent context.

Building operational dashboards

  1. Observe — task dashboard and task inbox.
  2. Memory — health and redacted operation history.
  3. Bridges — health snapshots and SSE updates.

Integrating runtime configuration

  1. Settings — read and mutate daemon settings.
  2. Vault — list metadata, write new refs, delete refs (no plaintext ever leaves the daemon).
  3. Workspaces and Skills — register and inspect control surfaces.

Managing extensible desired state

  1. Resources — read and mutate desired-state objects.
  2. Automation — workspace suggestions, jobs, triggers, and runs.
  3. Marketplace — discover MCP servers, extensions, skills, and bundles with scoped installed-state projection.
  4. Extensions — install, update, remove, enable, disable, inspect, and read provenance/trust reports.

On this page