API referenceCoordinator
API reference
Role heartbeat
Have a token? Manage tokens in the console
POST
A Role's pulse: the runner, the last turn it finished and how many open items it saw.
Needs scope coordinator:runner and coordinator:write.
bearerheader
AuthorizationBearer <JWT>An access token from the identity provider: a person's, or a customer's from the client credentials grant with an API key (developers.inorbit.hr). The gateway verifies it; the audience is iohr-api.
personality_id*stringThe Role's id.
iohr.coordinator.v1.HeartbeatRequest; path variables override their fields
application/json- body
iohr.coordinator.v1.HeartbeatRequest
account_id?stringlast_turn_id?stringopen_items_seen?integerFormat
int32personality_id?stringrunner_id?stringiohr.coordinator.v1.HeartbeatResponse
application/json- response
iohr.coordinator.v1.HeartbeatResponse
received_at*stringSDK
HTTP
import { ApiError, Public } from "@inorbithr/sdk";// Reads INORBIT_TOKEN, or INORBIT_KEY_ID and INORBIT_KEY_SECRET.const api = Public.fromEnv();try { const { value } = await api.coordinator.heartbeat("<personality_id>", {}); console.log(value);} catch (e) { if (!(e instanceof ApiError)) throw e; console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`); process.exitCode = 1;}npm install @inorbithr/sdk. Calls the package's public surface; an operation newer than your package needs the next release or a client generated for your account. The SDKs.
Example Response
{ "received_at": "string"}