Claude Platform Docs

Workspaces

List Workspaces
beta.organization.workspaces.list(WorkspaceListParams**kwargs) -> SyncPage[BetaWorkspace]
GET/v1/organizations/workspaces
Create Workspace
beta.organization.workspaces.create(WorkspaceCreateParams**kwargs) -> BetaWorkspace
POST/v1/organizations/workspaces
Get Workspace
beta.organization.workspaces.retrieve(strworkspace_id) -> BetaWorkspace
GET/v1/organizations/workspaces/{workspace_id}
Update Workspace
beta.organization.workspaces.update(strworkspace_id, WorkspaceUpdateParams**kwargs) -> BetaWorkspace
POST/v1/organizations/workspaces/{workspace_id}
Archive Workspace
beta.organization.workspaces.archive(strworkspace_id) -> BetaWorkspace
POST/v1/organizations/workspaces/{workspace_id}/archive
Models
Literal["global", "us"]
One of the following:
"global"
"us"
class BetaDataResidency: …
allowed_inference_geos: Union[List[str], Literal["unrestricted"]]

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

One of the following:
List[str]
Literal["unrestricted"]
default_inference_geo: str

Default inference geo applied when requests omit the parameter.

workspace_geo: str

Geographic region for workspace data storage. Immutable after creation.

class BetaDataResidencyCreateConfig: …
allowed_inference_geos: Optional[Union[List[BetaAllowedInferenceGeo], 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[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. 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 BetaDataResidencyUpdateConfig: …
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"
Literal["workspace_admin", "workspace_developer", "workspace_restricted_developer", "workspace_user"]
One of the following:
"workspace_admin"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
class BetaWorkspace: …
class BetaWorkspaceMember: …
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: BetaWorkspaceRole

Role of the Workspace Member.

One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
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
beta.organization.workspaces.rate_limits.list(strworkspace_id, RateLimitListParams**kwargs) -> SyncPageCursor[BetaWorkspaceRateLimit]
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

WorkspacesMembers

List Workspace Members
beta.organization.workspaces.members.list(strworkspace_id, MemberListParams**kwargs) -> SyncPage[BetaWorkspaceMember]
GET/v1/organizations/workspaces/{workspace_id}/members
Create Workspace Member
beta.organization.workspaces.members.add(strworkspace_id, MemberAddParams**kwargs) -> BetaWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members
Get Workspace Member
beta.organization.workspaces.members.retrieve(struser_id, MemberRetrieveParams**kwargs) -> BetaWorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Update Workspace Member
beta.organization.workspaces.members.update(struser_id, MemberUpdateParams**kwargs) -> BetaWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Delete Workspace Member
beta.organization.workspaces.members.remove(struser_id, MemberRemoveParams**kwargs) -> MemberRemoveResponse
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

WorkspacesService Accounts

List Service Account Workspace Members
beta.organization.workspaces.service_accounts.list(strworkspace_id, ServiceAccountListParams**kwargs) -> SyncPageCursor[BetaServiceAccountWorkspaceMember]
GET/v1/organizations/workspaces/{workspace_id}/service_accounts
Create Service Account Workspace Member
beta.organization.workspaces.service_accounts.add(strworkspace_id, ServiceAccountAddParams**kwargs) -> BetaServiceAccountWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/service_accounts
Get Service Account Workspace Member
beta.organization.workspaces.service_accounts.retrieve(strservice_account_id, ServiceAccountRetrieveParams**kwargs) -> BetaServiceAccountWorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Update Service Account Workspace Member
beta.organization.workspaces.service_accounts.update(strservice_account_id, ServiceAccountUpdateParams**kwargs) -> BetaServiceAccountWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Delete Service Account Workspace Member
beta.organization.workspaces.service_accounts.remove(strservice_account_id, ServiceAccountRemoveParams**kwargs) -> ServiceAccountRemoveResponse
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}