Skip to main content

Get Workspace

GET /v1/workspace/
Returns the current workspace configuration. Auth: JWT or API Key

Response 200

{
  "id": "770e8400-e29b-41d4-a716-446655440000",
  "name": "My Workspace",
  "slug": "my-workspace",
  "kill_switch": false,
  "daily_budget_usd": 100.0,
  "user_daily_budget_usd": 25.0,
  "max_concurrent_runs": 10
}
FieldTypeDescription
idstringWorkspace UUID
namestringWorkspace display name
slugstringURL-safe identifier
kill_switchbooleanWhether the kill switch is active
daily_budget_usdnumber | nullWorkspace daily spend limit (null = unlimited)
user_daily_budget_usdnumber | nullPer-user daily spend limit (null = unlimited)
max_concurrent_runsintegerMaximum simultaneous active runs

Update Workspace

PATCH /v1/workspace/
Updates workspace configuration. Only include fields you want to change. Auth: JWT or API Key

Request Body

{
  "name": "Production Workspace",
  "daily_budget_usd": 200.0,
  "user_daily_budget_usd": 50.0,
  "max_concurrent_runs": 20
}
FieldTypeRequiredDescription
namestring | nullNoNew workspace name
daily_budget_usdnumber | nullNoWorkspace daily budget
user_daily_budget_usdnumber | nullNoPer-user daily budget
max_concurrent_runsinteger | nullNoMax concurrent runs

Response 200

Returns the full updated WorkspaceResponse.

Plan Gating

Setting user_daily_budget_usd requires the Pro plan or higher. Basic plan workspaces will receive a 403 error.Configuring max_concurrent_runs requires the Pro plan or higher. Basic plan workspaces are fixed at 3 concurrent runs.

Toggle Kill Switch

POST /v1/workspace/kill-switch
Enables or disables the kill switch. When active, all runs and steps are immediately blocked with KILL_SWITCH_ACTIVE. Auth: JWT or API Key

Request Body

{
  "active": true
}
FieldTypeRequiredDescription
activebooleanYestrue to enable, false to disable

Response 200

Returns the full updated WorkspaceResponse with kill_switch reflecting the new state.

Plan Gating

The kill switch requires the Scale plan or higher. Basic and Pro plans will receive a 403 error when trying to enable it.