Skip to main content

Reference

Every Sessions field with its type, default, and constraint.

Reference

Field reference for the Sessions create/update API. Required fields are marked.

FieldTypeDefaultConstraint / Notes
namestring(required)DNS-1123 label: lowercase letters, digits, dashes; max 63 chars.
imagestring(required)Container image reference. Presets: jupyter-pytorch, jupyter-tensorflow, codeserver-python, rstudio.
compute_profilestringworkspace defaultMust be a profile that exists in this workspace.
cpustringprofile defaultQuantity (e.g. 2, 4000m). Override of profile's CPU.
memorystringprofile defaultQuantity (e.g. 8Gi, 32Gi). Override of profile's memory.
gpu_vendorenumprofile defaultnvidia.com/gpu, amd.com/gpu, habana.ai/gaudi, or none.
gpu_countint0Whole number. Only non-zero on GPU-capable profiles.
workspace_volumeobjectnew 5 GiB PVC{create: true, size: "5Gi"} or {claim: "existing-pvc-name"}.
data_volumesobject[][]Each item: {claim, mount_path, read_only}.
configurationsstring[][]List of named pod-defaults the admin published.
envobject{}Map of env-var name → string value.
⌘I