Skip to main content

Documentation Index

Fetch the complete documentation index at: https://vastai-80aa3a82-feat-host-3113-dynamic-resize.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

The Vast.ai REST API gives you programmatic control over the entire platform. It’s the foundation that the CLI and SDK are built on.
The raw REST API is intended for advanced users only. Most users will have a better experience with the CLI or SDK, which handle authentication, retries, and request shape for you. Reach for the API directly when you need maximum flexibility, are integrating from a non-Python language, or are building tooling on top of Vast.

Quickstart

New to the API? Start with the API Hello World, it walks through the full instance lifecycle (authenticate, search, rent, connect, clean up) using only curl.

Reference sections

SectionWhat’s covered
AuthenticationBearer-token auth, API key generation and management
PermissionsScoped API keys, role-based access
Rate limits & errorsPer-endpoint limits, error codes, retry guidance
Creating instancesSearch-and-rent flow, configuration options
TemplatesTemplate fields, creation, instance launch
EndpointsFull OpenAPI reference for every endpoint

Base URL

https://console.vast.ai/api/v0
All endpoints require Authorization: Bearer $VAST_API_KEY. Get your key from the Keys page.