Skip to content

Reference#

Exhaustive enumeration of every public surface: REST endpoints, CLI commands, YAML keys, environment variables. Use the how-to guides for task-flow; come here for the catalogue.

  • Platform reference — 100% code-coverage reference. Tech stack with rationale, module index (every .py file), lifecycle flows, data model, glossary. For engineers + auditors.
  • Features catalogue — 573 numbered features by point-of-view (product / technical / security / compliance / operator / developer / ML / auditor / CISO / supply-chain). For everyone.
  • REST API — 84 endpoints across 17 routers. OpenAPI explorer + narrative reference.
  • CLI — swarm (39 subcommands, argparse).
  • YAML schemas — pipelines, agent definitions, permission policies.
  • Configuration — every SWARM_* env var + feature flag.
  • Changelog — versioned release notes.

Stability markers#

Each API surface is labeled:

Marker Guarantee
stable Semver rules apply — no breaking changes within a minor version
beta May change between minors; migration notes in release notes
experimental May disappear or change without warning; gated behind feature flag

Most of what you see is stable — everything on the swarm CLI and GET /api/v1/* endpoints. Experimental surfaces are explicitly marked.