x-cpod-domain: workspaces

Workspaces

Platform workspaces — personal and shared containers for files, folders, and compute pods.

Try in explorer client.workspaces

Workspace

A personal or shared container for files, folders, and pods.

REST path/api/v1/workspaces

Operations

listgetcreateupdatedeletecreateFolderlistFoldersrenameFolderdeleteFolderensureHomelistFilesgetFiledownloadUrldeleteFilelistTrashrestoreTrash

SDK

// list — returns only your records; add filters/search:
await client.workspaces.list()

// create:
await client.workspaces.create({
  id: "rec_01HXEXAMPLE",
  name: "example name",
  created_at: "2026-01-01T00:00:00Z",
  updated_at: "2026-01-01T00:00:00Z",
  description: "example description",
  visibility: "personal",
})

Field	Type	Description
id*	uuid	Workspace UUID.
name*	string	Workspace display name.
description	string	Optional workspace description.
visibility	enum	Workspace visibility.`personalsharedpublic`
owner_id	uuid→UserProfile	Owning user.
organization_id	uuid→Organization	Owning organization.
created_at*	date-time	Creation timestamp.
updated_at*	date-time	Last update timestamp.

Folder

A named folder within a workspace for organizing files.

REST path/api/v1/workspaces/folders

Operations

createFolderlistFoldersrenameFolderdeleteFolderensureHome

SDK

// list — returns only your records; add filters/search:
await client.workspaces.list()

Field	Type	Description
id*	uuid	Folder UUID.
workspace_id*	uuid→Workspace	Owning workspace.
parent_id	uuid	Parent folder ID (null for root).
name*	string	Folder name.
created_at*	date-time	Creation timestamp.

WorkspaceFile

A file stored within a workspace folder.

REST path/api/v1/workspaces/files

Operations

listFilesgetFiledownloadUrldeleteFile

SDK

// list — returns only your records; add filters/search:
await client.workspaces.list()

Field	Type	Description
id*	uuid	File UUID.
workspace_id*	uuid→Workspace	Owning workspace.
folder_id	uuid→Folder	Containing folder.
name*	string	File name with extension.
size	integer	File size in bytes.
content_type	string	MIME type.
created_at*	date-time	Upload timestamp.

Docs

Workspace

Folder

WorkspaceFile