API server
cfdl-server is a small, self-hostable HTTP API over the CFDL compiler and
engine. It is filesystem-free: sources arrive in the request body and packs
come from the embedded registry.
This page is the endpoint reference. To get one running, see Run the API server.
Endpoints
| Method | Path | Body | Response |
|---|---|---|---|
| GET | /healthz | — | {"status":"ok"} |
| POST | /v1/compile | {files, root_file?} | IR JSON, or 422 diagnostics |
| POST | /v1/validate | {files, root_file?} | {"ok":true}, or 422 diagnostics |
| POST | /v1/run | {ir? | files?, root_file?, config?, rate?, pack?} | Results JSON, or 422/400 |
| POST | /v1/explain | a results document (and optionally its IR) or a run request, plus a cell's address | what made the number |
| POST | /v1/compare | two sides, each a results document or a run request, and a scenario | what differs between two runs, and why |
| GET | /openapi.json | — | OpenAPI 3 document |
| GET | /docs | — | Swagger UI |
files is an in-memory map of root-relative path → source, and root_file
defaults to model.cfdl. run accepts
either pre-compiled ir or files to compile first; pack applies an
embedded pack's domain metrics.
Limits
- Request body: 1 MiB (413 beyond).
- Request timeout: 10 seconds (408 beyond).
- Monte Carlo trials capped at 1000 (400 beyond — never silently truncated).
Run it
See Run the API server for Docker and from-source setup, configuration, and verification.