Documentation Index
Fetch the complete documentation index at: https://docs.qredence.ai/llms.txt
Use this file to discover all available pages before exploring further.
The canonical schema lives in openapi.yaml. This page is a high-level map of the surface.
Categories
| Category | Prefix | Description |
|---|
| Health | / | Unprefixed health and readiness probes |
| Auth | /api/v1/auth | Identity endpoints |
| Runtime | /api/v1/runtime | Settings, diagnostics, volume access |
| Sessions | /api/v1/sessions | History, turns, stats, export, restore |
| Sandboxes | /api/v1/sandboxes | Daytona sandbox management |
| Runs | /api/v1/runs | Execution run steps |
| Memory | /api/v1/memory | Memory item browsing |
| Optimization | /api/v1/optimization | GEPA optimization, datasets, runs |
| Traces | /api/v1/traces | MLflow trace feedback |
| WebSocket | /api/v1/ws | Real-time chat and execution streams |
Authentication
All /api/v1/* endpoints require authentication when AUTH_REQUIRED=true. Behavior depends on AUTH_MODE:
| Mode | Behavior |
|---|
dev | Debug headers, local HS256 tokens, optional identity |
entra | JWKS-backed Entra ID tokens, Neon tenant admission required |
Health endpoints
Unauthenticated probes for load balancers and orchestrators.
GET /health
Liveness check.
{
"ok": true,
"version": "0.5.0"
}
GET /ready
Readiness check with component status.
{
"ready": true,
"planner_configured": true,
"planner": "ready",
"database": "ready",
"database_required": true,
"sandbox_provider": "daytona"
}
| Field | Values | Description |
|---|
ready | boolean | Overall readiness |
planner | ready, missing | Planner LM status |
database | ready, missing, disabled, degraded | Database connectivity |
Auth
GET /api/v1/auth/me
Returns the authenticated user’s identity envelope.
{
"tenant_claim": "tenant-123",
"user_claim": "user-456",
"email": "user@example.com",
"name": "Jane Doe",
"tenant_id": "uuid-...",
"user_id": "uuid-..."
}
Runtime
| Endpoint | Method | Purpose |
|---|
/api/v1/runtime/settings | GET | Read runtime settings |
/api/v1/runtime/settings | PATCH | Mutate settings (local-only) |
/api/v1/runtime/tests/daytona | POST | Connectivity probe against Daytona |
/api/v1/runtime/tests/lm | POST | Connectivity probe against the planner LM |
/api/v1/runtime/status | GET | Composite runtime status |
/api/v1/runtime/volume/tree | GET | List durable volume contents |
/api/v1/runtime/volume/file | GET | Read a single durable-volume file |
PATCH /api/v1/runtime/settings is intentionally restricted to APP_ENV=local. In staging and production it is read-only.
Sessions
| Endpoint | Method | Purpose |
|---|
/api/v1/sessions/state | GET | Active session envelope |
/api/v1/sessions | GET | List sessions |
/api/v1/sessions/{id} | GET | Session detail |
/api/v1/sessions/{id} | DELETE | Delete a session |
/api/v1/sessions/{id}/turns | GET | Conversation turns |
/api/v1/sessions/{id}/export | POST | Export session manifest |
Optimization
| Endpoint | Method | Purpose |
|---|
/api/v1/optimization/status | GET | Background runner status |
/api/v1/optimization/run | POST | Trigger an optimization run |
/api/v1/optimization/modules | GET | List registered DSPy modules |
/api/v1/optimization/runs | GET / POST | List or create runs |
/api/v1/optimization/runs/{run_id} | GET | Single run detail |
/api/v1/optimization/runs/{run_id}/results | GET | Run results |
/api/v1/optimization/runs/compare | GET | Baseline vs optimized comparison |
/api/v1/optimization/datasets | GET / POST | List or upload datasets |
/api/v1/optimization/datasets/{dataset_id} | GET | Dataset detail |
Traces
POST /api/v1/traces/feedback
Submit thumbs-up / thumbs-down feedback for an MLflow trace. Used by the Workbench feedback UI.
WebSocket
Two WebSocket endpoints power the live UI. Both require the same auth as HTTP endpoints when AUTH_REQUIRED=true.
| Endpoint | Stream |
|---|
/api/v1/ws/execution | Chat stream events — user-facing turn-taking |
/api/v1/ws/execution/events | Execution graph events — tool calls, sandbox steps, recursive delegation |
Source of truth
When this page disagrees with the code, trust:
src/fleet_rlm/api/main.py — app factory and route mounting.src/fleet_rlm/api/routers/ — individual routers.openapi.yaml — generated schema.
