API reference
Interactive, always-in-sync OpenAPI documentation, rendered with Redoc from schemas generated straight from the FastAPI apps.
Browse the APIs
🎛️ Orchestrator API
The control-plane REST API: clients, server lifecycle, image builds, forwarding, async operations, and snapshots.
Open orchestrator API →📦 Server API
The in-pod server API: tools (bash, file create/edit/patch) and reward endpoints (compilation, setup, test).
Open server API →How these are produced
Both FastAPI apps expose /openapi.json. The committed schemas under
website/static/openapi/ are generated from the real router definitions by
website/scripts/gen_openapi.py,
so the rendered docs match the code. Regenerate them with the project's Python
environment:
# from the repo root; the fixed seed keeps the output stable between runs
PYTHONHASHSEED=0 uv run --frozen python website/scripts/gen_openapi.py website/static/openapi
This is a static interactive schema — you can read every endpoint, model, and example. To "try it out" against a live console, point a tool like
curl, the Python client, or the MCP interface at a running orchestrator.
Beyond the schema
- HTTP status codes & error semantics → HTTP Error Codes
- Agent-native tool access → MCP Server
- The orchestrator component → Architecture: Orchestrator