Skip to main content
POST
/
api
/
v1
/
workers
/
{worker_id}
/
heartbeat
Worker Heartbeat Simple
curl --request POST \
  --url https://control-plane.kubiya.ai/api/v1/workers/{worker_id}/heartbeat \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "active",
  "tasks_processed": 0,
  "current_task_id": "<string>",
  "worker_metadata": {},
  "system_info": {
    "hostname": "<string>",
    "platform": "<string>",
    "os_name": "<string>",
    "os_version": "<string>",
    "python_version": "<string>",
    "cli_version": "<string>",
    "docker_available": true,
    "docker_version": "<string>",
    "cpu_count": 123,
    "cpu_percent": 123,
    "memory_total": 123,
    "memory_used": 123,
    "memory_percent": 123,
    "disk_total": 123,
    "disk_used": 123,
    "disk_percent": 123,
    "uptime_seconds": 123
  },
  "logs": [
    "<string>"
  ]
}'
This response does not have an example.

Path Parameters

worker_id
string
required

Body

application/json

Simplified heartbeat request (worker_id in URL)

status
string
default:active
tasks_processed
integer
default:0
current_task_id
string | null
worker_metadata
object
system_info
object | null

Worker system information

logs
string[] | null

Response

Successful Response