Skip to content

getAgentStatus

GET
/agent/status
curl --request GET \
  --url http://localhost:8080/api/v1/agent/status \
  --cookie hs_session=<hs_session>

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Agent connections and queue health.

Media typeapplication/json
object
agents
required
Array<object>
object
tokenId
required
string
/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/
name
required
string
agentKind
required
string
Allowed values: hermes openclaw other
state
required
string
Allowed values: active idle never_connected
lastUsedAt
One of:
string format: date-time
queue
required
object
queued
required
integer
leased
required
integer
failedLast24h
required
integer
doneLast24h
required
integer
platforms
required
Array<object>
object
platform
required
string
Allowed values: instagram facebook line wechat bluesky x douyin xiaohongshu truthsocial
accounts
required
integer
due
required
integer
loginRequired
integer
lastIngestAt
One of:
string format: date-time

Examples

Exampleseed

Derived from fixtures/seed.json.

{
  "agents": [
    {
      "agentKind": "hermes",
      "lastUsedAt": "2026-10-17T08:54:00.000Z",
      "name": "Hermes on homeserver",
      "state": "active",
      "tokenId": "tok_01j9cx6fz4dthpcvht9zhkf4g4"
    }
  ],
  "platforms": [
    {
      "accounts": 2,
      "due": 1,
      "lastIngestAt": "2026-10-17T08:40:00.000Z",
      "loginRequired": 0,
      "platform": "instagram"
    },
    {
      "accounts": 1,
      "due": 0,
      "lastIngestAt": "2026-10-17T07:30:00.000Z",
      "loginRequired": 0,
      "platform": "facebook"
    },
    {
      "accounts": 1,
      "due": 1,
      "lastIngestAt": "2026-10-17T04:10:00.000Z",
      "loginRequired": 0,
      "platform": "xiaohongshu"
    },
    {
      "accounts": 1,
      "due": 0,
      "lastIngestAt": null,
      "loginRequired": 1,
      "platform": "douyin"
    },
    {
      "accounts": 2,
      "due": 2,
      "lastIngestAt": null,
      "loginRequired": 0,
      "platform": "x"
    }
  ],
  "queue": {
    "doneLast24h": 5,
    "failedLast24h": 0,
    "leased": 1,
    "queued": 2
  }
}