Claude Platform Docs

Workspaces

List Workspaces
organization.workspaces.list(**kwargs) -> SyncPage[Workspace]
GET/v1/organizations/workspaces
Create Workspace
organization.workspaces.create(**kwargs) -> Workspace
POST/v1/organizations/workspaces
Get Workspace
organization.workspaces.retrieve(workspace_id) -> Workspace
GET/v1/organizations/workspaces/{workspace_id}
Update Workspace
organization.workspaces.update(workspace_id, **kwargs) -> Workspace
POST/v1/organizations/workspaces/{workspace_id}
Archive Workspace
organization.workspaces.archive(workspace_id) -> Workspace
POST/v1/organizations/workspaces/{workspace_id}/archive
Models
type AllowedInferenceGeo = Literal["global", "us"]
One of the following:
"global"
"us"
class DataResidency: allowed_inference_geos; default_inference_geo; workspace_geo
allowed_inference_geos: Union[List[AllowedInferenceGeo], Literal["unrestricted"]]

Permitted inference geo values. 'unrestricted' means all geos are allowed.

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

Default inference geo applied when requests omit the parameter.

One of the following:
"global"
"us"
workspace_geo: Literal["us"]

Geographic region for workspace data storage. Immutable after creation.

class DataResidencyCreateConfig: allowed_inference_geos; default_inference_geo; workspace_geo
allowed_inference_geos: Optional[Union[List[AllowedInferenceGeo], Literal["unrestricted"], null]]

Permitted inference geo values. Defaults to 'unrestricted' if omitted, which allows all geos. Use the string 'unrestricted' to allow all geos, or a list of specific geos.

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

Default inference geo applied when requests omit the parameter. Defaults to 'global' if omitted. Must be a member of allowed_inference_geos unless allowed_inference_geos is "unrestricted".

One of the following:
"global"
"us"
workspace_geo: Optional[Literal["us"]]

Geographic region for workspace data storage. Immutable after creation. Defaults to 'us' if omitted.

class DataResidencyUpdateConfig: allowed_inference_geos; default_inference_geo
allowed_inference_geos: Optional[Union[List[AllowedInferenceGeo], Literal["unrestricted"], null]]

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

One of the following:
List[AllowedInferenceGeo]
One of the following:
"global"
"us"
"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"
type NoBillingWorkspaceRole = Literal["workspace_admin", "workspace_developer", "workspace_restricted_developer", "workspace_user"]
One of the following:
"workspace_admin"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
class Workspace: type: "workspace"; id; archived_at; ... # 7 more
class WorkspaceMember: type: "workspace_member"; user_id; workspace_id; workspace_role
type: Literal["workspace_member"]

Object type.

For Workspace Members, this is always "workspace_member".

defaultworkspace_member
user_id: str

ID of the User.

workspace_id: str

ID of the Workspace.

workspace_role: WorkspaceRole

Role of the Workspace Member.

One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
type WorkspaceRole = Literal["workspace_admin", "workspace_billing", "workspace_developer", 2 more]
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"

WorkspacesRate Limits

List Workspace Rate Limits
organization.workspaces.rate_limits.list(workspace_id, **kwargs) -> SyncPageCursor[WorkspaceRateLimit]
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

List a workspace's rate limits.

WorkspacesMembers

List Workspace Members
organization.workspaces.members.list(workspace_id, **kwargs) -> SyncPage[WorkspaceMember]
GET/v1/organizations/workspaces/{workspace_id}/members
Create Workspace Member
organization.workspaces.members.add(workspace_id, **kwargs) -> WorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members
Get Workspace Member
organization.workspaces.members.retrieve(user_id, **kwargs) -> WorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Update Workspace Member
organization.workspaces.members.update(user_id, **kwargs) -> WorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Delete Workspace Member
organization.workspaces.members.remove(user_id, **kwargs) -> MemberRemoveResponse
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

WorkspacesService Accounts

List Service Account Workspace Members
organization.workspaces.service_accounts.list(workspace_id, **kwargs) -> SyncPageCursor[ServiceAccountWorkspaceMember]
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Create Service Account Workspace Member
organization.workspaces.service_accounts.add(workspace_id, **kwargs) -> ServiceAccountWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Get Service Account Workspace Member
organization.workspaces.service_accounts.retrieve(service_account_id, **kwargs) -> ServiceAccountWorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Update Service Account Workspace Member
organization.workspaces.service_accounts.update(service_account_id, **kwargs) -> ServiceAccountWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Delete Service Account Workspace Member
organization.workspaces.service_accounts.remove(service_account_id, **kwargs) -> ServiceAccountRemoveResponse
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.