Claude Platform Docs

Espaços de trabalho

Listar workspaces
WorkspaceListPage Beta.Organization.Workspaces.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces
Criar workspace
BetaWorkspace Beta.Organization.Workspaces.Create(parameters, cancellationToken = default)
POST/v1/organizations/workspaces
Obter workspace
BetaWorkspace Beta.Organization.Workspaces.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}
Atualizar workspace
BetaWorkspace Beta.Organization.Workspaces.Update(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}
Arquivar workspace
BetaWorkspace Beta.Organization.Workspaces.Archive(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/archive
Models
enum BetaAllowedInferenceGeo
Global("global")
Us("us")
class BetaDataResidency { AllowedInferenceGeos; DefaultInferenceGeo; WorkspaceGeo; }
required AllowedInferenceGeos AllowedInferenceGeos

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

One of the following:
IReadOnlyList<BetaAllowedInferenceGeo>
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 BetaDataResidencyCreateConfig { 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<BetaAllowedInferenceGeo>
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 BetaDataResidencyUpdateConfig { 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<BetaAllowedInferenceGeo>
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 BetaNoBillingWorkspaceRole
WorkspaceAdmin("workspace_admin")
WorkspaceDeveloper("workspace_developer")
WorkspaceRestrictedDeveloper("workspace_restricted_developer")
WorkspaceUser("workspace_user")
class BetaWorkspace { Type = "workspace"; ID; ArchivedAt; /* 8 more */ }
class BetaWorkspaceMember { 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 BetaWorkspaceRole 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 BetaWorkspaceRole
WorkspaceAdmin("workspace_admin")
WorkspaceBilling("workspace_billing")
WorkspaceDeveloper("workspace_developer")
WorkspaceRestrictedDeveloper("workspace_restricted_developer")
WorkspaceUser("workspace_user")

Espaços de trabalhoLimites de taxa

Listar limites de taxa do workspace
RateLimitListPage Beta.Organization.Workspaces.RateLimits.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

Liste os limites de taxa de um workspace.

Definir limites de taxa do workspace
BetaWorkspaceRateLimit Beta.Organization.Workspaces.RateLimits.Update(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/rate_limits/{rate_limit_id}

Define ou remove substituições de limite de taxa para um grupo de limite de taxa em um workspace.

Espaços de trabalhoMembros

Listar membros do workspace
MemberListPage Beta.Organization.Workspaces.Members.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/members
Criar membro do workspace
BetaWorkspaceMember Beta.Organization.Workspaces.Members.Add(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/members
Obter membro do workspace
BetaWorkspaceMember Beta.Organization.Workspaces.Members.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Atualizar membro do workspace
BetaWorkspaceMember Beta.Organization.Workspaces.Members.Update(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Excluir membro do workspace
MemberRemoveResponse Beta.Organization.Workspaces.Members.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

Espaços de trabalhoContas de serviço

Listar membros de workspace de conta de serviço
ServiceAccountListPage Beta.Organization.Workspaces.ServiceAccounts.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou uma regra de federação de identidade de workload; chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.

Criar membro de workspace de conta de serviço
BetaServiceAccountWorkspaceMember Beta.Organization.Workspaces.ServiceAccounts.Add(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou uma regra de federação de identidade de workload; chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.

Obter membro de workspace de conta de serviço
BetaServiceAccountWorkspaceMember Beta.Organization.Workspaces.ServiceAccounts.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou uma regra de federação de identidade de workload; chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.

Atualizar membro de workspace de conta de serviço
BetaServiceAccountWorkspaceMember Beta.Organization.Workspaces.ServiceAccounts.Update(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou uma regra de federação de identidade de workload; chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.

Excluir membro de workspace de conta de serviço
ServiceAccountRemoveResponse Beta.Organization.Workspaces.ServiceAccounts.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Requer um token de acesso OAuth com o escopo org:admin, obtido via ant auth login --scope org:admin ou por uma regra de federação de identidade de carga de trabalho; chaves de API de Admin não são aceitas. Consulte Gerenciar WIF com a Admin API.