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
search	string	query	Optional	Optional search criteria, allowing free text search on name and templateUrl and keywords: userId, computeEnvId and status.
max	integer	query	Optional	Pagination max results
offset	integer	query	Optional	Pagination offset
attributes	array	query	Optional	Optional attribute values to be included in the response (labels). Returns an empty value (labels: null) if omitted.
autoStart	boolean	query	Optional	Optionally disable the Studio's automatic launch when it is created.
orgId	integer	query	Optional	Organization numeric identifier
status	string	query	Optional	Optional Studio status
exclude	string	query	Optional	Optional Studio session ID to exclude in the request.
name	string	query	Optional	Studio name to validate
sessionId	string	path	Required	Studio session numeric identifier
checkpointId	integer	path	Required	Numeric identifier of the checkpoint.

Request body parameters

Name	Type	Req/Opt	Description
CreateDataStudio			Create Studio
name	string	Required
description	string	Optional
dataStudioToolUrl	string	Required
computeEnvId	string	Required
initialCheckpointId	integer	Optional
configuration	object	Optional
configuration.gpu	integer	Optional
configuration.cpu	integer	Optional
configuration.memory	integer	Optional
configuration.mountData	array	Optional
configuration.environment	object	Optional
configuration.condaEnvironment	string	Optional
configuration.lifespanHours	integer	Optional
isPrivate	boolean	Optional
labelIds	array	Optional
spot	boolean	Optional
UpdateDataStudioCheckpoint			Update Studio checkpoint name
name	string	Optional
StartDataStudio			Starts a Studio
configuration	object	Optional
description	string	Optional
labelIds	array	Optional
spot	boolean	Optional