Skip to main content
POST
/
presence
/
{agent_id}
/
heartbeat
Heartbeat
curl --request POST \
  --url https://api.example.com/presence/{agent_id}/heartbeat \
  --header 'Content-Type: application/json' \
  --data '
{
  "activity": "<string>",
  "resource_id": "<string>"
}
'
{
  "agent_id": "<string>",
  "agent_type": "external",
  "name": "<string>",
  "organization_id": "<string>",
  "activity": "<string>",
  "resource_id": "<string>",
  "registered_at": "2023-11-07T05:31:56Z",
  "last_heartbeat": "2023-11-07T05:31:56Z"
}

Path Parameters

​
agent_id
string
required

Body

application/json

Request body for updating presence heartbeat.

Attributes: activity: Updated activity description, if changed. resource_id: Updated resource being worked on, if changed.

​
activity
string | null
​
resource_id
string | null

Response

Successful Response

Presence registration for an active agent or human session.

Attributes: agent_id: Unique identifier for the connected agent or session. agent_type: Whether the agent is external (MCP), internal, or human. name: Human-readable display name. organization_id: Organization the agent belongs to. activity: Description of current activity, if any. resource_id: Resource the agent is currently working on, if any. registered_at: Timestamp when presence was first registered. last_heartbeat: Timestamp of the most recent heartbeat.

​
agent_id
string
required
​
agent_type
enum<string>
required

Type of agent connected to the platform.

Available options:
external,
internal,
human
​
name
string
required
​
organization_id
string
required
​
activity
string | null
​
resource_id
string | null
​
registered_at
string<date-time>
​
last_heartbeat
string<date-time>