.mint-block {
    display: block
}
.mint-hidden {
    display: none
}
.mint-h-32 {
    height: 8rem
}
.dark\:mint-block:is(.dark *) {
    display: block
}
.dark\:mint-hidden:is(.dark *) {
    display: none
}

Introduction

X-API-KEY

Shadeform Documentation

Quickstart

Core Concepts

Tutorial Library

Setup a Volume

SSH Issues

Common SSH Issues and Solutions

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

Using Templates

/instances/create

Get details for the specified instance in the url.

/instances/{id}/info

Update mutable details about the instance. Set a value to null to delete it. Omit a value or leave undefined to keep unchanged.

/instances/{id}/update

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

/instances/{id}/delete

Restart an instance. The status of the instance will stay as 'active' throughout, but you may have to wait a few minutes for the instance to be ready to use again.

/instances/{id}/restart

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

/instances/types

/instances

/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.

/sshkeys/{id}/delete

/sshkeys

Set the specified SSH Key as the default SSH Key used by Shadeform.

/sshkeys/{id}/setdefault

/volumes/create

Get details for the specified storage volume.

/volumes/{id}/info

/volumes/{id}/delete

/volumes/types

/volumes

/templates

Get information about a specific template

/templates/{template_id}/info

/templates/featured

/templates/save

/templates/{template_id}/update

/templates/{template_id}/delete

Authentication

Support

Community

API Reference

Platform

Getting Started

Guides

Introduction

Quickstart

FAQ

Tutorial Library

API Documentation