Claude Platform Docs

Workspaces

List Workspaces
beta.organization.workspaces.list(**kwargs) -> Page<BetaWorkspace>
GET/v1/organizations/workspaces
Create Workspace
beta.organization.workspaces.create(**kwargs) -> BetaWorkspace
POST/v1/organizations/workspaces
Get Workspace
beta.organization.workspaces.retrieve(workspace_id) -> BetaWorkspace
GET/v1/organizations/workspaces/{workspace_id}
Update Workspace
beta.organization.workspaces.update(workspace_id, **kwargs) -> BetaWorkspace
POST/v1/organizations/workspaces/{workspace_id}
Archive Workspace
beta.organization.workspaces.archive(workspace_id) -> BetaWorkspace
POST/v1/organizations/workspaces/{workspace_id}/archive
Models
type BetaAllowedInferenceGeo = :global | :us
One of the following:
:global
:us
class BetaDataResidency { allowed_inference_geos, default_inference_geo, workspace_geo }
allowed_inference_geos: Array[BetaAllowedInferenceGeo] | :unrestricted

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

One of the following:
Geos = Array[BetaAllowedInferenceGeo]
One of the following:
:global
:us
:unrestricted
default_inference_geo: :global | :us

Default inference geo applied when requests omit the parameter.

One of the following:
:global
:us
workspace_geo: :us

Geographic region for workspace data storage. Immutable after creation.

class BetaDataResidencyCreateConfig { allowed_inference_geos, default_inference_geo, workspace_geo }
allowed_inference_geos: Array[BetaAllowedInferenceGeo] | :unrestricted

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:
Geos = Array[BetaAllowedInferenceGeo]
One of the following:
:global
:us
:unrestricted
default_inference_geo: :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: :us

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

class BetaDataResidencyUpdateConfig { allowed_inference_geos, default_inference_geo }
allowed_inference_geos: Array[BetaAllowedInferenceGeo] | :unrestricted

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

One of the following:
Geos = Array[BetaAllowedInferenceGeo]
One of the following:
:global
:us
:unrestricted
default_inference_geo: :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 BetaNoBillingWorkspaceRole = :workspace_admin | :workspace_developer | :workspace_restricted_developer | :workspace_user
One of the following:
:workspace_admin
:workspace_developer
:workspace_restricted_developer
:workspace_user
class BetaWorkspace { type: :workspace, id, archived_at, 7 more }
class BetaWorkspaceMember { type: :workspace_member, user_id, workspace_id, workspace_role }
type: :workspace_member

Object type.

For Workspace Members, this is always "workspace_member".

user_id: String

ID of the User.

workspace_id: String

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
type BetaWorkspaceRole = :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(workspace_id, **kwargs) -> PageCursor<BetaWorkspaceRateLimit>
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

List a workspace's rate limits.

WorkspacesMembers

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

WorkspacesService Accounts

List Service Account Workspace Members
beta.organization.workspaces.service_accounts.list(workspace_id, **kwargs) -> PageCursor<BetaServiceAccountWorkspaceMember>
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
beta.organization.workspaces.service_accounts.add(workspace_id, **kwargs) -> BetaServiceAccountWorkspaceMember
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
beta.organization.workspaces.service_accounts.retrieve(service_account_id, **kwargs) -> BetaServiceAccountWorkspaceMember
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
beta.organization.workspaces.service_accounts.update(service_account_id, **kwargs) -> BetaServiceAccountWorkspaceMember
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
beta.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.