VastAI.create_instance

Create a new instance from a contract offer ID.

Signature

VastAI.create_instance(
    id: int,
    price: Optional[float] = None,
    disk: Optional[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,
    template_hash: Optional[str] = None
) -> str

Parameters

id · int · required

id

price · Optional[float]

price

disk · Optional[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

template_hash · Optional[str]

template_hash

Returns

str — Result from the API call.

Example

from vastai import VastAI

client = VastAI(api_key="YOUR_API_KEY")
result = client.create_instance(id=12345)
print(result)