Agent heartbeat

curl --request POST \ --url https://api.svantic.com/agents/heartbeat \ --header 'Content-Type: application/json' \ --data ' { "instance_id": "navigator-prod-01", "status": "available", "current_sessions": 3, "max_concurrent_sessions": 16, "consecutive_failures": 0 } '

Body

application/json

Heartbeat payload posted by an agent instance.

Accepts either the raw payload (shown below) or a shared AgentVerbEnvelope wrapper of the same shape. The gateway normalises both forms before handling the request.

Enveloped form:

{
  "v": 1,
  "id": "<uuid-v7>",
  "ts": "2026-04-17T13:41:22.814Z",
  "payload": { "instance_id": "...", "current_sessions": 3 }
}

All fields other than instance_id are optional. Agents should emit a heartbeat every 30 s (the shared HEARTBEAT_INTERVAL_MS) and immediately on any status change. The same payload shape is sent as a heartbeat frame over the connected-mode WebSocket.

instance_id

string

required

The registered instance sending the heartbeat.

status

enum<string>

Self-reported routing liveness. Optional — if omitted the gateway keeps the previously reported value.

Available options:

available,

busy,

draining,

offline,

unhealthy,

unknown

current_sessions

integer

Number of sessions currently bound to this instance. Drives the least-loaded router tie-break.

Required range: x >= 0

max_concurrent_sessions

integer

Upper bound on concurrent sessions. 0 means unlimited.

Required range: x >= 0

consecutive_failures

integer

Number of consecutive dispatch failures observed by the agent. Informational; the mesh tracks authoritative failure counts server-side.

Required range: x >= 0

Response

Heartbeat acknowledged.

boolean

required