Skip to main content

Vast.ai Python SDK

This package is deprecated. It has been merged into vast-ai/vast-cli. pip install vastai now installs both the SDK and CLI in a single package. pip install vastai-sdk still works and installs the same package. For issues and PRs, go to vast-ai/vast-cli.

Install

pip install vastai-sdk

Quickstart

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

  2. Set your API key:

from vastai_sdk import VastAI
vast = VastAI(api_key="YOUR_API_KEY")

Or set the VAST_API_KEY environment variable and just use:

vast = VastAI()

SDK Usage

Both of these work identically:

from vastai_sdk import VastAI
from vastai import VastAI

Both of these also work identically:

from vastai import Serverless
from vastai_sdk.serverless.client.client import Serverless
vast = VastAI()

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.

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.

Contributing

This repo is deprecated. For issues, PRs, and documentation, go to vast-ai/vast-cli.

Download files

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

Source Distribution

vastai_sdk-1.5.5.tar.gz (1.8 kB view details)

Uploaded Source

Built Distribution

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

vastai_sdk-1.5.5-py3-none-any.whl (2.2 kB view details)

Uploaded Python 3

File details

Details for the file vastai_sdk-1.5.5.tar.gz.

File metadata

  • Download URL: vastai_sdk-1.5.5.tar.gz
  • Upload date:
  • Size: 1.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.12.13 Linux/6.17.0-1022-azure

File hashes

Hashes for vastai_sdk-1.5.5.tar.gz
Algorithm Hash digest
SHA256 59fdbe5bbce54e1ca948d787fa2d48d740d727bdca635752fef0cc904dd1dcf0
MD5 18fec5ddb868f3ac3bd2f0379e675b36
BLAKE2b-256 5b2c607a084e7777012c2e2a6e7916b2bf87bb9b8d1145b50882994d1efc2e7d

See more details on using hashes here.

File details

Details for the file vastai_sdk-1.5.5-py3-none-any.whl.

File metadata

  • Download URL: vastai_sdk-1.5.5-py3-none-any.whl
  • Upload date:
  • Size: 2.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.12.13 Linux/6.17.0-1022-azure

File hashes

Hashes for vastai_sdk-1.5.5-py3-none-any.whl
Algorithm Hash digest
SHA256 c54e7c35582ef85e0614f9aac00e6eb9c234774a95c5d9a0aadbd690d3fa46ac
MD5 a9c4ad1c6c7b8744bff04d390d18b460
BLAKE2b-256 7a3892eb9a327d97d7fa9fbf6211ad31d00be58b84600db8ced32e5a96f248fa

See more details on using hashes here.

Release history Release notifications | RSS feed

Supported by

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