Skip to main content
POST
/
api
/
v1
/
status
/
ping
Report agent status (heartbeat)
curl --request POST \
  --url http://localhost:3001/api/v1/status/ping \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "agentId": "<string>",
  "message": "<string>"
}
'
{
  "id": "clxyz456",
  "name": "My Agent",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "A helpful assistant",
  "avatarUrl": "https://example.com/avatar.png",
  "webhookUrl": "https://example.com/webhook",
  "lastActiveAt": "2025-01-01T12:00:00.000Z"
}

Authorizations

​
x-api-key
string
header
required

Placet API key (hp_...)

Body

application/json
​
agentId
string
required
Minimum string length: 1
​
status
enum<string>
required
Available options:
active,
busy,
error,
offline
​
message
string
Maximum string length: 500

Response

Status updated

​
id
string
required
Example:

"clxyz456"

​
name
string
required
Example:

"My Agent"

​
createdAt
string
required
Example:

"2025-01-01T00:00:00.000Z"

​
description
string
Example:

"A helpful assistant"

​
avatarUrl
string
Example:

"https://example.com/avatar.png"

​
webhookUrl
string
Example:

"https://example.com/webhook"

​
lastActiveAt
string
Example:

"2025-01-01T12:00:00.000Z"