POST
/
instances
/
create

The example in the right sidebar is a schema only and will not work out of the box. Only ‘docker_configuration’ or ‘script_configuration’ can be specified but not both.

See the following tutorials related to instance creation:

Creating an Instance

Creating an Instance with a Running Container

Creating an Instance with a Startup Script

Authorizations

X-API-KEY
string
headerrequired

Body

application/json
cloud
enum<string>
required

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

Available options:
aws,
azure,
lambdalabs,
tensordock,
runpod,
latitude,
jarvislabs,
oblivus,
paperspace,
datacrunch,
massedcompute,
vultr
region
string
required

Specifies the region.

shade_instance_type
string
required

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

shade_cloud
boolean
required

Specifies if the instance is launched in Shade Cloud or in a linked cloud account.

name
string
required

The name of the instance

launch_configuration
object

Defines automatic actions after the instance becomes active.

os
string

The operating system of the instance.

volume_ids
string[]

List of volume IDs to be mounted. Currently only supports 1 volume at a time.

ssh_key_id
string

The ID of the SSH Key.

Response

200 - application/json
id
string
required

The unique identifier for the instance. Used in the instances for the /instances/{id}/info and /instances/{id}/delete APIs.

cloud_assigned_id
string
required

The unique identifier of the instance issued by the underlying cloud provider.

/instances/{id}/info