Skip to content
Boltz Boltz Boltz API Docs
Go to Boltz API
API Reference
Admin
Workspaces

Create a workspace

admin.workspaces.create(WorkspaceCreateParams**kwargs) -> WorkspaceCreateResponse
POST/compute/v1/admin/workspaces

Create a workspace

ParametersExpand Collapse
data_retention: Optional[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
name: Optional[str]

Workspace name

minLength1
maxLength255
spending_limit: Optional[SpendingLimit]
limit: SpendingLimitLimit
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"]
ReturnsExpand 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

Create a workspace

import os
from boltz_api import Boltz

client = Boltz(
    api_key=os.environ.get("BOLTZ_API_KEY"),  # This is the default and can be omitted
)
workspace = client.admin.workspaces.create()
print(workspace.id)
{
  "id": "id",
  "archived_at": "2019-12-27T18:11:19.117Z",
  "created_at": "2019-12-27T18:11:19.117Z",
  "data_retention": {
    "unit": "hours",
    "value": 1
  },
  "is_default": true,
  "name": "name",
  "updated_at": "2019-12-27T18:11:19.117Z"
}
Returns Examples
{
  "id": "id",
  "archived_at": "2019-12-27T18:11:19.117Z",
  "created_at": "2019-12-27T18:11:19.117Z",
  "data_retention": {
    "unit": "hours",
    "value": 1
  },
  "is_default": true,
  "name": "name",
  "updated_at": "2019-12-27T18:11:19.117Z"
}