Workspaces

A Workspace is a simplified tool for researchers to conduct experiments, build AI models, access standard MLOps tools, and collaborate with their peers. Workspaces abstract complex concepts related to running containerized workloads in a Kubernetes environment and are built from predefined setups that include networking, storage, secrets and other resources. All the setup and configurations for research, including container images, data sets, resource requests, as well as all tools are included. for the research, in a single place. It answers the research needs while ensuring infrastructure owners keep control and allocation efficiency. A workspace is associated with a specific Run:ai project and you can have multiple workspaces under a specific project. For more information, see Workspaces.

Create a workspace [Experimental]

Create a new workspace in a specific project in the cluster.

SecuritybearerAuth

Request

Request Body schema: application/json

name required	string (WorkloadName) non-empty The name of the workload.
useGivenNameAsPrefix	boolean Default: false When true, the requested name will be treated as a prefix. The final name of the workload will be composed of the name followed by a random set of characters.
projectId required	string (ProjectId2) The id of the project.
clusterId required	string <uuid> (ClusterId) The id of the cluster.
	object or null (CommonFlatFields) Container overrideable fields. In the context of assets,these are environment asset fields that can be overriden in the submit workload request.

Responses

200

Request completed successfully.

400

Bad submission request.

401

Unauthorized

403

Forbidden

503

unexpected error

post/api/v1/workloads/workspaces

Request samples

Payload

application/json

{"name": "my-workload-name",
"useGivenNameAsPrefix": true,
"projectId": 1,
"clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
"spec": {"command": "python",
"args": "-x my-script.py",
"image": "python:3.8",
"imagePullPolicy": "Always",
"workingDir": "/home/myfolder",
"createHomeDir": true,
"probes": {"readiness": {"initialDelaySeconds": 0,
"periodSeconds": 1,
"timeoutSeconds": 1,
"successThreshold": 1,
"failureThreshold": 1,
"handler": {"httpGet": {"path": "string",
"port": 1,
"host": "example.com",
"scheme": "HTTP"
}
}
}
},
"nodeType": "my-node-type",
"nodePools": ["my-node-pool-a",
"my-node-pool-b"
],
"podAffinity": {"type": "Required",
"key": "string"
},
"tty": true,
"stdin": true,
"environmentVariables": [{"name": "HOME",
"value": "/home/my-folder",
"secret": {"name": "postgress_secret",
"key": "POSTGRES_PASSWORD"
},
"exclude": false
}
],
"annotations": [{"name": "billing",
"value": "my-billing-unit",
"exclude": false
}
],
"labels": [{"name": "stage",
"value": "initial-research",
"exclude": false
}
],
"tolerations": [{"name": "string",
"operator": "Equal",
"key": "string",
"value": "string",
"effect": "NoSchedule",
"seconds": 1
}
],
"terminateAfterPreemption": false,
"autoDeletionTimeAfterCompletionSeconds": 15,
"backoffLimit": 3,
"ports": [{"container": 8080,
"serviceType": "LoadBalancer",
"external": 30080,
"toolType": "pytorch",
"toolName": "my-pytorch",
"name": "port-instance-a"
}
],
"exposedUrls": [{"container": 8080,
"url": "https://my-url.com",
"authorizedUsers": ["user-a",
"user-b"
],
"authorizedGroups": ["group-a",
"group-b"
],
"toolType": "jupyter",
"toolName": "my-pytorch",
"name": "url-instance-a"
}
],
"relatedUrls": [{"url": "https://my-url.com",
"type": "wandb",
"name": "url-instance-a"
}
],
"priorityClass": "build",
"compute": {"gpuDevicesRequest": 1,
"gpuRequestType": "portion",
"gpuPortionRequest": 0.5,
"gpuPortionLimit": 0.5,
"gpuMemoryRequest": "10M",
"gpuMemoryLimit": "10M",
"migProfile": "1g.5gb",
"cpuCoreRequest": 0.5,
"cpuCoreLimit": 2,
"cpuMemoryRequest": "20M",
"cpuMemoryLimit": "30M",
"largeShmRequest": false,
"extendedResources": [{"resource": "hardware-vendor.example/foo",
"quantity": 2,
"exclude": false
}
]
},
"storage": {"dataVolume": [{"id": "123e4567-e89b-12d3-a456-426614174000",
"mountPath": "/mnt/data"
}
],
"pvc": [{"name": "storage-instance-a",
"existingPvc": false,
"claimName": "my-claim",
"path": "/container/my-claim",
"readOnly": false,
"ephemeral": false,
"claimInfo": {"size": "1G",
"storageClass": "my-storage-class",
"accessModes": {"readWriteOnce": true,
"readOnlyMany": false,
"readWriteMany": false
},
"volumeMode": "Filesystem"
}
}
],
"git": [{"name": "storage-instance-a",
"repository": "https://github.com/my-git/my-repo",
"branch": "main",
"revision": "string",
"path": "/container/my-repository",
"passwordSecret": "my-password-secret",
"secretKeyOfUser": "User",
"secretKeyOfPassword": "Password"
}
],
"configMapVolume": [{"name": "storage-instance-a",
"configMap": "string",
"mountPath": "string"
}
],
"secretVolume": [{"name": "storage-instance-a",
"secret": "string",
"mountPath": "string"
}
],
"hostPath": [{"name": "storage-instance-a",
"path": "/container/directory",
"readOnly": true,
"mountPath": "/local/directory",
"mountPropagation": "None"
}
],
"nfs": [{"name": "storage-instance-a",
"path": "/container/nfs",
"readOnly": true,
"server": "my.nfs.com",
"mountPath": "/local/nfs"
}
],
"s3": [{"name": "storage-instance-a",
"bucket": "my-bucket",
"path": "/container/my-bucket",
"url": "https://s3.amazonaws.com",
"accessKeySecret": "my-access-key-secret",
"secretKeyOfAccessKeyId": "AccessKeyId",
"secretKeyOfSecretKey": "SecretKey"
}
]
},
"security": {"uidGidSource": "fromTheImage",
"capabilities": ["CHOWN",
"KILL"
],
"seccompProfileType": "RuntimeDefault",
"runAsNonRoot": true,
"readOnlyRootFilesystem": false,
"runAsUid": 500,
"runAsGid": 30,
"supplementalGroups": "2,3,5,8",
"allowPrivilegeEscalation": false,
"hostIpc": false,
"hostNetwork": false
}
}
}

Response samples

application/json

{"name": "my-workload-name",
"requestedName": "string",
"workloadId": "06d16c5d-4728-42fa-b573-3b11820d999f",
"projectId": 1,
"departmentId": 2,
"clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
"createdBy": "test@lab.com",
"createdAt": "2022-01-01T03:49:52.531Z",
"desiredPhase": "Running",
"actualPhase": "Creating",
"spec": {"command": "python",
"args": "-x my-script.py",
"image": "python:3.8",
"imagePullPolicy": "Always",
"workingDir": "/home/myfolder",
"createHomeDir": true,
"probes": {"readiness": {"initialDelaySeconds": 0,
"periodSeconds": 1,
"timeoutSeconds": 1,
"successThreshold": 1,
"failureThreshold": 1,
"handler": {"httpGet": {"path": "string",
"port": 1,
"host": "example.com",
"scheme": "HTTP"
}
}
}
},
"nodeType": "my-node-type",
"nodePools": ["my-node-pool-a",
"my-node-pool-b"
],
"podAffinity": {"type": "Required",
"key": "string"
},
"tty": true,
"stdin": true,
"environmentVariables": [{"name": "HOME",
"value": "/home/my-folder",
"secret": {"name": "postgress_secret",
"key": "POSTGRES_PASSWORD"
},
"exclude": false
}
],
"annotations": [{"name": "billing",
"value": "my-billing-unit",
"exclude": false
}
],
"labels": [{"name": "stage",
"value": "initial-research",
"exclude": false
}
],
"tolerations": [{"name": "string",
"operator": "Equal",
"key": "string",
"value": "string",
"effect": "NoSchedule",
"seconds": 1
}
],
"terminateAfterPreemption": false,
"autoDeletionTimeAfterCompletionSeconds": 15,
"backoffLimit": 3,
"ports": [{"container": 8080,
"serviceType": "LoadBalancer",
"external": 30080,
"toolType": "pytorch",
"toolName": "my-pytorch",
"name": "port-instance-a"
}
],
"exposedUrls": [{"container": 8080,
"url": "https://my-url.com",
"authorizedUsers": ["user-a",
"user-b"
],
"authorizedGroups": ["group-a",
"group-b"
],
"toolType": "jupyter",
"toolName": "my-pytorch",
"name": "url-instance-a"
}
],
"relatedUrls": [{"url": "https://my-url.com",
"type": "wandb",
"name": "url-instance-a"
}
],
"priorityClass": "build",
"compute": {"gpuDevicesRequest": 1,
"gpuRequestType": "portion",
"gpuPortionRequest": 0.5,
"gpuPortionLimit": 0.5,
"gpuMemoryRequest": "10M",
"gpuMemoryLimit": "10M",
"migProfile": "1g.5gb",
"cpuCoreRequest": 0.5,
"cpuCoreLimit": 2,
"cpuMemoryRequest": "20M",
"cpuMemoryLimit": "30M",
"largeShmRequest": false,
"extendedResources": [{"resource": "hardware-vendor.example/foo",
"quantity": 2,
"exclude": false
}
]
},
"storage": {"dataVolume": [{"id": "123e4567-e89b-12d3-a456-426614174000",
"mountPath": "/mnt/data"
}
],
"pvc": [{"name": "storage-instance-a",
"existingPvc": false,
"claimName": "my-claim",
"path": "/container/my-claim",
"readOnly": false,
"ephemeral": false,
"claimInfo": {"size": "1G",
"storageClass": "my-storage-class",
"accessModes": {"readWriteOnce": true,
"readOnlyMany": false,
"readWriteMany": false
},
"volumeMode": "Filesystem"
}
}
],
"git": [{"name": "storage-instance-a",
"repository": "https://github.com/my-git/my-repo",
"branch": "main",
"revision": "string",
"path": "/container/my-repository",
"passwordSecret": "my-password-secret",
"secretKeyOfUser": "User",
"secretKeyOfPassword": "Password"
}
],
"configMapVolume": [{"name": "storage-instance-a",
"configMap": "string",
"mountPath": "string"
}
],
"secretVolume": [{"name": "storage-instance-a",
"secret": "string",
"mountPath": "string"
}
],
"hostPath": [{"name": "storage-instance-a",
"path": "/container/directory",
"readOnly": true,
"mountPath": "/local/directory",
"mountPropagation": "None"
}
],
"nfs": [{"name": "storage-instance-a",
"path": "/container/nfs",
"readOnly": true,
"server": "my.nfs.com",
"mountPath": "/local/nfs"
}
],
"s3": [{"name": "storage-instance-a",
"bucket": "my-bucket",
"path": "/container/my-bucket",
"url": "https://s3.amazonaws.com",
"accessKeySecret": "my-access-key-secret",
"secretKeyOfAccessKeyId": "AccessKeyId",
"secretKeyOfSecretKey": "SecretKey"
}
]
},
"security": {"uidGidSource": "fromTheImage",
"capabilities": ["CHOWN",
"KILL"
],
"seccompProfileType": "RuntimeDefault",
"runAsNonRoot": true,
"readOnlyRootFilesystem": false,
"runAsUid": 500,
"runAsGid": 30,
"supplementalGroups": "2,3,5,8",
"allowPrivilegeEscalation": false,
"hostIpc": false,
"hostNetwork": false
}
}
}

Delete a workspace [Experimental]

Delete a workspace using the workspace id.

SecuritybearerAuth

Request

path Parameters

workloadId

required

string <uuid>

Unique identifier of the workload.

Responses

204

No Content.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

delete/api/v1/workloads/workspaces/{workloadId}

Response samples

application/json

{"code": 401,
"message": "Issuer is not familiar."
}

Get workspace data [Experimental]

Retrieve workspace details using a workload id.

SecuritybearerAuth

Request

path Parameters

workloadId

required

string <uuid>

Unique identifier of the workload.

Responses

200

Executed successfully.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/workloads/workspaces/{workloadId}

Response samples

application/json

{"name": "my-workload-name",
"requestedName": "string",
"workloadId": "06d16c5d-4728-42fa-b573-3b11820d999f",
"projectId": 1,
"departmentId": 2,
"clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
"createdBy": "test@lab.com",
"createdAt": "2022-01-01T03:49:52.531Z",
"desiredPhase": "Running",
"actualPhase": "Creating",
"spec": {"command": "python",
"args": "-x my-script.py",
"image": "python:3.8",
"imagePullPolicy": "Always",
"workingDir": "/home/myfolder",
"createHomeDir": true,
"probes": {"readiness": {"initialDelaySeconds": 0,
"periodSeconds": 1,
"timeoutSeconds": 1,
"successThreshold": 1,
"failureThreshold": 1,
"handler": {"httpGet": {"path": "string",
"port": 1,
"host": "example.com",
"scheme": "HTTP"
}
}
}
},
"nodeType": "my-node-type",
"nodePools": ["my-node-pool-a",
"my-node-pool-b"
],
"podAffinity": {"type": "Required",
"key": "string"
},
"tty": true,
"stdin": true,
"environmentVariables": [{"name": "HOME",
"value": "/home/my-folder",
"secret": {"name": "postgress_secret",
"key": "POSTGRES_PASSWORD"
},
"exclude": false
}
],
"annotations": [{"name": "billing",
"value": "my-billing-unit",
"exclude": false
}
],
"labels": [{"name": "stage",
"value": "initial-research",
"exclude": false
}
],
"tolerations": [{"name": "string",
"operator": "Equal",
"key": "string",
"value": "string",
"effect": "NoSchedule",
"seconds": 1
}
],
"terminateAfterPreemption": false,
"autoDeletionTimeAfterCompletionSeconds": 15,
"backoffLimit": 3,
"ports": [{"container": 8080,
"serviceType": "LoadBalancer",
"external": 30080,
"toolType": "pytorch",
"toolName": "my-pytorch",
"name": "port-instance-a"
}
],
"exposedUrls": [{"container": 8080,
"url": "https://my-url.com",
"authorizedUsers": ["user-a",
"user-b"
],
"authorizedGroups": ["group-a",
"group-b"
],
"toolType": "jupyter",
"toolName": "my-pytorch",
"name": "url-instance-a"
}
],
"relatedUrls": [{"url": "https://my-url.com",
"type": "wandb",
"name": "url-instance-a"
}
],
"priorityClass": "build",
"compute": {"gpuDevicesRequest": 1,
"gpuRequestType": "portion",
"gpuPortionRequest": 0.5,
"gpuPortionLimit": 0.5,
"gpuMemoryRequest": "10M",
"gpuMemoryLimit": "10M",
"migProfile": "1g.5gb",
"cpuCoreRequest": 0.5,
"cpuCoreLimit": 2,
"cpuMemoryRequest": "20M",
"cpuMemoryLimit": "30M",
"largeShmRequest": false,
"extendedResources": [{"resource": "hardware-vendor.example/foo",
"quantity": 2,
"exclude": false
}
]
},
"storage": {"dataVolume": [{"id": "123e4567-e89b-12d3-a456-426614174000",
"mountPath": "/mnt/data"
}
],
"pvc": [{"name": "storage-instance-a",
"existingPvc": false,
"claimName": "my-claim",
"path": "/container/my-claim",
"readOnly": false,
"ephemeral": false,
"claimInfo": {"size": "1G",
"storageClass": "my-storage-class",
"accessModes": {"readWriteOnce": true,
"readOnlyMany": false,
"readWriteMany": false
},
"volumeMode": "Filesystem"
}
}
],
"git": [{"name": "storage-instance-a",
"repository": "https://github.com/my-git/my-repo",
"branch": "main",
"revision": "string",
"path": "/container/my-repository",
"passwordSecret": "my-password-secret",
"secretKeyOfUser": "User",
"secretKeyOfPassword": "Password"
}
],
"configMapVolume": [{"name": "storage-instance-a",
"configMap": "string",
"mountPath": "string"
}
],
"secretVolume": [{"name": "storage-instance-a",
"secret": "string",
"mountPath": "string"
}
],
"hostPath": [{"name": "storage-instance-a",
"path": "/container/directory",
"readOnly": true,
"mountPath": "/local/directory",
"mountPropagation": "None"
}
],
"nfs": [{"name": "storage-instance-a",
"path": "/container/nfs",
"readOnly": true,
"server": "my.nfs.com",
"mountPath": "/local/nfs"
}
],
"s3": [{"name": "storage-instance-a",
"bucket": "my-bucket",
"path": "/container/my-bucket",
"url": "https://s3.amazonaws.com",
"accessKeySecret": "my-access-key-secret",
"secretKeyOfAccessKeyId": "AccessKeyId",
"secretKeyOfSecretKey": "SecretKey"
}
]
},
"security": {"uidGidSource": "fromTheImage",
"capabilities": ["CHOWN",
"KILL"
],
"seccompProfileType": "RuntimeDefault",
"runAsNonRoot": true,
"readOnlyRootFilesystem": false,
"runAsUid": 500,
"runAsGid": 30,
"supplementalGroups": "2,3,5,8",
"allowPrivilegeEscalation": false,
"hostIpc": false,
"hostNetwork": false
}
}
}

Suspend a workspace [Experimental]

Suspend a workspace using the workspace id.

SecuritybearerAuth

Request

path Parameters

workloadId

required

string <uuid>

Unique identifier of the workload.

Responses

202

Accepted.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

post/api/v1/workloads/workspaces/{workloadId}/suspend

Response samples

application/json

{"code": 202,
"message": "Request has been accepted."
}

Resume a workspace [Experimental]

Resume the workspace operation using the workspace id.

SecuritybearerAuth

Request

path Parameters

workloadId

required

string <uuid>

Unique identifier of the workload.

Responses

202

Accepted.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

post/api/v1/workloads/workspaces/{workloadId}/resume

Response samples

application/json

{"code": 202,
"message": "Request has been accepted."
}

➔ Next to Trainings