Skip to main content
POST
/
api
/
v1
/
presence
/
heartbeat
Update Presence Heartbeat
curl --request POST \
  --url https://control-plane.kubiya.ai/api/v1/presence/heartbeat \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": "<string>",
  "user_email": "<string>",
  "user_name": "<string>",
  "user_avatar": "<string>",
  "agent_id": "<string>",
  "session_id": "<string>",
  "execution_id": "<string>",
  "is_typing": false
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Body

application/json
user_id
string
required
user_email
string | null
user_name
string | null
user_avatar
string | null
agent_id
string | null
session_id
string | null
execution_id
string | null
is_typing
boolean
default:false

Response

Successful Response