v4

latestOpenAPI 3.0.0raw.githubusercontent.com2026-04-06211660.4 KB
Status

Report agent status (heartbeat)

post/api/v1/status/ping

Request body

agentIdstring required
status'active' | 'busy' | 'error' | 'offline' required
messagestring

Response

Status updated

idstring required
namestring required
descriptionstring
avatarUrlstring
webhookUrlstring
lastActiveAtstring
createdAtstring required

Example response

{
  "id": "clxyz456",
  "name": "My Agent",
  "description": "A helpful assistant",
  "avatarUrl": "https://example.com/avatar.png",
  "webhookUrl": "https://example.com/webhook",
  "lastActiveAt": "2025-01-01T12:00:00.000Z",
  "createdAt": "2025-01-01T00:00:00.000Z"
}