VastAI.create_instances

Create multiple instances from a list of offer IDs.

Signature

VastAI.create_instances(
    ids: List[int],
    template_hash: Optional[str] = None,
    user: Optional[str] = None,
    disk: float = 10,
    image: Optional[str] = None,
    login: Optional[str] = None,
    label: Optional[str] = None,
    onstart: Optional[str] = None,
    onstart_cmd: Optional[str] = None,
    entrypoint: Optional[str] = None,
    ssh: bool = False,
    jupyter: bool = False,
    direct: bool = False,
    jupyter_dir: Optional[str] = None,
    jupyter_lab: bool = False,
    lang_utf8: bool = False,
    python_utf8: bool = False,
    extra: Optional[str] = None,
    env: Optional[str] = None,
    args: Optional[List[str]] = None,
    force: bool = False,
    cancel_unavail: bool = False,
    bid_price: Optional[float] = None,
    create_volume: Optional[int] = None,
    link_volume: Optional[int] = None,
    volume_size: Optional[int] = None,
    mount_path: Optional[str] = None,
    volume_label: Optional[str] = None
) -> str

Parameters

ids · List[int] · required

ids

template_hash · Optional[str]

template_hash

user · Optional[str]

user

disk · float · default: "10"

disk

image · Optional[str]

image

login · Optional[str]

login

label · Optional[str]

label

onstart · Optional[str]

onstart

onstart_cmd · Optional[str]

onstart_cmd

entrypoint · Optional[str]

entrypoint

ssh · bool · default: "False"

ssh

jupyter · bool · default: "False"

jupyter

direct · bool · default: "False"

direct

jupyter_dir · Optional[str]

jupyter_dir

jupyter_lab · bool · default: "False"

jupyter_lab

lang_utf8 · bool · default: "False"

lang_utf8

python_utf8 · bool · default: "False"

python_utf8

extra · Optional[str]

extra

env · Optional[str]

env

args · Optional[List[str]]

args

force · bool · default: "False"

force

cancel_unavail · bool · default: "False"

cancel_unavail

bid_price · Optional[float]

bid_price

create_volume · Optional[int]

create_volume

link_volume · Optional[int]

link_volume

volume_size · Optional[int]

volume_size

mount_path · Optional[str]

mount_path

volume_label · Optional[str]

volume_label

Returns

str — Result from the API call.

Example

from vastai import VastAI

client = VastAI(api_key="YOUR_API_KEY")
result = client.create_instances(ids=[12345])
print(result)