Claude Platform Docs

Workspaces

List Workspaces
WorkspaceListPage beta().organization().workspaces().list(WorkspaceListParamsparams = WorkspaceListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/workspaces
Create Workspace
BetaWorkspace beta().organization().workspaces().create(WorkspaceCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/workspaces
Get Workspace
BetaWorkspace beta().organization().workspaces().retrieve(WorkspaceRetrieveParamsparams = WorkspaceRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}
Update Workspace
BetaWorkspace beta().organization().workspaces().update(WorkspaceUpdateParamsparams = WorkspaceUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}
Archive Workspace
BetaWorkspace beta().organization().workspaces().archive(WorkspaceArchiveParamsparams = WorkspaceArchiveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/archive
Models
enum BetaAllowedInferenceGeo:
GLOBAL("global")
US("us")
class BetaDataResidency:
AllowedInferenceGeos allowedInferenceGeos

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

One of the following:
List<String>
JsonValue
String defaultInferenceGeo

Default inference geo applied when requests omit the parameter.

String workspaceGeo

Geographic region for workspace data storage. Immutable after creation.

class BetaDataResidencyCreateConfig:
Optional<AllowedInferenceGeos> allowedInferenceGeos

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("global")
US("us")
JsonValue
Optional<DefaultInferenceGeo> defaultInferenceGeo

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("global")
US("us")
Optional<WorkspaceGeo> workspaceGeo

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

class BetaDataResidencyUpdateConfig:
Optional<AllowedInferenceGeos> allowedInferenceGeos

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("global")
US("us")
JsonValue
Optional<DefaultInferenceGeo> defaultInferenceGeo

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("global")
US("us")
enum BetaNoBillingWorkspaceRole:
WORKSPACE_ADMIN("workspace_admin")
WORKSPACE_DEVELOPER("workspace_developer")
WORKSPACE_RESTRICTED_DEVELOPER("workspace_restricted_developer")
WORKSPACE_USER("workspace_user")
class BetaWorkspace:
class BetaWorkspaceMember:
JsonValue type "workspace_member"constant

Object type.

For Workspace Members, this is always "workspace_member".

String userId

ID of the User.

String workspaceId

ID of the Workspace.

BetaWorkspaceRole workspaceRole

Role of the Workspace Member.

One of the following:
WORKSPACE_ADMIN("workspace_admin")
WORKSPACE_BILLING("workspace_billing")
WORKSPACE_DEVELOPER("workspace_developer")
WORKSPACE_RESTRICTED_DEVELOPER("workspace_restricted_developer")
WORKSPACE_USER("workspace_user")
enum BetaWorkspaceRole:
WORKSPACE_ADMIN("workspace_admin")
WORKSPACE_BILLING("workspace_billing")
WORKSPACE_DEVELOPER("workspace_developer")
WORKSPACE_RESTRICTED_DEVELOPER("workspace_restricted_developer")
WORKSPACE_USER("workspace_user")

WorkspacesRate Limits

List Workspace Rate Limits
RateLimitListPage beta().organization().workspaces().rateLimits().list(RateLimitListParamsparams = RateLimitListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

WorkspacesMembers

List Workspace Members
MemberListPage beta().organization().workspaces().members().list(MemberListParamsparams = MemberListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/members
Create Workspace Member
BetaWorkspaceMember beta().organization().workspaces().members().add(MemberAddParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/members
Get Workspace Member
BetaWorkspaceMember beta().organization().workspaces().members().retrieve(MemberRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Update Workspace Member
BetaWorkspaceMember beta().organization().workspaces().members().update(MemberUpdateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Delete Workspace Member
MemberRemoveResponse beta().organization().workspaces().members().remove(MemberRemoveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

WorkspacesService Accounts

List Service Account Workspace Members
ServiceAccountListPage beta().organization().workspaces().serviceAccounts().list(ServiceAccountListParamsparams = ServiceAccountListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/service_accounts
Create Service Account Workspace Member
BetaServiceAccountWorkspaceMember beta().organization().workspaces().serviceAccounts().add(ServiceAccountAddParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/service_accounts
Get Service Account Workspace Member
BetaServiceAccountWorkspaceMember beta().organization().workspaces().serviceAccounts().retrieve(ServiceAccountRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Update Service Account Workspace Member
BetaServiceAccountWorkspaceMember beta().organization().workspaces().serviceAccounts().update(ServiceAccountUpdateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Delete Service Account Workspace Member
ServiceAccountRemoveResponse beta().organization().workspaces().serviceAccounts().remove(ServiceAccountRemoveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}