APISHIPPED

System and event API

Check health, inspect runtime state, collect metrics, and subscribe to the live event stream.

View repository source

SYSTEM DIAGRAMEvent circulation

Core

Event buffer

WebSocket

Desktop

CLI

Clients

A shared stream keeps every interface in sync

Base URL

The local control plane uses the `/v1` namespace. WebSocket clients connect to the same service.

COMMAND

http://localhost:18789

System endpoints

GET/v1/health

Liveness and dependency health

GET/v1/status

Current runtime status

GET/v1/metrics

Performance metrics

GET/v1/events

Recent event records

WS/v1/events/ws

Live event stream

Event stream

Bounded buffers and backpressure keep slow clients from destabilizing the runtime. Desktop, CLI, and custom clients can observe the same progression of task, run, approval, worker, and ledger events.

Identity and heartbeat

GET/v1/identity

Read the active identity

GET/v1/identity/soul

Read the current Soul document

GET/v1/heartbeats

List heartbeat records

GET/v1/heartbeats/status

Inspect heartbeat health