Skip to main content

​
listWorkspaces

GET /workspaces Returns a paginated list of workspaces the user has access to. Parameters:
FieldTypeRequiredDescription
cursorstringNoPagination cursor
limitnumberNoItems per page
Returns: ListWorkspaces
FieldTypeDescription
dataWorkspaceResponse[]Workspace list
paginationobject{ has_more, next_cursor, total }
Example: 
const workspaces = await client.listWorkspaces({ limit: 10 });
workspaces.data.forEach(ws => console.log(ws.name, ws.slug));

​
getWorkspace

GET /workspaces/{teamSlug} Returns details about a specific workspace. Parameters:
FieldTypeRequiredDescription
teamSlugstringYesWorkspace slug
Returns: WorkspaceResponse — workspace details.

​
getWorkspaceNodes

GET /workspaces/{teamSlug}/nodes Returns the list of nodes available to a workspace. Parameters:
FieldTypeRequiredDescription
teamSlugstringYesWorkspace slug
Returns: Array of node information.

​
getWorkspaceQuotas

GET /workspaces/{teamSlug}/quotas Returns resource quotas and usage for a workspace. Parameters:
FieldTypeRequiredDescription
teamSlugstringYesWorkspace slug
Returns: GetWorkspaceQuotas
FieldTypeDescription
team_slugstringWorkspace slug
tierstringWorkspace tier
quotasobjectResource limits: vm_slots, vcpu, memory_mb, disk_gb (each has limit and remaining)
reserved_nodesobject{ limit, remaining }
reserved_gpuobject{ gpus, in_use, misconfigured }
Example: 
const quotas = await client.getWorkspaceQuotas({ teamSlug: "my-team" });
console.log(`VM slots: ${quotas.quotas.vm_slots.remaining}/${quotas.quotas.vm_slots.limit}`);