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

client.admin.workspaces.create(WorkspaceCreateParams { data_retention, name, spending_limit } body, RequestOptionsoptions?): WorkspaceCreateResponse { id, archived_at, created_at, 4 more }

POST/compute/v1/admin/workspaces

List workspaces

client.admin.workspaces.list(WorkspaceListParams { after_id, before_id, limit, name } query?, RequestOptionsoptions?): CursorPage<WorkspaceListResponse { id, archived_at, created_at, 4 more } >

GET/compute/v1/admin/workspaces

Get a workspace

client.admin.workspaces.retrieve(stringworkspaceID, RequestOptionsoptions?): WorkspaceRetrieveResponse { id, archived_at, created_at, 4 more }

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

Update a workspace

client.admin.workspaces.update(stringworkspaceID, WorkspaceUpdateParams { data_retention, name } body, RequestOptionsoptions?): WorkspaceUpdateResponse { id, archived_at, created_at, 4 more }

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

Archive a workspace

client.admin.workspaces.archive(stringworkspaceID, RequestOptionsoptions?): WorkspaceArchiveResponse { id, archived_at, created_at, 4 more }

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

Get a workspace spending limit

client.admin.workspaces.retrieveSpendingLimit(stringworkspaceID, RequestOptionsoptions?): WorkspaceRetrieveSpendingLimitResponse { limit, type } | null

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

Set a workspace spending limit

client.admin.workspaces.setSpendingLimit(stringworkspaceID, WorkspaceSetSpendingLimitParams { limit, type } body, RequestOptionsoptions?): WorkspaceSetSpendingLimitResponse { limit, type } | null

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

ModelsExpand Collapse

WorkspaceCreateResponse { id, archived_at, created_at, 4 more }

id: string

Workspace ID

archived_at: string | null

formatdate-time

created_at: string

formatdate-time

data_retention: DataRetention { unit, value }

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

unit: "hours" | "days"

Time unit for retention duration

One of the following:

"hours"

"days"

value: number

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

minimum1

is_default: boolean

Whether this is the default workspace

name: string | null

Workspace name

updated_at: string

formatdate-time

WorkspaceListResponse { id, archived_at, created_at, 4 more }

id: string

Workspace ID

archived_at: string | null

formatdate-time

created_at: string

formatdate-time

data_retention: DataRetention { unit, value }

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

unit: "hours" | "days"

Time unit for retention duration

One of the following:

"hours"

"days"

value: number

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

minimum1

is_default: boolean

Whether this is the default workspace

name: string | null

Workspace name

updated_at: string

formatdate-time

WorkspaceRetrieveResponse { id, archived_at, created_at, 4 more }

id: string

Workspace ID

archived_at: string | null

formatdate-time

created_at: string

formatdate-time

data_retention: DataRetention { unit, value }

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

unit: "hours" | "days"

Time unit for retention duration

One of the following:

"hours"

"days"

value: number

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

minimum1

is_default: boolean

Whether this is the default workspace

name: string | null

Workspace name

updated_at: string

formatdate-time

WorkspaceUpdateResponse { id, archived_at, created_at, 4 more }

id: string

Workspace ID

archived_at: string | null

formatdate-time

created_at: string

formatdate-time

data_retention: DataRetention { unit, value }

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

unit: "hours" | "days"

Time unit for retention duration

One of the following:

"hours"

"days"

value: number

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

minimum1

is_default: boolean

Whether this is the default workspace

name: string | null

Workspace name

updated_at: string

formatdate-time

WorkspaceArchiveResponse { id, archived_at, created_at, 4 more }

id: string

Workspace ID

archived_at: string | null

formatdate-time

created_at: string

formatdate-time

data_retention: DataRetention { unit, value }

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

unit: "hours" | "days"

Time unit for retention duration

One of the following:

"hours"

"days"

value: number

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

minimum1

is_default: boolean

Whether this is the default workspace

name: string | null

Workspace name

updated_at: string

formatdate-time

WorkspaceRetrieveSpendingLimitResponse { limit, type }

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, currency }

amount: number

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: "MILLI_USD"

Workspace spending limits currently support milli-USD only.

type: "lifetime"

WorkspaceSetSpendingLimitResponse { limit, type }

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, currency }

amount: number

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: "MILLI_USD"

Workspace spending limits currently support milli-USD only.

type: "lifetime"