API reference
The management API contract is available as a versioned OpenAPI file. Use it when integrating configuration, datasets, training, replay, or releases.
Download the management OpenAPI JSON
Download the behavior OpenAPI JSON
The running, authenticated management API also serves GET /api/v1/openapi.json. The download above is a snapshot bundled with this public website and should be refreshed when the product API changes.
Main workflow areas
| Area | Purpose |
|---|---|
| Authentication | Start and end an admin session. |
| APIs and endpoints | Register the host, method, and route being modeled. |
| Pipelines | Save immutable extractor, partition, window, and feature definitions. |
| Datasets | Preview and import request-event JSONL or feature-vector CSV. |
| Training and models | Start jobs, inspect status and validated models. |
| Replay | Test request histories and decisions in fresh state. |
| Releases | Select models and thresholds, then export a deployment archive. |
The product's Next.js admin portal acts as a server-side proxy to the management API. Follow the API's session and CSRF contract if you build a separate client. Keep the management API private; the public website does not call it.
Behavior and operations contracts
The management contract also includes remote servers, deployment jobs, offline recording imports, and Assisted setup. The behavior contract defines application registration and policy, scoped event ingestion/evaluation, snapshots, offline imports, training, replay, activation, and purge. Management uses administrator sessions and CSRF; behavior APIs use their documented admin or application-scoped bearer tokens. Do not expose those tokens in browser code.
Keeping this snapshot current
From the public website project, run scripts/sync-openapi.sh after updating the local product checkout. Review changed paths and schemas, then update any guide examples that depend on them. The product repository's docs/runtime.md and README.md are also source material for the explanatory pages.