Sign in

/instances/{id}/info

Get details for an instance. The instance may be in any status.

get/instances/{id}/info

Path parameters

idstring required

The instance id

Response

Returns an instance 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'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.

cloud_instance_typestring required

The instance type for the underlying cloud provider. The CloudInstanceType is determined by the combination of the shade_instance_type, cloud, and num_gpus fields

cloud_assigned_idstring required

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

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

ipstring required

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

ssh_userstring required

The SSH user used to SSH into the instance.

ssh_portinteger required

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

status'pending' | 'active' | 'deleted' required

The status of the instance.

cost_estimatestring required

The cost incurred by the instance. This cost is only the cost billed by Shadeform. This does not include the underlying cloud provider cost if you are managing instances in your own cloud provider account.

hourly_priceinteger required

The base hourly price of the instance in cents. This cost does not include the Shadeform platform fee.

created_atstring date-time required

The timestamp of when the instance was created in UTC.

deleted_atstring date-time required

The timestamp of when the instance was deleted in UTC

Example response

{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "cloud": "tensordock",
  "region": "na-us-bos-1",
  "shade_instance_type": "A100",
  "cloud_instance_type": "A100_PCIE_40GB",
  "cloud_assigned_id": "13b057d7-e266-4869-985f-760fe75a78b3",
  "shade_cloud": true,
  "name": "cool-gpu-server",
  "configuration": {
    "memory_in_gb": 12,
    "storage_in_gb": 256,
    "vcpus": 6,
    "num_gpus": 1,
    "gpu_type": "A100",
    "interconnect": "pcie",
    "os": "ubuntu_22_shade_os"
  },
  "ip": "1.0.0.1",
  "ssh_user": "shadeform",
  "ssh_port": 22,
  "status": "active",
  "cost_estimate": "103.4",
  "hourly_price": 210,
  "launch_configuration": {
    "type": "docker",
    "args": "--model-id mistralai/Mistral-7B-v0.1",
    "image": "vllm/vllm-openai:latest"
  },
  "created_at": "2016-08-29T09:12:33.001Z",
  "deleted_at": "2016-08-29T09:12:33.001Z"
}

Changes