Skip to main content

CLI and SDK for Vast.ai GPU Cloud Service

Project description

Vast.ai Python SDK & CLI

PyPI version

The official Vast.ai Python package — provides both the CLI and SDK for managing Vast.ai GPU cloud resources, plus a serverless client for endpoint inference.

Install

pip install vastai

Note: pip install vastai-sdk also works and installs the same package. Both package names are supported for backward compatibility.

Quickstart

  1. Get your API key from https://cloud.vast.ai/manage-keys/

  2. Set your API key:

vastai set api-key YOUR_API_KEY
  1. Test a search:
vastai search offers --limit 3

You should see a short list of available GPU offers.

CLI Usage

The vastai command provides full access to the Vast.ai platform from your terminal:

vastai search offers 'gpu_name=RTX_4090 num_gpus>=4'
vastai create instance 12345 --image pytorch/pytorch --disk 32 --ssh --direct
vastai show instances
vastai stop instance 12345
vastai destroy instance 12345

Run vastai --help for a full list of commands. You can also use --help on any subcommand:

vastai search offers --help
vastai create instance --help

SDK Usage

from vastai import VastAI

vast = VastAI()  # uses VAST_API_KEY env var, or pass api_key="..."

vast.search_offers(query='gpu_name=RTX_4090 num_gpus>=4')
vast.show_instances()
vast.start_instance(id=12345)
vast.stop_instance(id=12345)

Use help(vast.search_offers) to view documentation for any method.

Migrating from vastai-sdk? The old import still works: from vastai_sdk import VastAI

Using the Serverless Client

  1. Create the client
from vastai import Serverless
serverless = Serverless() # or, Serverless("YOUR_API_KEY")
  1. Get an endpoint
endpoint = await serverless.get_endpoint("my-endpoint")
  1. Make a request
request_body = {
    "model": "Qwen/Qwen3-8B",
    "prompt" : "Who are you?",
    "max_tokens" : 100,
    "temperature" : 0.7
}
response = await serverless.request("/v1/completions", request_body)
  1. Read the response
text = response["response"]["choices"][0]["text"]
print(text)

Find more examples in the examples/ directory.

Tab Completion

Tab completion is supported in Bash and Zsh via argcomplete (installed automatically). To enable it:

activate-global-python-argcomplete

Or for a single session:

eval "$(register-python-argcomplete vastai)"

Contributing

This repository is open source. If you find a bug, please open an issue. PRs are welcome.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vastai-1.0.3.tar.gz (204.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vastai-1.0.3-py3-none-any.whl (235.6 kB view details)

Uploaded Python 3

File details

Details for the file vastai-1.0.3.tar.gz.

File metadata

  • Download URL: vastai-1.0.3.tar.gz
  • Upload date:
  • Size: 204.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.4 CPython/3.12.13 Linux/6.17.0-1010-azure

File hashes

Hashes for vastai-1.0.3.tar.gz
Algorithm Hash digest
SHA256 8712dc68ba4205a2de9756b96b17a641c04eea97629e48995d849d3b106057d0
MD5 c0b1af68d3d99d4af21d3897a00acb90
BLAKE2b-256 1960c2acb321d16bac8ca1820d5fef9728b22594f57e8a840c90adf767657509

See more details on using hashes here.

File details

Details for the file vastai-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: vastai-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 235.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.4 CPython/3.12.13 Linux/6.17.0-1010-azure

File hashes

Hashes for vastai-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f58703ed807cdf33a8d7f94267129b239ab4a2329f6b649a7fb34ab0c96580a7
MD5 613506f7d9e3ef420f945812512568cc
BLAKE2b-256 9a3c205397f379dd29dcd86c990c9b0ef3db5f8590a52bf4efcad699942290f0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page