Interactive docs are available at /api/docs (Swagger UI) and the machine-readable spec at /api/v1/openapi.json.
Base URL
--port CLI flag:
/api/v1/. Prometheus metrics are at /metrics.
Authentication
| Scenario | Requirement |
|---|---|
Loopback requests (127.0.0.1, ::1) | No auth required |
Remote read-only (GET, HEAD, OPTIONS) | No auth required |
Remote mutating (POST, PUT, PATCH, DELETE) | Authorization: Bearer <token> required |
RISOLUTO_WRITE_TOKEN environment variable:
Rate Limits
| Scope | Limit |
|---|---|
API endpoints (/api/*, /metrics) | 300 requests / minute per client |
Webhooks (/webhooks/*) | 600 requests / minute per client |
429 Too Many Requests with a Retry-After header.
Response Format
Successful responses return JSON with the relevant payload directly:Error Format
All errors follow a consistent envelope:Quick Start
Endpoint Groups
State & Metrics
Orchestrator state, runtime info, Prometheus metrics, SSE events, and available models.
Issues
Issue detail, abort, model override, mid-turn steering, templates, and state transitions.
Attempts
List attempts per issue and inspect individual attempt timelines.
Configuration
Read effective config, inspect the schema, and manage overlay overrides.
Secrets
List, set, and delete runtime secrets without restarting.
Workspaces & Git
Workspace inventory, cleanup, and git repo context.
Related
- All Endpoints — full endpoint table with request/response examples
- Operator Guide — configuration reference
- Observability — Prometheus metrics and alerting