Overview
Workspaces endpointsAvailable Operations
- list - List workspaces
- create - Create a workspace
- delete - Delete a workspace
- get - Get a workspace
- update - Update a workspace
- list_members - List workspace members
- bulk_add_members - Bulk add members to a workspace
- bulk_remove_members - Bulk remove members from a workspace
- list_budgets - List workspace budgets
- delete_budget - Delete a workspace budget
- get_budget - Get a workspace budget
- set_budget - Create or update a workspace budget
list
List all workspaces for the authenticated user. Management key required.Example Usage
Parameters
Response
operations.ListWorkspacesResponseErrors
create
Create a new workspace for the authenticated user. Management key required.Example Usage
Parameters
Response
components.CreateWorkspaceResponseErrors
delete
Delete an existing workspace. Workspaces with active API keys cannot be deleted; remove the keys first. Deleting the default workspace requires confirm_default_workspace_deletion=true. Deleting any workspace permanently deletes its budgets and guardrails and disables its classifiers and broadcast destinations. Management key required.Example Usage
Parameters
Response
components.DeleteWorkspaceResponseErrors
get
Get a single workspace by ID or slug. Management key required.Example Usage
Parameters
Response
components.GetWorkspaceResponseErrors
update
Update an existing workspace by ID or slug. Management key required.Example Usage
Parameters
Response
components.UpdateWorkspaceResponseErrors
list_members
List all members of a workspace. Returns paginated results. For the default workspace, returns all organization members (implicit membership). Management key required.Example Usage
Parameters
Response
operations.ListWorkspaceMembersResponseErrors
bulk_add_members
Add multiple organization members to a workspace. Members are assigned the same role they hold in the organization. Management key required.Example Usage
Parameters
Response
components.BulkAddWorkspaceMembersResponseErrors
bulk_remove_members
Remove multiple members from a workspace. Members with active API keys in the workspace cannot be removed. SCIM-managed members cannot be removed; changes must be made in your identity provider. Management key required.Example Usage
Parameters
Response
components.BulkRemoveWorkspaceMembersResponseErrors
list_budgets
List all budgets configured for a workspace. Management key required.Example Usage
Parameters
Response
components.ListWorkspaceBudgetsResponseErrors
delete_budget
Remove the budget for a given interval. Management key required.Example Usage
Parameters
Response
components.DeleteWorkspaceBudgetResponseErrors
get_budget
Retrieve the budget for a given interval. Management key required.Example Usage
Parameters
Response
components.GetWorkspaceBudgetResponseErrors
set_budget
Create or update the budget for a given interval. Budget limits must strictly decrease as the interval narrows (lifetime > monthly > weekly > daily). The optionalinclude_byok_in_budgets flag is a workspace-wide setting: when provided it applies to every budget interval for the workspace, not just the interval in this request. Note that a change made here is applied to budget enforcement immediately, but an already-open workspace settings page in the web dashboard may keep showing the previous value until it is reloaded. Management key required.