Skip to main content
POST
/
api
/
v0
/
workergroups
/
create workergroup
curl --request POST \
  --url https://console.vast.ai/api/v0/workergroups/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "endpoint_name": "vLLM-Qwen3-8B",
  "endpoint_id": 123,
  "template_hash": "abc123def456",
  "template_id": 456,
  "search_params": "gpu_name=RTX_3090 rentable=true",
  "launch_args": "--env VAR=value",
  "min_load": 1,
  "target_util": 0.9,
  "cold_mult": 3,
  "cold_workers": 3,
  "max_workers": 20,
  "test_workers": 3,
  "gpu_ram": 24
}'
{
  "success": true,
  "id": 789
}

Authorizations

​
Authorization
string
header
required

API key must be provided in the Authorization header

Body

application/json
​
endpoint_name
string

Name of the endpoint group

Example:

"vLLM-Qwen3-8B"

​
endpoint_id
integer

ID of existing endpoint group (alternative to endpoint_name)

Example:

123

​
template_hash
string

Hash ID of template to use for worker instances

Example:

"abc123def456"

​
template_id
integer

ID of template (alternative to template_hash)

Example:

456

​
search_params
string
default:verified=true rentable=true rented=false

Search query for finding worker instances (alternative to template)

Example:

"gpu_name=RTX_3090 rentable=true"

​
launch_args
string

Additional launch arguments for worker instances

Example:

"--env VAR=value"

​
min_load
number
default:1

Minimum load threshold for scaling

Example:

1

​
target_util
number
default:0.9

Target GPU utilization

Example:

0.9

​
cold_mult
number
default:3

Cold start multiplier

Example:

3

​
cold_workers
integer
default:3

Number of cold workers to maintain

Example:

3

​
max_workers
integer
default:20

Maximum number of worker instances

Example:

20

​
test_workers
integer
default:3

Number of test workers

Example:

3

​
gpu_ram
integer
default:24

Minimum GPU RAM in GB

Example:

24

Response

Successfully created workergroup

​
success
boolean
Example:

true

​
id
integer

ID of created autoscaling job

Example:

789