Qorven’s API lives at
/v1/* (with /api as an alias for browser clients coming through the UI’s rewrite chain). Every endpoint requires a bearer token unless noted. All request + response bodies are JSON.Auth
qorven auth rotate-token.
Endpoint families
/v1/chat/completions
OpenAI-compatible chat.
POST with {session_id, agent_id, message, stream} → streamed SSE with tokens + tool events./v1/agents
CRUD for Qors.
GET list, POST create, GET/{id} read, PATCH/{id} update, DELETE/{id} soft-delete./v1/sessions
Session management. Idempotent
POST returns the canonical session for chat-family channels./v1/messages
Per-session message list. Filterable by channel.
/v1/memory/search
POST {scope, agent_id, query, max_results} → ranked memory list with relevance scores./v1/memory/save
Write a memory directly (bypasses the agent loop — for admin use).
/v1/tools
List + inspect tools.
POST /v1/tools/{id}/invoke bypasses the agent loop (admin only)./v1/rooms
Multi-agent rooms. Create, post messages, decide.
/v1/channels
Channel binding CRUD +
/status + /test-routing./v1/models
Model catalog, selected models, default model.
/v1/providers
LLM provider CRUD;
/keys for keys./v1/webhooks/{channel}
Per-channel inbound webhooks. Signature-verified by the channel’s own spec.
/ws
WebSocket hub. Subscribe to session events + Qor activity.
/health, /livez, /readyz
Health probes.
/livez = process up, /readyz = deps warmed.OpenAPI spec
The machine-readable spec is at/openapi.json on every install. Import into Postman, Bruno, or use with typed clients.
Rate limits
| Scope | Default | Response on breach |
|---|---|---|
| Per-IP | 10 req/sec, burst 20 | 429 + Retry-After |
| Per-tenant | 600 req/min | 429 + Retry-After |
| Per-tenant concurrent | 5 plan-runs | 503 + Retry-After |
Pagination
List endpoints support cursor-based pagination:Errors
Machine-readable:SDKs (unofficial)
The API is OpenAI-compatible at the chat level. Any OpenAI SDK works for chat:backend/cmd/client/.
Where next
Environment variables
QORVEN_SERVER, QORVEN_TOKEN for client apps.Auth middleware
How tokens are validated.
Rate limits
Tuning for scale.
Error codes
Every error.code string.