---
title: "/instances/create"
method: POST
path: "/instances/create"
---

# /instances/create

`POST /instances/create`

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

## Request body

- CreateRequest
  - `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.
  - `region` string, 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_type` string, 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_cloud` boolean, 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.
  - `name` string, required — The name of the instance
  - `launch_configuration` LaunchConfiguration — Defines steps that can be automatically run on the instance after launching
    - `type` 'docker', required — Specifies the type of launch configuration. Currently only 'docker' is supported.
    - `args` string — When the docker launch configuration type is specified, this field describes the docker args to be attached to the docker run command.
    - `image` string, required — When the docker launch configuration type is specified, this field describes the docker image to be pulled and run on the instance at startup.
  - `os` string — The operating system of the instance.

## Response `200`

Returns a CreateResponse object

- CreateResponse — Response of the /instances/create API call
  - `id` string, 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_id` string, required — The unique identifier of the instance issued by the underlying cloud provider. This value is not useful at this time.

## Changes

- **2024-01-11** `7d5677457388` — 3 breaking, 10 warning, 15 info
  - added the new required request property `launch_configuration/image`
  - request property `cloud` was restricted to a list of enum values
  - removed the enum value `script` of the request property `launch_configuration/type`
  - removed the request property `alert`
  - …24 more

[Change history](https://skmtc.dev/shadeform/apis/shadeform-api/changes/instances/create/post.md)

---

[API](https://skmtc.dev/shadeform/apis/shadeform-api.md) · [All operations](https://skmtc.dev/shadeform/apis/shadeform-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/shadeform/shadeform-api/revisions/7d5677457388/schema)