Skip to main content
POST
/
api
/
v1
/
workers
/
register
Register Worker
curl --request POST \
  --url https://control-plane.kubiya.ai/api/v1/workers/register \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "environment_name": "<string>",
  "hostname": "<string>",
  "worker_metadata": {}
}
'
{
  "worker_id": "<string>",
  "worker_token": "<string>",
  "environment_name": "<string>",
  "temporal_namespace": "<string>",
  "temporal_host": "<string>",
  "temporal_api_key": "<string>",
  "organization_id": "<string>",
  "control_plane_url": "<string>"
}

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 )

Body

application/json

Worker registration request

​
environment_name
string
required
​
hostname
string | null
​
worker_metadata
Worker Metadata · object

Response

Successful Response

Worker registration response with all config needed

​
worker_id
string
required
​
worker_token
string
required
​
environment_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