Skip to main content

API reference

This page is auto-generated from alphaswarm_docs/openapi/alphaswarm.json, which itself is regenerated on every commit via the openapi-export-alphaswarm job in .github/workflows/ci.yml. If the committed spec and the live CI-dumped spec diverge, oasdiff blocks the PR.

Detailed reference​

For a narrative walkthrough of key API boundaries, see:

Surface​

The public AlphaSwarm API at api.alpha-swarm.ai exposes:

  • /health, /livez, /readyz — liveness probes.
  • /strategies/* — strategy CRUD + dispatch.
  • /backtest/* — backtest dispatch, status, cancel.
  • /bots/* — bot CRUD, snapshot, backtest, paper, deploy.
  • /promotion/* — mandatory research-to-live promotion gates.
  • /rl/* — RL train, replay, walk-forward, halt.
  • /agents/* — agent dispatch, halt, watchdog.
  • /workflows/* — workflow runtime endpoints.
  • /paper/* — paper trading session controls.
  • /analytics/* — QuantStats portfolio metrics + tearsheet rendering.
  • /mcp/data/* — the Data MCP server.
  • /mcp/codebase/* — the Codebase MCP server.

Added over July–August 2026 (see the 2026-08-13 changelog):

  • /license/* — license status and enforcement (GET /license/status).
  • /customers/*, /customer_deployments/*, /client_domains/* — enterprise customer and BYOC deployment management.
  • /security_master/* — security-master reads, introspection, and market-catalog projection.
  • /unified_data/* — unified data access surface.
  • /dbt/semantic/* — semantic-layer catalog, validate, and compile (see dbt semantic layer).
  • /auth/config — now advertises the dedicated CLI OIDC client id and device scopes; /readyz carries an advisory central_auth reachability probe.

Note: the /streaming/* diagnostics routes are default-off as of August 2026 and no longer appear in the public spec (see Streaming governance).

Interactive playground​

The Scalar component below loads openapi/alphaswarm.json and renders an interactive playground. Authenticate with the Authorization: Bearer <token> header. Tokens come from the alphaswarm-cli auth login device-flow path (see Concept: identity).

SDKs​

  • TypeScript: npm install @alphaswarm/sdk (generated via Fern; see reference/python).
  • Python: pip install alphaswarm-sdk (Phase 6).

Versioning​

AlphaSwarm uses Stripe-style date-epoch versioning. The first epoch is 2026-06-01. New epochs preserve old contracts; the Deprecation + Sunset HTTP headers (RFC 8594) signal the 12-month sunset cycle. Sunsetted epochs freeze on archive.alpha-swarm.ai.