Skip to main content
POST
/
api
/
v1
/
workers
/
{worker_id}
/
start
Start Worker
curl --request POST \
  --url https://control-plane.kubiya.ai/api/v1/workers/{worker_id}/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "system_info": {}
}
'
{
  "worker_id": "<string>",
  "worker_queue_name": "<string>",
  "environment_name": "<string>",
  "task_queue_name": "<string>",
  "temporal_namespace": "<string>",
  "temporal_host": "<string>",
  "temporal_api_key": "<string>",
  "organization_id": "<string>",
  "control_plane_url": "<string>",
  "litellm_api_url": "<string>",
  "litellm_api_key": "<string>",
  "heartbeat_interval": 60,
  "otel_enabled": true,
  "otel_exporter_otlp_endpoint": "<string>",
  "otel_service_name": "agent-control-plane-worker",
  "otel_traces_sampler": "parentbased_always_on",
  "otel_traces_sampler_arg": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.kubiya.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Enter your Kubiya API token (format: Bearer )

Path Parameters

​
worker_id
string
required

Body

application/json

Request to start a worker and fetch its config

​
system_info
System Info · object

Response

Successful Response

Worker configuration response

​
worker_id
string
required
​
worker_queue_name
string
required
​
environment_name
string
required
​
task_queue_name
string
required
​
temporal_namespace
string
required
​
temporal_host
string
required
​
temporal_api_key
string
required
​
organization_id
string
required
​
control_plane_url
string
required
​
litellm_api_url
string
required
​
litellm_api_key
string
required
​
heartbeat_interval
integer
default:60
​
otel_enabled
boolean
default:true
​
otel_exporter_otlp_endpoint
string | null
​
otel_service_name
string
default:agent-control-plane-worker
​
otel_traces_sampler
string
default:parentbased_always_on
​
otel_traces_sampler_arg
number | null