Skip to main content
POST
/
clusters
/
create
/clusters/create
curl --request POST \
  --url https://api.shadeform.ai/v1/clusters/create \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "protestant-aquamarine-cluster",
  "cloud": "denvr",
  "region": "houston-usa-1",
  "cluster_type": "H100_sxm5x8",
  "num_instances": 2,
  "ssh_key_id": "f0c6ac6d-7240-4968-8eb7-a11c4a0a5dc6",
  "os": "ubuntu20.04"
}
'
{
  "id": "8eda86fe-0f36-41ed-9837-0ccf8f6e0fcb"
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
name
string
required

The name of the cluster.

Example:

"protestant-aquamarine-cluster"

​
cloud
string
required

The cloud provider for the cluster.

Example:

"denvr"

​
region
string
required

The region where the cluster will be deployed.

Example:

"houston-usa-1"

​
cluster_type
string
required

The type of GPU cluster to create.

Example:

"H100_sxm5x8"

​
num_instances
integer
required

The number of instances in the cluster.

Example:

2

​
ssh_key_id
string

The SSH key ID to use for the cluster instances.

Example:

"f0c6ac6d-7240-4968-8eb7-a11c4a0a5dc6"

​
os
string

The operating system for the cluster.

Example:

"ubuntu20.04"

Response

200 - application/json

Returns a CreateClusterResponse object

Response of the /clusters/create API call

​
id
string<uuid>
required

The unique identifier for the newly created cluster.

Example:

"8eda86fe-0f36-41ed-9837-0ccf8f6e0fcb"