curl --request POST \
--url https://control-plane.kubiya.ai/api/v1/workers/heartbeat \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"worker_id": "<string>",
"environment_name": "<string>",
"status": "active",
"tasks_processed": 0,
"current_task_id": "<string>",
"worker_metadata": {}
}
'{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Receive heartbeat from a worker.
OPTIMIZATION: Uses Redis for scalable heartbeat storage instead of database. Database writes are expensive and heartbeats happen every 30s per worker.
Workers should call this endpoint periodically (e.g., every 30 seconds) to:
curl --request POST \
--url https://control-plane.kubiya.ai/api/v1/workers/heartbeat \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"worker_id": "<string>",
"environment_name": "<string>",
"status": "active",
"tasks_processed": 0,
"current_task_id": "<string>",
"worker_metadata": {}
}
'{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Enter your Kubiya API token (format: Bearer
Successful Response
Was this page helpful?