Support

Community

X-API-KEY

Shadeform Documentation

API Reference

Platform

/instances

Specifies the underlying cloud provider. See this [explanation](/getting-started/concepts#cloud-cloud-provider) for more details.

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

The instance type for the underlying cloud provider. See this [explanation](/getting-started/concepts#shade-instance-type-and-cloud-instance-type) for more details.

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.

The amount of storage for the instance. If this storage is too low for the instance type, please email founders@shadeform.ai as the storage may be adjustable.

The video memory per GPU for the instance in gigabytes.

The cost incurred by the instance. This only the cost via Shadeform. If the instance is deployed in your own cloud account, then all billing is through your cloud provider.

The timestamp of when the instance was created in UTC.

The timestamp of when the instance was deleted in UTC.

May only be used if launch_configuration.type is 'docker'. Use docker_configuration to automatically pull and run a docker image. See this [tutorial](/guides/dockercontainers) for examples.

Specifies the container arguments passed into the image at runtime.

List of environment variable name-value pairs that will be passed to the docker container.

Specifies the docker image to be pulled and run on the instance at startup.

List of port mappings between the host instance and the docker container. Equivalent of -p flag for docker run command.

Describes the amount of shared memory allocated for the container. Equivalent to using the --shm-size flag in the docker cli. If shared_memory_in_gb is not specified, then the container will use the host namespace which is the equivalent of --ipc=host.

List of volume mounts between the host instance and the docker container. Equivalent of -v flag for docker run command.

Environment variables for the container image.

The hourly price of the instance in cents.

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

The public IP address of the instance. In select cases, it may also be the DNS.

Defines automatic actions after the instance becomes active.

Specifies the type of launch configuration. See [Launch Configuration](/getting-started/concepts#launch-configuration) for more details.

Maps the public instance port to a port on the container.

May only be used if launch_configuration.type is 'script'. Configures a startup script to be run automatically after the instance is active. See this [tutorial]/guides/startupscript) for examples.

Specifies if the instance is launched in [Shade Cloud](/getting-started/concepts#shade-cloud) or in a linked cloud account.

The Shadeform standardized instance type. See this [explanation](/getting-started/concepts#shade-instance-type-and-cloud-instance-type) for more details.

The SSH port of the instance. In most cases, this will be port 22 but for some clouds, this may be a different port.

The SSH user used to SSH into the instance.

Mounts the host volume to a container file path.

ApiKeyAuth

Introduction

Quickstart

Core Concepts

Tutorial Library

Run Docker Container

Run Startup Script

Run Jupyter Notebook

Bring Your Own SSH Keys

Most Affordable GPU

Find and Deploy the Most Affordable GPU

Serve Model Using vLLM

Setup Firewall Using UFW

Evaluate Language Models

/instances/create

Get details for the specified instance in the url.

/instances/{id}/info

Delete an instance. Some cloud providers may only allow deletion of an instance after it has moved to the 'active' status.

/instances/{id}/delete

Return all the GPU instance types with their corresponding availability and specs.

/instances/types

/sshkeys/add

Get details for the specified SSH Key in the url.

/sshkeys/{id}/info

Delete an ssh key. The Shadeform managed SSH Key, current default ssh key, and in use SSH Keys cannot be deleted.

Instances

SSH Keys

Volumes

API Documentation

/instances

Authorizations

Response