Skip to content

REST API

The BaselineOS API server runs at http://localhost:3141 by default. Start it with:

Terminal window
baseline serve --api --port 3141
MethodPathDescription
GET/api/healthHealth check — returns { status: "ok", version }
GET/api/readyReadiness check — verifies core system is initialized
GET/api/statsSystem statistics from orchestrator, memory, indexer, cache, and RAG
MethodPathDescription
POST/api/tasksCreate and execute a task. Set blocking: true to wait for completion
GET/api/tasksList tasks, optionally filtered by ?status=
GET/api/tasks/{id}Get task details by ID
DELETE/api/tasks/{id}Cancel a task (reason recorded in audit trail)
POST/api/tasks/{id}/approveApprove a blocked task pending human review
GET/api/tasks/{id}/artifactsGet artifacts produced by a task
GET/api/tasks/{id}/auditGet chronological audit trail for a task
GET/api/tasks/{id}/evidenceGet complete evidence bundle for external audit
MethodPathDescription
GET/api/workflowsList registered workflows
POST/api/workflows/{id}/runExecute a workflow by ID
MethodPathDescription
GET/api/checkpoints/{id}Get checkpoint details
POST/api/checkpoints/{id}/recoverRecover a task to a previous checkpoint
MethodPathDescription
GET/api/agentsList all agents with trust scores, capabilities, and status
MethodPathDescription
POST/api/searchSearch knowledge base (BM25 + optional vector retrieval)
GET/api/context/{subject}Get assembled context at a specified compression level
POST/api/indexTrigger knowledge base indexing (incremental by default)
MethodPathDescription
POST/api/memoryStore a value in the multi-scope memory system
GET/api/memory/{key}Retrieve a value by key, optionally scoped
MethodPathDescription
POST/api/initInitialize deployment — scan context and index knowledge
POST/api/scanScan deployment context without indexing
MethodPathDescription
GET/metricsPrometheus-compatible metrics (text exposition format)

Connect to /api/stream for real-time orchestrator events including task lifecycle updates and agent status changes.