Sign in

/instances/create

Create and launch an instance with the selected cloud provider, GPU, region, and launch configurations.

post/instances/create

Request body

cloud'aws' | 'azure' | 'lambdalabs' | 'tensordock' | 'runpod' | 'latitude' | 'jarvislabs' | 'oblivus' | 'paperspace' | 'datacrunch' | 'massedcompute' | 'vultr' required

Specifies the underlying cloud provider that the instance is launched in. For the latest list of supported clouds, call the /instances/types API for all clouds.

regionstring required

Specifies the region in the underlying cloud provider that the instance is launched in. For the latest list of supported regions per cloud, call the instances/types API for all regions.

shade_instance_typestring required

The Shadeform standardized instance identifier for instances with a specific GPU configuration. We map the standardized Shade Instance Type to each cloud provider's instance type. For example, launching an 'A100' Shade Instance Type in TensorDock and in Paperspace will ensure that both instances will have an A100 GPU.

shade_cloudboolean required

If Shade Cloud is true, the instance will be launched in Shadeform's managed account. If Shade Cloud is false, Shadeform will check if you have provided an API Access Key for the specified cloud and launch the instance into your own cloud provider account. To launch in your own cloud provider account, you need to add your API Access Key for the cloud via the Shadeform Cloud Access Settings page at https://platform.shadeform.ai/settings/cloudaccess.

namestring required

The name of the instance

osstring

The operating system of the instance.

Example request

{
  "cloud": "tensordock",
  "region": "na-us-bos-1",
  "shade_instance_type": "A100",
  "shade_cloud": true,
  "name": "cool-gpu-server",
  "launch_configuration": {
    "type": "docker",
    "args": "--model-id mistralai/Mistral-7B-v0.1",
    "image": "vllm/vllm-openai:latest"
  },
  "os": "ubuntu22.04_cuda12.2_shade_os"
}

Response

Returns a CreateResponse object

idstring uuid required

The unique identifier for an instance managed by Shadeform. Used in the endpoint for the /instances/{id}/info and /instances/{id}/delete APIs.

cloud_assigned_idstring required

The unique identifier of the instance issued by the underlying cloud provider. This value is not useful at this time.

Example response

{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "cloud_assigned_id": "13b057d7-e266-4869-985f-760fe75a78b3"
}

Changes