Welcome to Vast.ai 's API documentation. Our API allows you to programmatically manage GPU instances, handle machine operations, and automate your AI/ML workflow. Whether you're running individual GPU instances or managing a fleet of machines, our API provides comprehensive control over all Vast.ai  platform features.

Introduction

A lower level organization that lives within an Endpoint. It consists of a template (with extra filters for search), a set of GPU instances (workers) created from that template, and hyperparameters.

Worker_Groups

The highest level clustering of instances for the autoscaler, consisting of a named endpoint string, a collection of Worker groups, and hyperparameters.

Endpoints

The Vast PyWorker is a Python web server designed to run alongside a machine learning model instance, providing autoscaler compatibility.

PyWorker

Worker_Group

Endpoint

The minimum number of workers you want to keep "cold" (meaning stopped and fully loaded) when your group has no load.

min_cold_workers

The maximum number of workers your router group can have.

max_workers

attach ssh-key

cancel copy

copy

cancel sync

cloud copy

change bid

create instance

destroy instance

manage instance

show instance

detach ssh-key

execute

show logs

prepay instance

reboot instance

recycle instance

show ssh-keys

show instances

Instances

cancel maint

cleanup machine

list machine

remove defjob

show reports

schedule maint

set defjob

set min-bid

show machines

unlist machine

Machines

create api-key

show api keys

create env-var

delete env var

show env vars

update env var

create ssh-key

show ssh keys

create subaccount

set user

delete api key

show api key

delete ssh key

update ssh key

reset api key

show connections

show ipaddrs

show subaccounts

show team role

show user

transfer credit

Accounts

create autogroup

create endpoint

delete autogroup

update autogroup

delete endpoint

show autogroup

show endpoints

update endpoint

Autoscaler

create team

create team role

destroy team

invite team member

remove team member

remove team role

show team members

update team role

show team roles

Team

create template

Templates

search templates

search benchmarks

search offers

Search

delete volume

rent volume

list volumes

search volumes

unlist volume

Volumes

search invoices

show deposit

show earnings

show invoices

Billing

Vast.ai API

Overview & quickstart

Commands

Permissions-and-authorization

Python SDK Usage