Skip to main content

HTTP API

The canonical HTTP contract is the OpenAPI 3.1 specification in the Core repository. Client libraries, examples, and this documentation must all follow that file.

Control-plane endpoints

MethodPathPurpose
GET/api/healthCheck whether Core is available.
POST/api/v1/workers/heartbeatReport a worker snapshot and receive commands.
PUT/api/processes/{id}/desired-stateStart or stop one process.
GET/api/stateRead the paginated console state and history.

heartbeatInterval is a positive whole number of seconds everywhere in v1. Names are unique per worker, so operator commands address a process by id.

The heartbeat endpoint is the only endpoint a worker needs. The other endpoints are used by operators and the bundled console.