Studios

Studios is a unified platform which hosts a combination of container images and compute environments for interactive analysis using preferred tools like JupyterLab and RStudio Notebooks, Visual Studio Code IDEs, or Xpra remote desktops. Each Studio session is an individual interactive environment that encapsulates the live environment for dynamic data analysis.

Path and query parameters

Name	Type	Location	Req/Opt	Description
workspaceId	integer	query	Optional	Workspace numeric identifier. When omitted, Studios are listed in the user context.
search	string	query	Optional	Free-text search filter to match against Studio name and templateUrl. Supports keyword filters for userId (Studio creator) and status (current Studio status).
max	integer	query	Optional	Maximum number of results to return. Default: 100.
offset	integer	query	Optional	Number of results to skip for pagination. Default: 0.
attributes	array	query	Optional	Optional attribute values to be included in the response. Supports labels. Returns an empty value (labels: null) if omitted.
autoStart	boolean	query	Optional	If true, automatically starts the Studio after creation. Default: true.
orgId	integer	query	Optional	Organization numeric identifier. When specified, lists mounted data-links in the organization context.
status	string	query	Optional	Studio status filter. Filters mounted data-links by the status of the Studios they are mounted in.
exclude	string	query	Optional	Studio session ID to exclude from the mounted data-links list.
name	string	query	Optional	Studio name to validate for availability.
sessionId	string	path	Required	Studio session string identifier.
checkpointId	integer	path	Required	Checkpoint numeric identifier.

Request body parameters

Name	Type	Req/Opt	Description
CreateDataStudio			Create Studio
name	string	Required	Studio name. Must be unique within the user or workspace context. Minimum length: 1 character, Maximum length: 100 characters.
description	string	Optional	Optional Studio description. Maximum length: 500 characters.
dataStudioToolUrl	string	Optional	Container image or Studio tool URL to use for the Studio session.
computeEnvId	string	Required	Compute environment ID where the Studio session will run.
initialCheckpointId	integer	Optional	Checkpoint numeric identifier to restore when creating the Studio.
configuration	object	Optional
configuration.gpu	integer	Optional	Number of GPUs allocated to the Studio session.
configuration.cpu	integer	Optional	Number of CPUs allocated to the Studio session.
configuration.memory	integer	Optional	Amount of memory in MiB allocated to the Studio session.
configuration.mountData	array	Optional	Deprecated array of data-link IDs mounted in the Studio session. This field only supports data-link IDs without path prefixes. Can be null to preserve existing mounts.
configuration.environment	object	Optional	Array of environment variable key-value pairs set in the Studio session.
configuration.condaEnvironment	string	Optional	Conda package specification for custom packages installed in the Studio environment.
configuration.lifespanHours	integer	Optional	Number of hours the Studio session will run before automatically stopping. A value of 0 indicates unlimited lifespan.
isPrivate	boolean	Optional	If true, only the Studio creator can connect to the session. Workspace administrators can still start, stop, and delete the Studio but cannot connect to it. Default: false.
labelIds	array	Optional	Array of label numeric identifiers to apply to the Studio.
spot	boolean	Optional	If true, requests spot or preemptible capacity when supported by the selected compute environment.
remoteConfig	object	Optional	Remote repository configuration used to pre-fill the Studio form. Can be null.
UpdateDataStudioCheckpoint			Update Studio checkpoint name
name	string	Optional	New checkpoint name. Must be unique per Studio. Spaces are automatically converted to underscores.
StartDataStudio			Start Studio
configuration	object	Optional	Updated Studio configuration to apply when starting the session. null preserves the saved configuration.
description	string	Optional	Updated Studio description to apply when starting the session. null preserves the saved description.
labelIds	array	Optional	Array of label numeric identifiers to apply when starting the Studio. null preserves the saved labels, while an empty array clears them.
spot	boolean	Optional	If true, requests spot or preemptible capacity for the started Studio when supported by the selected compute environment. null preserves the saved setting.