API reference · Schema
CreateClusterRequest
namestringrequiredDisplay name
1–63 characters
member_countintegerrequiredNumber of identical members (2–16); member 0 is the head
2–16
hardwareobjectrequiredWhat each member runs on
ShowHide 2 fields of
hardwareskustringrequiredHardware SKU of every member
gpu_countintegerrequiredGPUs per member (0 for a CPU SKU)
0–8
regionstringrequiredRegion every member is placed in
imagestringContainer image (or give a template)
up to 512 characters
template_idstring | nullTemplate supplying the image and defaults
ID with prefix tpl_
Environment variables of every member
up to 128 items
ShowHide 2 fields of
envnamestringrequiredVariable name (the CLUSTER_RUNTIME_ prefix is reserved)
valuestringrequiredIts value
secret_envarray of ClusterSecretEnvVarEnvironment variables taken from project secrets
up to 128 items
ShowHide 2 fields of
secret_envnamestringrequiredVariable name
secret_idstringrequiredA secret of this project; its value is set when members start
ID with prefix sec_
commandarray of stringReplaces the image entrypoint
up to 64 items
argsarray of stringReplaces the image command
up to 256 items
container_disk_gbintegerWritable container disk of each member (default 50)
5–1000
registry_credential_idstring | nullCredential for a private image
ID with prefix rcr_
shared_volumeobject | nullOne volume mounted read-write at the same path on every member
ShowHide 2 fields of
shared_volumesize_gbintegerrequiredSize in GB (billed per GB-second while the cluster exists)
1–4096
mount_pathstringWhere every member mounts it (default /shared)
one_member_per_hostbooleanPlace every member on a host of its own (default false: members may share a host when it has room). When there are not enough such hosts the request fails with 409 `insufficient_capacity` and nothing is created.
{
"name": "llm-train",
"member_count": 2,
"hardware": {
"sku": "cpu-4c-16gb",
"gpu_count": 0
},
"region": "dev-local-1",
"image": "registry.example.com/team/train:1",
"env": [
{
"name": "GLOO_SOCKET_IFNAME",
"value": "eth0"
}
],
"shared_volume": {
"size_gb": 100,
"mount_path": "/shared"
}
}