Claude Platform Docs

Update Workspace

beta.organization.workspaces.update(strworkspace_id, WorkspaceUpdateParams**kwargs) -> BetaWorkspace
POST/v1/organizations/workspaces/{workspace_id}

Update Workspace

Parameters
workspace_id: str
data_residency: Optional[BetaDataResidencyUpdateConfigParam]

Data residency configuration for the workspace.

allowed_inference_geos: Optional[Union[List[BetaAllowedInferenceGeo], Literal["unrestricted"], null]]

Permitted inference geo values. Use 'unrestricted' to allow all geos, or a list of specific geos.

One of the following:
List[BetaAllowedInferenceGeo]
One of the following:
"global"
"us"
Literal["unrestricted"]
default_inference_geo: Optional[Literal["global", "us"]]

Default inference geo applied when requests omit the parameter. Must be a member of allowed_inference_geos unless allowed_inference_geos is "unrestricted".

One of the following:
"global"
"us"
display_color: Optional[str]

Hex color code representing the Workspace in the Anthropic Console.

maxLength7
pattern^#[0-9A-Fa-f]{6}$
external_key_id: Optional[str]

ID of the customer-managed encryption key (CMEK) configuration to use for this Workspace. Setting this field requires CMEK to be enabled for your organization. When set, data stored for this Workspace is encrypted with the referenced key. Create key configurations with the External Keys API. This field is write-once: once a key is attached to a Workspace it cannot be detached or replaced. To rotate key material, rotate the underlying key on your cloud KMS; the external_key_id stays the same.

name: Optional[str]

Name of the Workspace.

maxLength40
minLength1
tags: Optional[Dict[str, Optional[str]]]

User-defined tags as string key-value pairs. Keys may not begin with anthropic.

Returns
class BetaWorkspace: …

Update Workspace

import os
from anthropic import Anthropic

client = Anthropic(
    api_key=os.environ.get(
        "ANTHROPIC_API_KEY"
    ),  # This is the default and can be omitted
)
beta_workspace = client.beta.organization.workspaces.update(
    workspace_id="workspace_id",
)
print(beta_workspace.id)
{
  "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
  "archived_at": "2024-11-01T23:59:27.427722Z",
  "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "data_residency": {
    "allowed_inference_geos": "unrestricted",
    "default_inference_geo": "default_inference_geo",
    "workspace_geo": "workspace_geo"
  },
  "display_color": "#6C5BB9",
  "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
  "name": "Workspace Name",
  "tags": {
    "env": "prod",
    "team": "platform"
  },
  "type": "workspace"
}
Returns Examples
{
  "id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ",
  "archived_at": "2024-11-01T23:59:27.427722Z",
  "compartment_id": "f8a7b6c5-4d3e-4f1a-8b9c-0d1e2f3a4b5c",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "data_residency": {
    "allowed_inference_geos": "unrestricted",
    "default_inference_geo": "default_inference_geo",
    "workspace_geo": "workspace_geo"
  },
  "display_color": "#6C5BB9",
  "external_key_id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
  "name": "Workspace Name",
  "tags": {
    "env": "prod",
    "team": "platform"
  },
  "type": "workspace"
}