API Endpoints Reference

April 13, 2026 ยท View on GitHub

Qualixar OS exposes a REST API. All endpoints accept and return JSON. Authentication via Authorization: Bearer <QOS_API_KEY> when QOS_API_KEY is set.

System

MethodEndpointDescription
GET/api/healthHealth check (no auth required)
GET/api/readyReadiness check: DB, models, event bus
GET/api/setup/statusProvider availability and local model detection
GET/api/system/cwdCurrent working directory
GET/api/system/browse?path=Browse directories (within home)
POST/api/system/mkdirCreate a directory
GET/api/system/configGet merged config (memory + disk)
POST/api/system/configUpdate config (partial merge, persists to disk)
GET/api/system/modelsAvailable models (config + Ollama detection)
GET/api/system/events?limit=50Recent events from DB
GET/api/modelsModel catalog
GET/api/models/statusModel catalog with availability

Tasks

MethodEndpointDescription
GET/api/tasksList tasks (latest 100)
POST/api/tasksCreate and run a task (returns 202)
GET/api/tasks/:idTask status (in-memory or DB)
GET/api/tasks/:id/detailFull detail: agents, judges, costs
GET/api/tasks/:id/logsStructured agent logs (team.jsonl)
POST/api/tasks/:id/pausePause a running task
POST/api/tasks/:id/resumeResume a paused task
POST/api/tasks/:id/cancelCancel a task
POST/api/tasks/:id/redirectChange prompt mid-execution
GET/api/tasks/:id/workspaceList workspace files
GET/api/tasks/:id/workspace/*Read a workspace file

Agents

MethodEndpointDescription
GET/api/agentsList agents (in-memory, then DB fallback)
GET/api/agents/:idAgent details
GET/api/agents/:id/detailAgent + model calls + events

Chat

MethodEndpointDescription
GET/api/chat/conversationsList conversations
POST/api/chat/conversationsCreate a conversation
GET/api/chat/conversations/:idGet conversation
PUT/api/chat/conversations/:idUpdate title
DELETE/api/chat/conversations/:idDelete conversation + messages
GET/api/chat/conversations/:id/messagesList messages
POST/api/chat/conversations/:id/messagesSend message (async AI response via WebSocket)
POST/api/chat/conversations/:id/cancelCancel active stream
POST/api/chat/conversations/:id/cloneBranch/clone a conversation
POST/api/chat/conversations/:id/filesUpload files (multipart)
GET/api/files/:filenameServe uploaded files

Quality (Forge, Judges, Swarm, RL)

MethodEndpointDescription
GET/api/judges/results?taskId=Judge verdicts
GET/api/judges/profilesAvailable judge profiles
GET/api/forge/designs?taskType=Team designs
GET/api/forge/designs/:taskTypeDesigns for a task type
GET/api/swarm/topologiesAllowed topologies for current mode
GET/api/rl/statsStrategy scoring statistics
GET/api/rl/strategiesLearned strategies

Cost

MethodEndpointDescription
GET/api/costCost summary + budget status
GET/api/cost/historyPer-call cost entries

Memory

MethodEndpointDescription
GET/api/memory/statsMemory system statistics
GET/api/memory/search?q=&layer=&limit=Search memory (SLM-Lite)
GET/api/memory/entries?limit=50Raw memory entries
GET/api/memory/beliefsBelief graph entries

Data and Analytics

MethodEndpointDescription
GET/api/logsStructured logs (with event fallback)
GET/POST/api/reviewsHuman review items (gate)
PUT/api/reviews/:idUpdate review status
GET/POST/api/datasetsDataset management
GET/api/datasets/:id/preview?limit=20Dataset preview
DELETE/api/datasets/:idDelete dataset
GET/POST/api/vectorsVector store entries
DELETE/api/vectors/:idDelete vector
GET/api/vectors/statsVector store statistics
GET/POST/api/vectors/searchVector search (embedding or keyword)
GET/POST/api/blueprintsTask blueprints
POST/api/blueprints/:id/deployDeploy a blueprint as a task
DELETE/api/blueprints/:idDelete blueprint
GET/POST/api/promptsPrompt library
PUT/api/prompts/:idUpdate prompt
DELETE/api/prompts/:idDelete prompt
GET/POST/api/lab/experimentsA/B experiments
GET/api/lab/experiments/:idExperiment with live status
GET/api/lab/experiments/:id/resultsExperiment comparison results
GET/api/tracesTask execution traces
GET/api/traces/metricsTrace metrics (avg duration, error rate)
GET/POST/PUT/DELETE/api/flows[/:id]Flow definitions (CRUD)
POST/api/flows/:id/runExecute a flow
POST/api/chat/hitl/:requestIdHuman-in-the-loop approve/reject

Connectors and Tools

MethodEndpointDescription
GET/POST/api/connectorsMCP connectors
DELETE/api/connectors/:idRemove connector
POST/api/connectors/:id/testTest connector connectivity
GET/api/connectors/:id/toolsTools from a connector
GET/POST/DELETE/api/tool-connectors[/:id]Config-persisted connectors
GET/api/toolsFull tool catalog
GET/api/tools/categoriesTool categories
GET/api/tools/for-task/:taskTypeTools relevant to a task type
GET/api/mcp/toolsMCP tool registry (static catalog)

Real-Time

EndpointProtocolDescription
/api/sseSSEServer-Sent Events stream
/wsWebSocketReal-time events + task control + JSON-RPC 2.0
/.well-known/agent-cardHTTPA2A agent discovery

Error Format

All errors return: { "error": "message" } with appropriate HTTP status codes (400, 401, 403, 404, 409, 413, 429, 500).