API Reference

Admin

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Workspaces

Workspaces provide isolated environments for organizing predictions and pipeline runs across teams, projects, or customers. Each workspace has independent data retention settings and can be associated with workspace API keys.

Create a workspace

admin.workspaces.create(WorkspaceCreateParams**kwargs) -> WorkspaceCreateResponse

POST/compute/v1/admin/workspaces

List workspaces

admin.workspaces.list(WorkspaceListParams**kwargs) -> SyncCursorPage[WorkspaceListResponse]

GET/compute/v1/admin/workspaces

Get a workspace

admin.workspaces.retrieve(strworkspace_id) -> WorkspaceRetrieveResponse

GET/compute/v1/admin/workspaces/{workspace_id}

Update a workspace

admin.workspaces.update(strworkspace_id, WorkspaceUpdateParams**kwargs) -> WorkspaceUpdateResponse

POST/compute/v1/admin/workspaces/{workspace_id}

Archive a workspace

admin.workspaces.archive(strworkspace_id) -> WorkspaceArchiveResponse

POST/compute/v1/admin/workspaces/{workspace_id}/archive

Get a workspace spending limit

admin.workspaces.retrieve_spending_limit(strworkspace_id) -> WorkspaceRetrieveSpendingLimitResponse

GET/compute/v1/admin/workspaces/{workspace_id}/spending-limit

Set a workspace spending limit

admin.workspaces.set_spending_limit(strworkspace_id, WorkspaceSetSpendingLimitParams**kwargs) -> WorkspaceSetSpendingLimitResponse

PUT/compute/v1/admin/workspaces/{workspace_id}/spending-limit

ModelsExpand Collapse

class WorkspaceCreateResponse: …

id: str

Workspace ID

archived_at: Optional[datetime]

formatdate-time

created_at: datetime

formatdate-time

data_retention: DataRetention

How long result data is retained before automatic deletion. Defaults to 7 days if not specified. Maximum retention is 14 days (336 hours).

unit: Literal["hours", "days"]

Time unit for retention duration

One of the following:

"hours"

"days"

value: int

Duration value. Maximum retention is 14 days (or 336 hours).

minimum1

is_default: bool

Whether this is the default workspace

name: Optional[str]

Workspace name

updated_at: datetime

formatdate-time

class WorkspaceListResponse: …

id: str

Workspace ID

archived_at: Optional[datetime]

formatdate-time

created_at: datetime

formatdate-time

data_retention: DataRetention

How long result data is retained before automatic deletion. Defaults to 7 days if not specified. Maximum retention is 14 days (336 hours).

unit: Literal["hours", "days"]

Time unit for retention duration

One of the following:

"hours"

"days"

value: int

Duration value. Maximum retention is 14 days (or 336 hours).

minimum1

is_default: bool

Whether this is the default workspace

name: Optional[str]

Workspace name

updated_at: datetime

formatdate-time

class WorkspaceRetrieveResponse: …

id: str

Workspace ID

archived_at: Optional[datetime]

formatdate-time

created_at: datetime

formatdate-time

data_retention: DataRetention

How long result data is retained before automatic deletion. Defaults to 7 days if not specified. Maximum retention is 14 days (336 hours).

unit: Literal["hours", "days"]

Time unit for retention duration

One of the following:

"hours"

"days"

value: int

Duration value. Maximum retention is 14 days (or 336 hours).

minimum1

is_default: bool

Whether this is the default workspace

name: Optional[str]

Workspace name

updated_at: datetime

formatdate-time

class WorkspaceUpdateResponse: …

id: str

Workspace ID

archived_at: Optional[datetime]

formatdate-time

created_at: datetime

formatdate-time

data_retention: DataRetention

How long result data is retained before automatic deletion. Defaults to 7 days if not specified. Maximum retention is 14 days (336 hours).

unit: Literal["hours", "days"]

Time unit for retention duration

One of the following:

"hours"

"days"

value: int

Duration value. Maximum retention is 14 days (or 336 hours).

minimum1

is_default: bool

Whether this is the default workspace

name: Optional[str]

Workspace name

updated_at: datetime

formatdate-time

class WorkspaceArchiveResponse: …

id: str

Workspace ID

archived_at: Optional[datetime]

formatdate-time

created_at: datetime

formatdate-time

data_retention: DataRetention

How long result data is retained before automatic deletion. Defaults to 7 days if not specified. Maximum retention is 14 days (336 hours).

unit: Literal["hours", "days"]

Time unit for retention duration

One of the following:

"hours"

"days"

value: int

Duration value. Maximum retention is 14 days (or 336 hours).

minimum1

is_default: bool

Whether this is the default workspace

name: Optional[str]

Workspace name

updated_at: datetime

formatdate-time

class WorkspaceRetrieveSpendingLimitResponse: …

Configured lifetime workspace spending limit, or null if unset. Unset workspaces have no workspace-level cap and continue to use organization-level billing.

limit: Limit

amount: int

Workspace spending limit amount in milli-USD. Tracking starts when the limit is configured; prior or already-committed unreserved work is not counted in this workspace cap ledger.

minimum0

maximum9007199254740991

currency: Literal["MILLI_USD"]

Workspace spending limits currently support milli-USD only.

type: Literal["lifetime"]

class WorkspaceSetSpendingLimitResponse: …

Configured lifetime workspace spending limit, or null if unset. Unset workspaces have no workspace-level cap and continue to use organization-level billing.

limit: Limit

amount: int

Workspace spending limit amount in milli-USD. Tracking starts when the limit is configured; prior or already-committed unreserved work is not counted in this workspace cap ledger.

minimum0

maximum9007199254740991

currency: Literal["MILLI_USD"]

Workspace spending limits currently support milli-USD only.

type: Literal["lifetime"]