Runtimes

Register where an agent runs.

A runtime is where an agent runs: a service, a container or a workflow worker. Registering it lets the console show which agents are live, which version is running and when each last checked in.

Register a runtime#

POST https://api.cognaone.com/api/runtimes
Authorization: Bearer <agent token>
Content-Type: application/json

{
  "externalIdentifier": "claims-agent-prod-1",
  "version": "2.4.0"
}

Registration is idempotent: the same externalIdentifier returns the same runtime. Send a heartbeat to POST /api/runtimes/{id}/heartbeat to keep it current, and pass runtimeId on gate calls to tie decisions to the runtime that asked.

Last reviewed October 2026Suggest a change