Reference

Field reference for the Presets (WorkspaceKind) API. Required fields are marked.

Preset (WorkspaceKind)

Field	Type	Default	Constraint / Notes
name	string	(required)	DNS-1123 label: lowercase letters, digits, dashes; max 63 chars. Immutable after creation.
display_name	string	same as name	Human-readable label shown in the UI.
description	string	""	Short explanation of the preset's purpose.
ide_type	enum	(required)	jupyterlab, vscode, or rstudio. Determines the icon and default image.
hidden	boolean	false	When true, the preset does not appear in the session wizard.
deprecated	boolean	false	When true, the preset shows a deprecation banner. Existing sessions continue to work.
icon.url	string	auto	URL for the preset's icon. Auto-set based on ide_type if omitted.
logo.url	string	auto	URL for the preset's logo.

Image catalog

Each preset exposes an ordered list of container images the user can pick from.

Field	Type	Default	Constraint / Notes
image_config.default	string	(first entry)	The image ID pre-selected in the session wizard.
image_config.values[].id	string	(required)	Unique identifier for this image (e.g. pytorch-23).
image_config.values[].display_name	string	same as id	Human-readable label (e.g. "PyTorch 2.3").
image_config.values[].description	string	""	What's included in this image.
image_config.values[].image_ref	string	(required)	Full container image reference (e.g. registry.example.com/pytorch:2.3-cuda12).

Pod sizes

Each preset defines one or more compute options.

Field	Type	Default	Constraint / Notes
pod_config.default	string	(first entry)	The pod size ID pre-selected in the session wizard.
pod_config.values[].id	string	(required)	Unique identifier (e.g. small, 1x-gpu).
pod_config.values[].display_name	string	same as id	Human-readable label (e.g. "Small", "1× GPU").
pod_config.values[].cpu	string	(required)	CPU quantity (e.g. 2, 4000m).
pod_config.values[].memory	string	(required)	Memory quantity (e.g. 8Gi, 32Gi).
pod_config.values[].gpu_count	int	0	Number of GPUs.
pod_config.values[].gpu_vendor	string	nvidia.com/gpu	nvidia.com/gpu, amd.com/gpu, or habana.ai/gaudi.

Storage

Field	Type	Default	Constraint / Notes
home_pvc	string	""	Name of the default home PVC. If empty, sessions create a new 5 GiB PVC.
data_pvcs[].claim	string	(required)	Name of the PVC to mount.
data_pvcs[].mount_path	string	(required)	Mount path inside the container (e.g. /data/datasets).
data_pvcs[].read_only	boolean	false	Whether the volume is mounted read-only.