Claude Platform Docs

Espaços de trabalho

Listar workspaces
client.organization.workspaces.list(query?, options?): Page<Workspace>
GET/v1/organizations/workspaces
Criar workspace
client.organization.workspaces.create(body, options?): Workspace
POST/v1/organizations/workspaces
Obter workspace
client.organization.workspaces.retrieve(workspaceID, options?): Workspace
GET/v1/organizations/workspaces/{workspace_id}
Atualizar workspace
client.organization.workspaces.update(workspaceID, body, options?): Workspace
POST/v1/organizations/workspaces/{workspace_id}
Arquivar workspace
client.organization.workspaces.archive(workspaceID, options?): Workspace
POST/v1/organizations/workspaces/{workspace_id}/archive
Models
type AllowedInferenceGeo = "global" | "us"
One of the following:
"global"
"us"
interface DataResidency { allowed_inference_geos; default_inference_geo; workspace_geo }
allowed_inference_geos: Array<AllowedInferenceGeo> | "unrestricted"

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

One of the following:
Array<AllowedInferenceGeo>
"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.

interface DataResidencyCreateConfig { allowed_inference_geos; default_inference_geo; workspace_geo }
allowed_inference_geos?: Array<AllowedInferenceGeo> | "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:
Array<AllowedInferenceGeo>
"global"
"us"
"unrestricted"
default_inference_geo?: "global" | "us" | null

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" | null

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

interface DataResidencyUpdateConfig { allowed_inference_geos; default_inference_geo }
allowed_inference_geos?: Array<AllowedInferenceGeo> | "unrestricted" | null

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

One of the following:
Array<AllowedInferenceGeo>
"global"
"us"
"unrestricted"
default_inference_geo?: "global" | "us" | null

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 NoBillingWorkspaceRole = "workspace_admin" | "workspace_developer" | "workspace_restricted_developer" | "workspace_user"
One of the following:
"workspace_admin"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
interface Workspace { type: "workspace"; id; archived_at; /* 7 more */ }
interface WorkspaceMember { type: "workspace_member"; user_id; workspace_id; workspace_role }
type: "workspace_member"

Object type.

For Workspace Members, this is always "workspace_member".

defaultworkspace_member
user_id: string

ID of the User.

workspace_id: string

ID of the Workspace.

workspace_role: WorkspaceRole

Role of the Workspace Member.

One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"
type WorkspaceRole = "workspace_admin" | "workspace_billing" | "workspace_developer" | 2 more
One of the following:
"workspace_admin"
"workspace_billing"
"workspace_developer"
"workspace_restricted_developer"
"workspace_user"

Espaços de trabalhoLimites de taxa

Listar limites de taxa do workspace
client.organization.workspaces.rateLimits.list(workspaceID, query?, options?): PageCursor<WorkspaceRateLimit>
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

Liste os limites de taxa de um workspace.

Espaços de trabalhoMembros

Listar membros do workspace
client.organization.workspaces.members.list(workspaceID, query?, options?): Page<WorkspaceMember>
GET/v1/organizations/workspaces/{workspace_id}/members
Criar membro do workspace
client.organization.workspaces.members.add(workspaceID, body, options?): WorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members
Obter membro do workspace
client.organization.workspaces.members.retrieve(userID, params, options?): WorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Atualizar membro do workspace
client.organization.workspaces.members.update(userID, params, options?): WorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Excluir membro do workspace
client.organization.workspaces.members.remove(userID, params, options?): MemberRemoveResponse
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
client.organization.workspaces.serviceAccounts.list(workspaceID, query?, options?): PageCursor<ServiceAccountWorkspaceMember>
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
client.organization.workspaces.serviceAccounts.add(workspaceID, body, options?): ServiceAccountWorkspaceMember
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
client.organization.workspaces.serviceAccounts.retrieve(serviceAccountID, params, options?): ServiceAccountWorkspaceMember
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
client.organization.workspaces.serviceAccounts.update(serviceAccountID, params, options?): ServiceAccountWorkspaceMember
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
client.organization.workspaces.serviceAccounts.remove(serviceAccountID, params, options?): ServiceAccountRemoveResponse
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.