Claude Platform Docs

Workspaces

List Workspaces
WorkspaceListPage Organization.Workspaces.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces
Create Workspace
Workspace Organization.Workspaces.Create(parameters, cancellationToken = default)
POST/v1/organizations/workspaces
Get Workspace
Workspace Organization.Workspaces.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}
Update Workspace
Workspace Organization.Workspaces.Update(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}
Archive Workspace
Workspace Organization.Workspaces.Archive(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/archive
Models
enum AllowedInferenceGeo
Global("global")
Us("us")
class DataResidency { AllowedInferenceGeos; DefaultInferenceGeo; WorkspaceGeo; }
required AllowedInferenceGeos AllowedInferenceGeos

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

One of the following:
IReadOnlyList<AllowedInferenceGeo>
One of the following:
Global("global")
Us("us")
class Unrestricted:
required DefaultInferenceGeo DefaultInferenceGeo

Default inference geo applied when requests omit the parameter.

One of the following:
Global("global")
Us("us")
required WorkspaceGeo WorkspaceGeo

Geographic region for workspace data storage. Immutable after creation.

class DataResidencyCreateConfig { AllowedInferenceGeos; DefaultInferenceGeo; WorkspaceGeo; }
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:
IReadOnlyList<AllowedInferenceGeo>
One of the following:
Global("global")
Us("us")
class Unrestricted:
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")
WorkspaceGeo? WorkspaceGeo

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

class DataResidencyUpdateConfig { AllowedInferenceGeos; DefaultInferenceGeo; }
AllowedInferenceGeos? AllowedInferenceGeos

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

One of the following:
IReadOnlyList<AllowedInferenceGeo>
One of the following:
Global("global")
Us("us")
class Unrestricted:
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 NoBillingWorkspaceRole
WorkspaceAdmin("workspace_admin")
WorkspaceDeveloper("workspace_developer")
WorkspaceRestrictedDeveloper("workspace_restricted_developer")
WorkspaceUser("workspace_user")
class Workspace { Type = "workspace"; ID; ArchivedAt; /* 7 more */ }
class WorkspaceMember { Type = "workspace_member"; UserID; WorkspaceID; WorkspaceRole; }
JsonElement Type = "workspace_member"

Object type.

For Workspace Members, this is always "workspace_member".

required string UserID

ID of the User.

required string WorkspaceID

ID of the Workspace.

required WorkspaceRole WorkspaceRole

Role of the Workspace Member.

One of the following:
WorkspaceAdmin("workspace_admin")
WorkspaceBilling("workspace_billing")
WorkspaceDeveloper("workspace_developer")
WorkspaceRestrictedDeveloper("workspace_restricted_developer")
WorkspaceUser("workspace_user")
enum WorkspaceRole
WorkspaceAdmin("workspace_admin")
WorkspaceBilling("workspace_billing")
WorkspaceDeveloper("workspace_developer")
WorkspaceRestrictedDeveloper("workspace_restricted_developer")
WorkspaceUser("workspace_user")

WorkspacesRate Limits

List Workspace Rate Limits
RateLimitListPage Organization.Workspaces.RateLimits.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

List a workspace's rate limits.

Set Workspace Rate Limits
WorkspaceRateLimit Organization.Workspaces.RateLimits.Update(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/rate_limits/{rate_limit_id}

Set or clear rate-limit overrides for one rate-limit group in a workspace.

WorkspacesMembers

List Workspace Members
MemberListPage Organization.Workspaces.Members.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/members
Create Workspace Member
WorkspaceMember Organization.Workspaces.Members.Add(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/members
Get Workspace Member
WorkspaceMember Organization.Workspaces.Members.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Update Workspace Member
WorkspaceMember Organization.Workspaces.Members.Update(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Delete Workspace Member
MemberRemoveResponse Organization.Workspaces.Members.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

WorkspacesService Accounts

List Service Account Workspace Members
ServiceAccountListPage Organization.Workspaces.ServiceAccounts.List(parameters, cancellationToken = default)
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
ServiceAccountWorkspaceMember Organization.Workspaces.ServiceAccounts.Add(parameters, cancellationToken = default)
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
ServiceAccountWorkspaceMember Organization.Workspaces.ServiceAccounts.Retrieve(parameters, cancellationToken = default)
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
ServiceAccountWorkspaceMember Organization.Workspaces.ServiceAccounts.Update(parameters, cancellationToken = default)
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
ServiceAccountRemoveResponse Organization.Workspaces.ServiceAccounts.Remove(parameters, cancellationToken = default)
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.