Skip to main content
POST
/
api
/
v1
/
environments
/
{environment_id}
/
worker-queues
Create Worker Queue
curl --request POST \
  --url https://control-plane.kubiya.ai/api/v1/environments/{environment_id}/worker-queues \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "display_name": "<string>",
  "description": "<string>",
  "max_workers": 2,
  "heartbeat_interval": 60,
  "tags": [
    "<string>"
  ],
  "settings": {}
}'
{
  "id": "<string>",
  "organization_id": "<string>",
  "environment_id": "<string>",
  "name": "<string>",
  "display_name": "<string>",
  "description": "<string>",
  "status": "<string>",
  "max_workers": 123,
  "heartbeat_interval": 123,
  "tags": [
    "<string>"
  ],
  "settings": {},
  "created_at": "<string>",
  "updated_at": "<string>",
  "created_by": "<string>",
  "active_workers": 0,
  "task_queue_name": "<string>"
}

Path Parameters

environment_id
string
required

Body

application/json
name
string
required

Worker queue name (lowercase, no spaces)

Required string length: 2 - 50
display_name
string | null

User-friendly display name

description
string | null

Queue description

max_workers
integer | null

Max workers allowed (NULL = unlimited)

Required range: x >= 1
heartbeat_interval
integer
default:60

Seconds between heartbeats (lightweight)

Required range: 10 <= x <= 300
tags
string[]
settings
object

Response

Successful Response

id
string
required
organization_id
string
required
environment_id
string
required
name
string
required
display_name
string | null
required
description
string | null
required
status
string
required
max_workers
integer | null
required
heartbeat_interval
integer
required
tags
string[]
required
settings
object
required
created_at
string
required
updated_at
string
required
created_by
string | null
required
task_queue_name
string
required
active_workers
integer
default:0