/instances/types

/instances/types

curl --request GET \
  --url https://api.shadeform.ai/v1/instances/types \
  --header 'X-API-KEY: <api-key>'

{
  "instance_types": [
    {
      "cloud": "hyperstack",
      "shade_instance_type": "A6000",
      "cloud_instance_type": "gpu_1x_a6000",
      "configuration": {
        "memory_in_gb": 12,
        "storage_in_gb": 256,
        "vcpus": 6,
        "num_gpus": 1,
        "gpu_type": "A100",
        "interconnect": "pcie",
        "vram_per_gpu_in_gb": 48,
        "os_options": [
          "ubuntu22.04_cuda12.2_shade_os",
          "ubuntu20.04_cuda12.0_shade_os"
        ],
        "gpu_manufacturer": "nvidia",
        "nvlink": true
      },
      "hourly_price": 210,
      "deployment_type": "vm",
      "availability": [
        {
          "region": "us-central-1",
          "available": true,
          "display_name": "US, Wichita, KS"
        },
        {
          "region": "us-central-2",
          "available": false,
          "display_name": "US, Wichita, KS"
        }
      ],
      "boot_time": {
        "min_boot_in_sec": 180,
        "max_boot_in_sec": 300
      }
    }
  ]
}

GET

instances

types

/instances/types

curl --request GET \
  --url https://api.shadeform.ai/v1/instances/types \
  --header 'X-API-KEY: <api-key>'

{
  "instance_types": [
    {
      "cloud": "hyperstack",
      "shade_instance_type": "A6000",
      "cloud_instance_type": "gpu_1x_a6000",
      "configuration": {
        "memory_in_gb": 12,
        "storage_in_gb": 256,
        "vcpus": 6,
        "num_gpus": 1,
        "gpu_type": "A100",
        "interconnect": "pcie",
        "vram_per_gpu_in_gb": 48,
        "os_options": [
          "ubuntu22.04_cuda12.2_shade_os",
          "ubuntu20.04_cuda12.0_shade_os"
        ],
        "gpu_manufacturer": "nvidia",
        "nvlink": true
      },
      "hourly_price": 210,
      "deployment_type": "vm",
      "availability": [
        {
          "region": "us-central-1",
          "available": true,
          "display_name": "US, Wichita, KS"
        },
        {
          "region": "us-central-2",
          "available": false,
          "display_name": "US, Wichita, KS"
        }
      ],
      "boot_time": {
        "min_boot_in_sec": 180,
        "max_boot_in_sec": 300
      }
    }
  ]
}

Authorizations

X-API-KEY

string

header

required

Query Parameters

cloud

string

Filter the instance type results by cloud.

region

string

Filter the instance type results by region.

num_gpus

string

Filter the instance type results by the number of gpus.

gpu_type

string

Filter the instance type results by gpu type.

shade_instance_type

string

Filter the instance type results by the shade instance type.

available

boolean

Filter the instance type results by availability.

sort

enum<string>

Sort the order of the instance type results.

Available options:

price

Response

200 - application/json

Returns an InstanceTypesResponse object

Response of /instances/types

instance_types

object[]

required

Show child attributes

instance_types.cloud

enum<string>

required

Specifies the underlying cloud provider. See this explanation for more details.

Available options:

lambdalabs,

paperspace,

vultr,

datacrunch,

latitude,

massedcompute,

imwt,

hyperstack,

nebius,

crusoe,

denvr,

digitalocean,

tcm,

hotaisle,

cudo,

scaleway,

evergreen,

excesssupply,

voltagepark,

boostrun,

ionstream,

whitefiber,

horizon,

fpt,

hydra,

amaya

Example:

"hyperstack"

instance_types.shade_instance_type

string

required

The Shadeform standardized instance type. See this explanation for more details.

Example:

"A6000"

instance_types.cloud_instance_type

string

required

The instance type for the underlying cloud provider. See this explanation for more details.

Example:

"gpu_1x_a6000"

instance_types.configuration

object

required

Show child attributes

instance_types.configuration.memory_in_gb

integer

required

The amount of memory for the instance in gigabytes. Note that this is not VRAM which is determined by GPU type and the number of GPUs.

Example:

12

instance_types.configuration.storage_in_gb

integer

required

The amount of storage for the instance. If this storage is too low for the instance type, please email [email protected] as the storage may be adjustable.

Example:

256

instance_types.configuration.vcpus

integer

required

The number of vCPUs for the instance.

Example:

6

instance_types.configuration.num_gpus

integer

required

The number of GPUs for the instance.

Example:

1

instance_types.configuration.gpu_type

string

required

The type of GPU for the instance.

Example:

"A100"

instance_types.configuration.interconnect

string

required

The type of GPU interconnect.

Example:

"pcie"

instance_types.configuration.vram_per_gpu_in_gb

integer

required

The video memory per GPU for the instance in gigabytes.

Example:

48

instance_types.configuration.os_options

string[]

required

The list of available operating systems for the instance.

Example:

[
  "ubuntu22.04_cuda12.2_shade_os",
  "ubuntu20.04_cuda12.0_shade_os"
]

instance_types.configuration.gpu_manufacturer

string

required

The manufacturer of the gpu

Example:

"nvidia"

instance_types.configuration.nvlink

boolean

If the instance has NVLink

Example:

true

instance_types.hourly_price

integer

required

The hourly price of the instance in cents.

Example:

210

instance_types.deployment_type

string

required

Whether the instance is a "vm" (virtual machine), a "container" (docker container), or "baremetal" (bare metal server).

Example:

"vm"

instance_types.availability

object[]

required

Show child attributes

instance_types.availability.region

string

required

Specifies the region.

Example:

"canada-1"

instance_types.availability.available

boolean

required

Indicate whether the instance is available in the region.

Example:

true

instance_types.availability.display_name

string

required

The display name of the region

Example:

"Toronto, Canana"

Example:

[
  {
    "region": "us-central-1",
    "available": true,
    "display_name": "US, Wichita, KS"
  },
  {
    "region": "us-central-2",
    "available": false,
    "display_name": "US, Wichita, KS"
  }
]

instance_types.boot_time

object

Show child attributes

instance_types.boot_time.min_boot_in_sec

integer

boot time minimum estimate

Example:

180

instance_types.boot_time.max_boot_in_sec

integer

boot time maximum estimate

Example:

300

/instances/{id}/restart /instances

⌘I

Instances

SSH Keys

Volumes

Templates

API Documentation

Authorizations

Query Parameters

Response