Skip to main content
Effective Date — May 7, 2026
As part of the IAM hierarchy simplification, a new format of the TIR APIs is now available. All endpoints that previously included /teams/:team_id segment will now follow a service-centric structure, with project_id now passed as a query parameter instead of a path segment. You can read more about this change

Create Instance / VM

Creates a new compute resource.

To create a Virtual Machine, set "kind": "vm" in the request body along with "image_type": "pre-built" and a valid sku_item_price_id from the Plans List API.

Omitting kind (or setting it to any other value) creates a container-based Instance.

Note: pfs_id, local_pv_id, and is_spot_instance are not supported for VMs.

POST/notebooks/

Query parameters

  • project_idQueryintegerrequired

    Project ID

  • active_iamQueryintegeroptional

    Active IAM ID (To access contact person account) Find your Active IAM ID here

  • locationQuerystringrequired

    Location

Request body

application/json

object
namestring
examplenode-111316563232
cluster_typestring
exampletir-cluster
image_typestring
examplepre-built
is_jupyterlab_enabledboolean
exampletrue
notebook_typestring
examplenew
notebook_urlstring
example
disk_size_in_gbinteger
example30
dataset_id_listarray
enable_sshboolean

Ignored by the backend. SSH access is determined solely by whether public_key is provided. Include this field for compatibility but it has no effect.

examplefalse
add_onsarray
init_script_id_listarray

List of initialization script IDs

sfs_pathstring
example/mnt/sfs
image_version_idinteger
example59
sku_idinteger
example4
sku_item_price_idinteger
example4
app_idinteger
example1
instance_typestring
examplepaid_usage
kindstringvm

Set to "vm" to create a full OS Virtual Machine instead of a container-based Instance. Omit or leave empty for Instances.

examplevm
public_keyarray

SSH public key strings to authorize at creation time. The key must already be saved in your TIR account (via Security → SSH Keys) — the backend looks up keys by exact string match against your saved keys. Providing an unregistered key string is silently ignored and SSH will remain disabled. This is the only way to enable SSH; enable_ssh has no effect.

security_group_idinteger

ID of a Security Group to attach at creation time.

example11442
is_pvc_encryptedboolean

Whether to encrypt the workspace disk. Defaults to false.

examplefalse
pfs_pathstring

Mount path for Parallel File Storage (not supported for VMs).

example/mnt/pfs
pfs_read_onlyboolean

Whether to mount PFS in read-only mode (not supported for VMs).

examplefalse

Responses

201Node created successfully
object
codeinteger
example201
messagestring
exampleCreated Successfully
dataobject
errorsobject