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 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 is:starred and keyword filters for userName, computeEnvName, computeEnvType, status, label, collaborationMode, createdAfter, createdBefore, updatedAfter, and updatedBefore.
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 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 identifier.
checkpointId	integer	path	Required	Checkpoint identifier.
next	string	query	Optional	Cursor token pointing to the next log page, returned in a previous log response. Omit to retrieve the first page.
maxLength	integer	query	Optional	Maximum length, in bytes, of the log to retrieve.

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 identifier to restore when creating the Studio.
configuration	object	Optional	Studio resource allocation and environment configuration.
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.
configuration.mountDataV2	array	Optional	Array of data-link mounts with optional path prefixes. Can be null to preserve existing mounts, or an empty array to remove all mounts.
configuration.mountDataV2[].dataLinkId	string	Optional	Data-link identifier to mount in the Studio session.
configuration.mountDataV2[].path	string	Optional	Optional relative path within the data-link root to mount. Can be null to mount the data-link root.
configuration.sshEnabled	boolean	Optional	If true, enables SSH connections to the Studio session. Can be null.
isPrivate	boolean	Optional	If true, the Studio is private to the users listed in allowedUserIds, or to its creator when allowedUserIds is empty or omitted. If omitted, the Studio configuration and then the workspace default decide. false with users in allowedUserIds is rejected.
labelIds	array	Optional	Array of label 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.
remoteConfig.repository	string	Required	Remote repository URL.
remoteConfig.revision	string	Optional	Optional branch or tag to check out. Can be null.
remoteConfig.commitId	string	Optional	Optional commit hash pinned for the remote repository. Can be null.
allowedUserIds	array	Optional	Array of identifiers of the users allowed to connect to the Studio, which makes it private to exactly those users. The creator is included only if listed. An empty array is the same as omitting the field, in which case isPrivate decides. Can be null.
customIconId	string	Optional	Avatar identifier, returned by POST /avatars, for the Studio icon. If null, the icon is inherited from the parent checkpoint, if any. An empty string sets no icon, even if the parent checkpoint has one. A non-empty value assigns the referenced icon. Maximum 22 characters.
UpdateDataStudio			Update a Studio
configuration	object	Optional	Updated Studio resource allocation and environment configuration. Can be null.
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.
configuration.mountDataV2	array	Optional	Array of data-link mounts with optional path prefixes. Can be null to preserve existing mounts, or an empty array to remove all mounts.
configuration.mountDataV2[].dataLinkId	string	Optional	Data-link identifier to mount in the Studio session.
configuration.mountDataV2[].path	string	Optional	Optional relative path within the data-link root to mount. Can be null to mount the data-link root.
configuration.sshEnabled	boolean	Optional	If true, enables SSH connections to the Studio session. Can be null.
description	string	Optional	Optional Studio description. Maximum length is 2048 characters. Can be null.
labelIds	array	Optional	Array of label identifiers to apply to the Studio. Can be null.
name	string	Optional	Optional Studio session name. Must be between 1 and 80 characters when provided. Can be null.
computeEnvId	string	Optional	Compute environment identifier to move the Studio to. Must be compatible with the Studio's current compute environment: in the same workspace, with the same work directory, and available. Omit to keep the current compute environment. See GET /studios/{sessionId}/compatible-ce for compatible options.
customIconId	string	Optional	Avatar identifier, returned by POST /avatars, for the Studio icon. null preserves the current icon. An empty string clears the icon and deletes the previous one. A non-empty value assigns the referenced icon and deletes the previous one, if any. Maximum 22 characters.
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.
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.
configuration.mountDataV2	array	Optional	Array of data-link mounts with optional path prefixes. Can be null to preserve existing mounts, or an empty array to remove all mounts.
configuration.mountDataV2[].dataLinkId	string	Optional	Data-link identifier to mount in the Studio session.
configuration.mountDataV2[].path	string	Optional	Optional relative path within the data-link root to mount. Can be null to mount the data-link root.
configuration.sshEnabled	boolean	Optional	If true, enables SSH connections to the Studio session. Can be null.
description	string	Optional	Updated Studio description to apply when starting the session. null preserves the saved description.
labelIds	array	Optional	Array of label 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.
name	string	Optional	Optional Studio session name. Must be between 1 and 80 characters when provided. Can be null.
allowedUserIds	array	Optional	Array of identifiers of the users allowed to connect to the private Studio. Replaces the existing allow list; an empty or omitted array leaves it unchanged. The creator is included only if listed. Only the creator can change it, and only for a private Studio. Applied only if the Studio starts, but an invalid list is rejected either way.
customIconId	string	Optional	Avatar identifier, returned by POST /avatars, for the Studio icon. null preserves the current icon. An empty string clears the icon and deletes the previous one. A non-empty value assigns the referenced icon and deletes the previous one, if any. Maximum 22 characters.
failOnIncompleteCheckpoint	boolean	Optional	If true, the start fails with 409 Conflict instead of skipping an incomplete latest checkpoint. Default: false.