Skip to content
Go to Boltz API

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
POST/compute/v1/admin/workspaces
List workspaces
GET/compute/v1/admin/workspaces
Get a workspace
GET/compute/v1/admin/workspaces/{workspace_id}
Update a workspace
POST/compute/v1/admin/workspaces/{workspace_id}
Archive a workspace
POST/compute/v1/admin/workspaces/{workspace_id}/archive
Get a workspace spending limit
GET/compute/v1/admin/workspaces/{workspace_id}/spending-limit
Set a workspace spending limit
PUT/compute/v1/admin/workspaces/{workspace_id}/spending-limit
ModelsExpand Collapse
WorkspaceCreateResponse object { id, archived_at, created_at, 4 more }
id: string

Workspace ID

archived_at: string
formatdate-time
created_at: string
formatdate-time
data_retention: object { 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" or "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

Workspace name

updated_at: string
formatdate-time
WorkspaceListResponse object { id, archived_at, created_at, 4 more }
id: string

Workspace ID

archived_at: string
formatdate-time
created_at: string
formatdate-time
data_retention: object { 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" or "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

Workspace name

updated_at: string
formatdate-time
WorkspaceRetrieveResponse object { id, archived_at, created_at, 4 more }
id: string

Workspace ID

archived_at: string
formatdate-time
created_at: string
formatdate-time
data_retention: object { 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" or "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

Workspace name

updated_at: string
formatdate-time
WorkspaceUpdateResponse object { id, archived_at, created_at, 4 more }
id: string

Workspace ID

archived_at: string
formatdate-time
created_at: string
formatdate-time
data_retention: object { 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" or "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

Workspace name

updated_at: string
formatdate-time
WorkspaceArchiveResponse object { id, archived_at, created_at, 4 more }
id: string

Workspace ID

archived_at: string
formatdate-time
created_at: string
formatdate-time
data_retention: object { 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" or "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

Workspace name

updated_at: string
formatdate-time
WorkspaceRetrieveSpendingLimitResponse object { 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: object { 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 object { 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: object { 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"