Reference
Reference pages state exact contracts — endpoints, schemas, parameters, tables. They describe, they don't teach; for the reasoning behind a surface, follow the links each page carries back to its concept page.
Surfaces
| Surface | What it covers | Where |
|---|---|---|
| Public API | api.alpha-swarm.ai — strategies, backtests, bots, promotion, RL, agents, workflows, paper trading | API reference (interactive playground) |
| Narrative API guides | The three API boundaries that deserve prose | Agent Crew API · Trading Bots API · Promotion Gates API |
| Control-plane API | manage.alpha-swarm.ai — workloads, fleet management | Manage API |
| Python packages | The alphaswarm* package family | Python reference |
| Data dictionary | Table-by-table column reference for the Postgres schema | Data dictionary |
| Compliance | SOC 2 evidence map, model-risk governance | SOC 2 · Model risk |
How the API reference stays honest
The OpenAPI specs in this site are regenerated on every commit of the
platform repo and diffed in CI (oasdiff) — if the committed spec and
the live spec diverge, the PR is blocked. Reference content here is
therefore generated, not hand-maintained; corrections belong in the
source code's route definitions.
Versioning
AlphaSwarm uses Stripe-style date-epoch API versioning (first epoch
2026-06-01). New epochs preserve old contracts; Deprecation and
Sunset headers (RFC 8594) signal the 12-month sunset cycle. See
API reference → Versioning for details.