Skip to main content

Send AI Runner Heartbeat

POST 
/api/support/agent/ai/runner-heartbeat

The AI agent's runner reports in: its version, the host it runs on, the sessions it is running and the size of its local queue. Sent on every check-in; the status reads as online for 5 minutes after the last one. A support.ai.changed push goes out only when the runner comes back online or its set of running sessions changes.

Required scope: support:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Request body

  • version (string, optional, max 64)
  • host (string, optional, max 255)
  • running (array, required — empty when idle, max 100): each {ticket_id (integer, required), phase (string, optional, max 40), started_at (ISO 8601, optional)}
  • queue_size (integer, optional, min 0, default 0)

The response is the new status (fields as in Get AI Agent Status).

Authentication: Bearer token with the support:write scope belonging to the AI agent's own account — any other caller, including support admins, gets a 403. No tenant context — this endpoint is central.

Request​

Responses​

OK

Response Headers
    Content-Type