Skip to main content
POST
Start Worker For Queue

Authorizations

Authorization
string
header
required

Enter your Kubiya API token (format: Bearer )

Path Parameters

queue_id
string
required

Body

application/json

Worker start request with SDK version and system info

worker_sdk_version
string | null
system_info
WorkerSystemInfo · object | null

Worker system information

control_plane_url
string | null

Response

Successful Response

Worker start configuration

worker_id
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
heartbeat_interval
integer
required
litellm_api_url
string
required
litellm_api_key
string
required
queue_name
string
required
environment_name
string
required
queue_id
string
required
control_plane_sdk_version
string
required
queue_ephemeral
boolean
default:false
queue_single_execution
boolean
default:false
redis_url
string | null
redis_password
string | null
redis_enabled
boolean
default:false
websocket_enabled
boolean
default:true
websocket_url
string | null
websocket_features
string[]
nats_config
Nats Config · object | null