The BaselineOS API server runs at http://localhost:3141 by default. Start it with:
baseline serve --api --port 3141
| Method | Path | Description |
|---|
GET | /api/health | Health check — returns { status: "ok", version } |
GET | /api/ready | Readiness check — verifies core system is initialized |
GET | /api/stats | System statistics from orchestrator, memory, indexer, cache, and RAG |
| Method | Path | Description |
|---|
POST | /api/tasks | Create and execute a task. Set blocking: true to wait for completion |
GET | /api/tasks | List 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}/approve | Approve a blocked task pending human review |
GET | /api/tasks/{id}/artifacts | Get artifacts produced by a task |
GET | /api/tasks/{id}/audit | Get chronological audit trail for a task |
GET | /api/tasks/{id}/evidence | Get complete evidence bundle for external audit |
| Method | Path | Description |
|---|
GET | /api/workflows | List registered workflows |
POST | /api/workflows/{id}/run | Execute a workflow by ID |
| Method | Path | Description |
|---|
GET | /api/checkpoints/{id} | Get checkpoint details |
POST | /api/checkpoints/{id}/recover | Recover a task to a previous checkpoint |
| Method | Path | Description |
|---|
GET | /api/agents | List all agents with trust scores, capabilities, and status |
| Method | Path | Description |
|---|
POST | /api/search | Search knowledge base (BM25 + optional vector retrieval) |
GET | /api/context/{subject} | Get assembled context at a specified compression level |
POST | /api/index | Trigger knowledge base indexing (incremental by default) |
| Method | Path | Description |
|---|
POST | /api/memory | Store a value in the multi-scope memory system |
GET | /api/memory/{key} | Retrieve a value by key, optionally scoped |
| Method | Path | Description |
|---|
POST | /api/init | Initialize deployment — scan context and index knowledge |
POST | /api/scan | Scan deployment context without indexing |
| Method | Path | Description |
|---|
GET | /metrics | Prometheus-compatible metrics (text exposition format) |
Connect to /api/stream for real-time orchestrator events including task lifecycle updates and agent status changes.