Claude Platform Docs

Beta

Models
enum AnthropicBeta
class BetaApiError { type = "api_error"; message; }
JsonValue type = "api_error"
String message
class BetaAuthenticationError { type = "authentication_error"; message; }
JsonValue type = "authentication_error"
String message
class BetaBillingError { type = "billing_error"; message; }
JsonValue type = "billing_error"
String message
enum BetaCurrency
USD("USD")
class BetaError: union
class BetaErrorResponse { type = "error"; error; requestId; }
JsonValue type = "error"
BetaError error
One of the following:
Optional<String> requestId
class BetaGatewayTimeoutError { type = "timeout_error"; message; }
JsonValue type = "timeout_error"
String message
class BetaInvalidRequestError { type = "invalid_request_error"; message; }
JsonValue type = "invalid_request_error"
String message
class BetaMonetaryAmount { amount; currency; }

A monetary amount in a specific currency.

String amount

Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

BetaCurrency currency

Uppercase ISO-4217 currency code. USD is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.

class BetaNotFoundError { type = "not_found_error"; message; }
JsonValue type = "not_found_error"
String message
class BetaOverloadedError { type = "overloaded_error"; message; }
JsonValue type = "overloaded_error"
String message
class BetaPermissionError { type = "permission_error"; message; }
JsonValue type = "permission_error"
String message
class BetaRateLimitError { type = "rate_limit_error"; message; }
JsonValue type = "rate_limit_error"
String message

BetaModelos

Listar modelos
ModelListPage beta().models().list(params = ModelListParams.none(), requestOptions = RequestOptions.none())
GET/v1/models

Liste os modelos disponíveis.

Obter um modelo
BetaModelInfo beta().models().retrieve(params = ModelRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/models/{model_id}

Obtenha um modelo específico.

BetaMensagens

Criar uma mensagem
BetaMessage beta().messages().create(params, requestOptions = RequestOptions.none())
POST/v1/messages

Envie uma lista estruturada de mensagens de entrada com conteúdo de texto e/ou imagem, e o modelo gerará a próxima mensagem na conversa.

Contar tokens em uma mensagem
BetaMessageTokensCount beta().messages().countTokens(params, requestOptions = RequestOptions.none())
POST/v1/messages/count_tokens

Conte o número de tokens em uma mensagem.

BetaMensagensLotes

Criar um lote de mensagens
BetaMessageBatch beta().messages().batches().create(params, requestOptions = RequestOptions.none())
POST/v1/messages/batches

Envie um lote de solicitações de criação de mensagens.

Recuperar um lote de mensagens
BetaMessageBatch beta().messages().batches().retrieve(params = BatchRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/messages/batches/{message_batch_id}

Este endpoint é idempotente e pode ser usado para fazer polling da conclusão de um lote de mensagens. Para acessar os resultados de um lote de mensagens, faça uma solicitação para o campo results_url na resposta.

Listar lotes de mensagens
BatchListPage beta().messages().batches().list(params = BatchListParams.none(), requestOptions = RequestOptions.none())
GET/v1/messages/batches

Liste todos os lotes de mensagens em um Workspace. Os lotes criados mais recentemente são retornados primeiro.

Cancelar um lote de mensagens
BetaMessageBatch beta().messages().batches().cancel(params = BatchCancelParams.none(), requestOptions = RequestOptions.none())
POST/v1/messages/batches/{message_batch_id}/cancel

Os lotes podem ser cancelados a qualquer momento antes do término do processamento. Depois que o cancelamento é iniciado, o lote entra em um estado canceling, momento em que o sistema pode concluir quaisquer solicitações em andamento e não interrompíveis antes de finalizar o cancelamento.

Excluir um lote de mensagens
BetaDeletedMessageBatch beta().messages().batches().delete(params = BatchDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/messages/batches/{message_batch_id}

Exclua um lote de mensagens.

Recuperar resultados de um lote de mensagens
StreamResponse<BetaMessageBatchIndividualResponse> beta().messages().batches().resultsStreaming(params = BatchResultsParams.none(), requestOptions = RequestOptions.none())
GET/v1/messages/batches/{message_batch_id}/results

Faz streaming dos resultados de um lote de mensagens como um arquivo .jsonl.

BetaAgentes

Criar agente
BetaManagedAgentsAgent beta().agents().create(params, requestOptions = RequestOptions.none())
POST/v1/agents
Listar agentes
AgentListPage beta().agents().list(params = AgentListParams.none(), requestOptions = RequestOptions.none())
GET/v1/agents
Obter agente
BetaManagedAgentsAgent beta().agents().retrieve(params = AgentRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/agents/{agent_id}
Atualizar agente
BetaManagedAgentsAgent beta().agents().update(params = AgentUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/agents/{agent_id}
Arquivar agente
BetaManagedAgentsAgent beta().agents().archive(params = AgentArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/agents/{agent_id}/archive

BetaAgentesVersões

Listar versões do agente
VersionListPage beta().agents().versions().list(params = VersionListParams.none(), requestOptions = RequestOptions.none())
GET/v1/agents/{agent_id}/versions

BetaAmbientes

Criar ambiente
BetaEnvironment beta().environments().create(params, requestOptions = RequestOptions.none())
POST/v1/environments

Crie um novo ambiente com a configuração especificada.

Listar ambientes
EnvironmentListPage beta().environments().list(params = EnvironmentListParams.none(), requestOptions = RequestOptions.none())
GET/v1/environments

Liste ambientes com suporte a paginação.

Obter ambiente
BetaEnvironment beta().environments().retrieve(params = EnvironmentRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/environments/{environment_id}

Recupere um ambiente específico por ID.

Atualizar ambiente
BetaEnvironment beta().environments().update(params = EnvironmentUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/environments/{environment_id}

Atualize a configuração de um ambiente existente.

Excluir ambiente
BetaEnvironmentDeleteResponse beta().environments().delete(params = EnvironmentDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/environments/{environment_id}

Exclua um ambiente por ID. Retorna uma confirmação da exclusão.

Arquivar ambiente
BetaEnvironment beta().environments().archive(params = EnvironmentArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/environments/{environment_id}/archive

Arquive um ambiente por ID. Ambientes arquivados não podem ser usados para criar novas sessões.

BetaAmbientesTrabalho

Obter item de trabalho
BetaSelfHostedWork beta().environments().work().retrieve(params, requestOptions = RequestOptions.none())
GET/v1/environments/{environment_id}/work/{work_id}

Observação: esses endpoints são chamados automaticamente pelo worker de ambiente pré-construído fornecido nos SDKs e na CLI, para orquestrar sessões com ambientes sandbox auto-hospedados. Eles estão incluídos aqui como referência; você não precisa invocá-los diretamente.

Fazer polling por trabalho
BetaSelfHostedWork beta().environments().work().poll(params = WorkPollParams.none(), requestOptions = RequestOptions.none())
GET/v1/environments/{environment_id}/work/poll

Observação: esses endpoints são chamados automaticamente pelo worker de ambiente pré-construído fornecido nos SDKs e na CLI, para orquestrar sessões com ambientes sandbox auto-hospedados. Eles estão incluídos aqui como referência; você não precisa invocá-los diretamente.

Confirmar recebimento de trabalho
BetaSelfHostedWork beta().environments().work().ack(params, requestOptions = RequestOptions.none())
POST/v1/environments/{environment_id}/work/{work_id}/ack

Observação: esses endpoints são chamados automaticamente pelo worker de ambiente pré-construído fornecido nos SDKs e na CLI, para orquestrar sessões com ambientes sandbox auto-hospedados. Eles estão incluídos aqui como referência; você não precisa invocá-los diretamente.

Registrar heartbeat
BetaSelfHostedWorkHeartbeatResponse beta().environments().work().heartbeat(params, requestOptions = RequestOptions.none())
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat

Observação: esses endpoints são chamados automaticamente pelo worker de ambiente pré-construído fornecido nos SDKs e na CLI, para orquestrar sessões com ambientes sandbox auto-hospedados. Eles estão incluídos aqui como referência; você não precisa invocá-los diretamente.

Parar trabalho
BetaSelfHostedWork beta().environments().work().stop(params, requestOptions = RequestOptions.none())
POST/v1/environments/{environment_id}/work/{work_id}/stop

Observação: esses endpoints são chamados automaticamente pelo worker de ambiente pré-construído fornecido nos SDKs e na CLI, para orquestrar sessões com ambientes sandbox auto-hospedados. Eles estão incluídos aqui como referência; você não precisa invocá-los diretamente.

Listar itens de trabalho
WorkListPage beta().environments().work().list(params = WorkListParams.none(), requestOptions = RequestOptions.none())
GET/v1/environments/{environment_id}/work

Observação: esses endpoints são chamados automaticamente pelo worker de ambiente pré-construído fornecido nos SDKs e na CLI, para orquestrar sessões com ambientes sandbox auto-hospedados. Eles estão incluídos aqui como referência; você não precisa invocá-los diretamente.

Atualizar item de trabalho
BetaSelfHostedWork beta().environments().work().update(params, requestOptions = RequestOptions.none())
POST/v1/environments/{environment_id}/work/{work_id}

Observação: esses endpoints são chamados automaticamente pelo worker de ambiente pré-construído fornecido nos SDKs e na CLI, para orquestrar sessões com ambientes sandbox auto-hospedados. Eles estão incluídos aqui como referência; você não precisa invocá-los diretamente.

Obter estatísticas da fila
BetaSelfHostedWorkQueueStats beta().environments().work().stats(params = WorkStatsParams.none(), requestOptions = RequestOptions.none())
GET/v1/environments/{environment_id}/work/stats

Obtenha estatísticas sobre a fila de trabalho de um ambiente.

BetaSessões

Criar sessão
BetaManagedAgentsSession beta().sessions().create(params, requestOptions = RequestOptions.none())
POST/v1/sessions
Listar sessões
SessionListPage beta().sessions().list(params = SessionListParams.none(), requestOptions = RequestOptions.none())
GET/v1/sessions
Obter sessão
BetaManagedAgentsSession beta().sessions().retrieve(params = SessionRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}
Atualizar sessão
BetaManagedAgentsSession beta().sessions().update(params = SessionUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/sessions/{session_id}
Excluir sessão
BetaManagedAgentsDeletedSession beta().sessions().delete(params = SessionDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/sessions/{session_id}
Arquivar sessão
BetaManagedAgentsSession beta().sessions().archive(params = SessionArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/sessions/{session_id}/archive

BetaSessõesEventos

Listar eventos
EventListPage beta().sessions().events().list(params = EventListParams.none(), requestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/events
Enviar eventos
BetaManagedAgentsSendSessionEvents beta().sessions().events().send(params, requestOptions = RequestOptions.none())
POST/v1/sessions/{session_id}/events
Fazer streaming de eventos
StreamResponse<BetaManagedAgentsStreamSessionEvents> beta().sessions().events().streamStreaming(params = EventStreamParams.none(), requestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/events/stream

BetaSessõesRecursos

Adicionar recurso de sessão
BetaManagedAgentsFileResource beta().sessions().resources().add(params, requestOptions = RequestOptions.none())
POST/v1/sessions/{session_id}/resources
Listar recursos de sessão
ResourceListPage beta().sessions().resources().list(params = ResourceListParams.none(), requestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/resources
Obter recurso de sessão
ResourceRetrieveResponse beta().sessions().resources().retrieve(params, requestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/resources/{resource_id}
Atualizar recurso de sessão
ResourceUpdateResponse beta().sessions().resources().update(params, requestOptions = RequestOptions.none())
POST/v1/sessions/{session_id}/resources/{resource_id}
Excluir recurso de sessão
BetaManagedAgentsDeleteSessionResource beta().sessions().resources().delete(params, requestOptions = RequestOptions.none())
DELETE/v1/sessions/{session_id}/resources/{resource_id}

BetaSessõesThreads

Listar threads de sessão
ThreadListPage beta().sessions().threads().list(params = ThreadListParams.none(), requestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/threads
Obter thread de sessão
BetaManagedAgentsSessionThread beta().sessions().threads().retrieve(params, requestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/threads/{thread_id}
Arquivar thread de sessão
BetaManagedAgentsSessionThread beta().sessions().threads().archive(params, requestOptions = RequestOptions.none())
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

BetaSessõesThreadsEventos

Listar eventos de thread de sessão
EventListPage beta().sessions().threads().events().list(params, requestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/threads/{thread_id}/events
Fazer streaming de eventos de thread de sessão
StreamResponse<BetaManagedAgentsStreamSessionThreadEvents> beta().sessions().threads().events().streamStreaming(params, requestOptions = RequestOptions.none())
GET/v1/sessions/{session_id}/threads/{thread_id}/stream

BetaImplantações

Criar implantação
BetaManagedAgentsDeployment beta().deployments().create(params, requestOptions = RequestOptions.none())
POST/v1/deployments
Listar implantações
DeploymentListPage beta().deployments().list(params = DeploymentListParams.none(), requestOptions = RequestOptions.none())
GET/v1/deployments
Obter implantação
BetaManagedAgentsDeployment beta().deployments().retrieve(params = DeploymentRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/deployments/{deployment_id}
Atualizar implantação
BetaManagedAgentsDeployment beta().deployments().update(params = DeploymentUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/deployments/{deployment_id}
Arquivar implantação
BetaManagedAgentsDeployment beta().deployments().archive(params = DeploymentArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/deployments/{deployment_id}/archive
Executar implantação agora
BetaManagedAgentsDeploymentRun beta().deployments().run(params = DeploymentRunParams.none(), requestOptions = RequestOptions.none())
POST/v1/deployments/{deployment_id}/run
Pausar implantação
BetaManagedAgentsDeployment beta().deployments().pause(params = DeploymentPauseParams.none(), requestOptions = RequestOptions.none())
POST/v1/deployments/{deployment_id}/pause
Retomar implantação
BetaManagedAgentsDeployment beta().deployments().unpause(params = DeploymentUnpauseParams.none(), requestOptions = RequestOptions.none())
POST/v1/deployments/{deployment_id}/unpause

BetaExecuções de implantação

Listar execuções de implantação
DeploymentRunListPage beta().deploymentRuns().list(params = DeploymentRunListParams.none(), requestOptions = RequestOptions.none())
GET/v1/deployment_runs
Obter execução de implantação
BetaManagedAgentsDeploymentRun beta().deploymentRuns().retrieve(params = DeploymentRunRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/deployment_runs/{deployment_run_id}

BetaCofres

Criar cofre
BetaManagedAgentsVault beta().vaults().create(params, requestOptions = RequestOptions.none())
POST/v1/vaults
Listar cofres
VaultListPage beta().vaults().list(params = VaultListParams.none(), requestOptions = RequestOptions.none())
GET/v1/vaults
Obter cofre
BetaManagedAgentsVault beta().vaults().retrieve(params = VaultRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/vaults/{vault_id}
Atualizar cofre
BetaManagedAgentsVault beta().vaults().update(params = VaultUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/vaults/{vault_id}
Excluir cofre
BetaManagedAgentsDeletedVault beta().vaults().delete(params = VaultDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/vaults/{vault_id}
Arquivar cofre
BetaManagedAgentsVault beta().vaults().archive(params = VaultArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/vaults/{vault_id}/archive

BetaCofresCredenciais

Criar credencial
BetaManagedAgentsCredential beta().vaults().credentials().create(params, requestOptions = RequestOptions.none())
POST/v1/vaults/{vault_id}/credentials
Listar credenciais
CredentialListPage beta().vaults().credentials().list(params = CredentialListParams.none(), requestOptions = RequestOptions.none())
GET/v1/vaults/{vault_id}/credentials
Obter credencial
BetaManagedAgentsCredential beta().vaults().credentials().retrieve(params, requestOptions = RequestOptions.none())
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Atualizar credencial
BetaManagedAgentsCredential beta().vaults().credentials().update(params, requestOptions = RequestOptions.none())
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Excluir credencial
BetaManagedAgentsDeletedCredential beta().vaults().credentials().delete(params, requestOptions = RequestOptions.none())
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Arquivar credencial
BetaManagedAgentsCredential beta().vaults().credentials().archive(params, requestOptions = RequestOptions.none())
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Validar credencial
BetaManagedAgentsCredentialValidation beta().vaults().credentials().mcpOAuthValidate(params, requestOptions = RequestOptions.none())
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate

BetaArmazenamentos de memória

Criar um armazenamento de memória
BetaManagedAgentsMemoryStore beta().memoryStores().create(params, requestOptions = RequestOptions.none())
POST/v1/memory_stores
Listar armazenamentos de memória
MemoryStoreListPage beta().memoryStores().list(params = MemoryStoreListParams.none(), requestOptions = RequestOptions.none())
GET/v1/memory_stores
Recuperar um armazenamento de memória
BetaManagedAgentsMemoryStore beta().memoryStores().retrieve(params = MemoryStoreRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/memory_stores/{memory_store_id}
Atualizar um armazenamento de memória
BetaManagedAgentsMemoryStore beta().memoryStores().update(params = MemoryStoreUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/memory_stores/{memory_store_id}
Excluir um armazenamento de memória
BetaManagedAgentsDeletedMemoryStore beta().memoryStores().delete(params = MemoryStoreDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/memory_stores/{memory_store_id}
Arquivar um armazenamento de memória
BetaManagedAgentsMemoryStore beta().memoryStores().archive(params = MemoryStoreArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/memory_stores/{memory_store_id}/archive

BetaArmazenamentos de memóriaMemórias

Criar uma memória
BetaManagedAgentsMemory beta().memoryStores().memories().create(params, requestOptions = RequestOptions.none())
POST/v1/memory_stores/{memory_store_id}/memories
Listar memórias
MemoryListPage beta().memoryStores().memories().list(params = MemoryListParams.none(), requestOptions = RequestOptions.none())
GET/v1/memory_stores/{memory_store_id}/memories
Recuperar uma memória
BetaManagedAgentsMemory beta().memoryStores().memories().retrieve(params, requestOptions = RequestOptions.none())
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Atualizar uma memória
BetaManagedAgentsMemory beta().memoryStores().memories().update(params, requestOptions = RequestOptions.none())
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Excluir uma memória
BetaManagedAgentsDeletedMemory beta().memoryStores().memories().delete(params, requestOptions = RequestOptions.none())
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}

BetaArmazenamentos de memóriaVersões de memória

Listar versões de memória
MemoryVersionListPage beta().memoryStores().memoryVersions().list(params = MemoryVersionListParams.none(), requestOptions = RequestOptions.none())
GET/v1/memory_stores/{memory_store_id}/memory_versions
Recuperar uma versão de memória
BetaManagedAgentsMemoryVersion beta().memoryStores().memoryVersions().retrieve(params, requestOptions = RequestOptions.none())
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
Suprimir uma versão de memória
BetaManagedAgentsMemoryVersion beta().memoryStores().memoryVersions().redact(params, requestOptions = RequestOptions.none())
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

BetaArquivos

Fazer upload de arquivo
BetaFileMetadata beta().files().upload(params, requestOptions = RequestOptions.none())
POST/v1/files
Listar arquivos
FileListPage beta().files().list(params = FileListParams.none(), requestOptions = RequestOptions.none())
GET/v1/files
Baixar arquivo
HttpResponse beta().files().download(params = FileDownloadParams.none(), requestOptions = RequestOptions.none())
GET/v1/files/{file_id}/content
Obter metadados do arquivo
BetaFileMetadata beta().files().retrieveMetadata(params = FileRetrieveMetadataParams.none(), requestOptions = RequestOptions.none())
GET/v1/files/{file_id}
Excluir arquivo
BetaDeletedFile beta().files().delete(params = FileDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/files/{file_id}

BetaSkills

Criar skill
BetaSkill beta().skills().create(params, requestOptions = RequestOptions.none())
POST/v1/skills
Listar skills
SkillListPage beta().skills().list(params = SkillListParams.none(), requestOptions = RequestOptions.none())
GET/v1/skills
Obter skill
BetaSkill beta().skills().retrieve(params = SkillRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/skills/{skill_id}
Excluir skill
BetaDeletedSkill beta().skills().delete(params = SkillDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/skills/{skill_id}

BetaSkillsVersões

Criar versão de skill
BetaSkillVersion beta().skills().versions().create(params, requestOptions = RequestOptions.none())
POST/v1/skills/{skill_id}/versions
Listar versões de skill
VersionListPage beta().skills().versions().list(params = VersionListParams.none(), requestOptions = RequestOptions.none())
GET/v1/skills/{skill_id}/versions
Baixar conteúdo de versão de skill
HttpResponse beta().skills().versions().download(params, requestOptions = RequestOptions.none())
GET/v1/skills/{skill_id}/versions/{version}/content

Baixe o conteúdo de uma versão de skill como um arquivo zip.

Obter versão de skill
BetaSkillVersion beta().skills().versions().retrieve(params, requestOptions = RequestOptions.none())
GET/v1/skills/{skill_id}/versions/{version}
Excluir versão de skill
BetaDeletedSkillVersion beta().skills().versions().delete(params, requestOptions = RequestOptions.none())
DELETE/v1/skills/{skill_id}/versions/{version}

BetaPerfis de usuário

Criar perfil de usuário
BetaUserProfile beta().userProfiles().create(params = UserProfileCreateParams.none(), requestOptions = RequestOptions.none())
POST/v1/user_profiles
Listar perfis de usuário
UserProfileListPage beta().userProfiles().list(params = UserProfileListParams.none(), requestOptions = RequestOptions.none())
GET/v1/user_profiles
Obter perfil de usuário
BetaUserProfile beta().userProfiles().retrieve(params = UserProfileRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/user_profiles/{user_profile_id}
Atualizar perfil de usuário
BetaUserProfile beta().userProfiles().update(params = UserProfileUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/user_profiles/{user_profile_id}
Criar URL de inscrição
BetaUserProfileEnrollmentUrl beta().userProfiles().createEnrollmentUrl(params = UserProfileCreateEnrollmentUrlParams.none(), requestOptions = RequestOptions.none())
POST/v1/user_profiles/{user_profile_id}/enrollment_url

BetaSonhos

Criar um Dream
BetaDream beta().dreams().create(params, requestOptions = RequestOptions.none())
POST/v1/dreams

Inicia um job assíncrono que usa sessões anteriores para produzir uma versão reorganizada de um armazenamento de memória e retorna o dream para que você consulte o resultado.

Listar Dreams
DreamListPage beta().dreams().list(params = DreamListParams.none(), requestOptions = RequestOptions.none())
GET/v1/dreams

Lista os dreams no workspace, do mais recente para o mais antigo.

Obter um Dream
BetaDream beta().dreams().retrieve(params = DreamRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/dreams/{dream_id}

Obtém um dream pelo ID para verificar seu status, o armazenamento de memória de saída e o uso de tokens.

Cancelar um Dream
BetaDream beta().dreams().cancel(params = DreamCancelParams.none(), requestOptions = RequestOptions.none())
POST/v1/dreams/{dream_id}/cancel

Interrompe um dream pending ou running.

Arquivar um Dream
BetaDream beta().dreams().archive(params = DreamArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/dreams/{dream_id}/archive

Oculta um dream completed, failed ou canceled da lista padrão de dreams.

BetaTúneis

Criar túnel
BetaTunnel beta().tunnels().create(params = TunnelCreateParams.none(), requestOptions = RequestOptions.none())
POST/v1/tunnels

A API Tunnels está em "research preview" (prévia de pesquisa). Ela requer o cabeçalho anthropic-beta: mcp-tunnels-2026-06-22 e pode mudar sem um período de descontinuação. Ela substitui os endpoints da Admin API em /v1/organizations/tunnels, que permanecem disponíveis durante uma janela de migração.

Obter túnel
BetaTunnel beta().tunnels().retrieve(params = TunnelRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/tunnels/{tunnel_id}

A API Tunnels está em "research preview" (prévia de pesquisa). Ela requer o cabeçalho anthropic-beta: mcp-tunnels-2026-06-22 e pode mudar sem um período de descontinuação. Ela substitui os endpoints da Admin API em /v1/organizations/tunnels, que permanecem disponíveis durante uma janela de migração.

Listar túneis
TunnelListPage beta().tunnels().list(params = TunnelListParams.none(), requestOptions = RequestOptions.none())
GET/v1/tunnels

A API Tunnels está em "research preview" (prévia de pesquisa). Ela requer o cabeçalho anthropic-beta: mcp-tunnels-2026-06-22 e pode mudar sem um período de descontinuação. Ela substitui os endpoints da Admin API em /v1/organizations/tunnels, que permanecem disponíveis durante uma janela de migração.

Arquivar túnel
BetaTunnel beta().tunnels().archive(params = TunnelArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/tunnels/{tunnel_id}/archive

A API Tunnels está em "research preview" (prévia de pesquisa). Ela requer o cabeçalho anthropic-beta: mcp-tunnels-2026-06-22 e pode mudar sem um período de descontinuação. Ela substitui os endpoints da Admin API em /v1/organizations/tunnels, que permanecem disponíveis durante uma janela de migração.

Revelar token do túnel
BetaTunnelToken beta().tunnels().revealToken(params = TunnelRevealTokenParams.none(), requestOptions = RequestOptions.none())
POST/v1/tunnels/{tunnel_id}/reveal_token

A API Tunnels está em "research preview" (prévia de pesquisa). Ela requer o cabeçalho anthropic-beta: mcp-tunnels-2026-06-22 e pode mudar sem um período de descontinuação. Ela substitui os endpoints da Admin API em /v1/organizations/tunnels, que permanecem disponíveis durante uma janela de migração.

Rotacionar token do túnel
BetaTunnelToken beta().tunnels().rotateToken(params = TunnelRotateTokenParams.none(), requestOptions = RequestOptions.none())
POST/v1/tunnels/{tunnel_id}/rotate_token

A API Tunnels está em "research preview" (prévia de pesquisa). Ela requer o cabeçalho anthropic-beta: mcp-tunnels-2026-06-22 e pode mudar sem um período de descontinuação. Ela substitui os endpoints da Admin API em /v1/organizations/tunnels, que permanecem disponíveis durante uma janela de migração.

BetaTúneisCertificados

Criar certificado de túnel
BetaTunnelCertificate beta().tunnels().certificates().create(params, requestOptions = RequestOptions.none())
POST/v1/tunnels/{tunnel_id}/certificates

A API Tunnels está em "research preview" (prévia de pesquisa). Ela requer o cabeçalho anthropic-beta: mcp-tunnels-2026-06-22 e pode mudar sem um período de descontinuação. Ela substitui os endpoints da Admin API em /v1/organizations/tunnels, que permanecem disponíveis durante uma janela de migração.

Obter certificado de túnel
BetaTunnelCertificate beta().tunnels().certificates().retrieve(params, requestOptions = RequestOptions.none())
GET/v1/tunnels/{tunnel_id}/certificates/{certificate_id}

A API Tunnels está em "research preview" (prévia de pesquisa). Ela requer o cabeçalho anthropic-beta: mcp-tunnels-2026-06-22 e pode mudar sem um período de descontinuação. Ela substitui os endpoints da Admin API em /v1/organizations/tunnels, que permanecem disponíveis durante uma janela de migração.

Listar certificados de túnel
CertificateListPage beta().tunnels().certificates().list(params = CertificateListParams.none(), requestOptions = RequestOptions.none())
GET/v1/tunnels/{tunnel_id}/certificates

A API Tunnels está em "research preview" (prévia de pesquisa). Ela requer o cabeçalho anthropic-beta: mcp-tunnels-2026-06-22 e pode mudar sem um período de descontinuação. Ela substitui os endpoints da Admin API em /v1/organizations/tunnels, que permanecem disponíveis durante uma janela de migração.

Arquivar certificado de túnel
BetaTunnelCertificate beta().tunnels().certificates().archive(params, requestOptions = RequestOptions.none())
POST/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

A API Tunnels está em "research preview" (prévia de pesquisa). Ela requer o cabeçalho anthropic-beta: mcp-tunnels-2026-06-22 e pode mudar sem um período de descontinuação. Ela substitui os endpoints da Admin API em /v1/organizations/tunnels, que permanecem disponíveis durante uma janela de migração.

BetaOrganização

Obter organização atual
BetaOrganization beta().organization().retrieve(params = OrganizationRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/me

Recupere informações sobre a organização associada à chave de API autenticada.

BetaOrganizaçãoChaves de API

Listar chaves de API
ApiKeyListPage beta().organization().apiKeys().list(params = ApiKeyListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/api_keys
Recuperar chave de API (Admin API)
BetaApiKey beta().organization().apiKeys().retrieve(params = ApiKeyRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/api_keys/{api_key_id}

Recupere informações sobre uma única chave de API em sua organização, pesquisada pelo ID. Este endpoint da Admin API requer uma chave de Admin API, destina-se ao gerenciamento programático de chaves e nunca retorna o valor secreto da chave. Para visualizar ou criar suas próprias chaves de API, acesse Chaves de API no Claude Console.

Atualizar chave de API
BetaApiKey beta().organization().apiKeys().update(params = ApiKeyUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/api_keys/{api_key_id}

BetaOrganizaçãoChaves externas

Criar chave externa
BetaExternalKey beta().organization().externalKeys().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/external_keys

Crie uma configuração de chave externa pertencente à organização do chamador.

Listar chaves externas
ExternalKeyListPage beta().organization().externalKeys().list(params = ExternalKeyListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/external_keys

Liste as configurações de chaves externas na organização do chamador.

Obter chave externa
BetaExternalKey beta().organization().externalKeys().retrieve(params = ExternalKeyRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/external_keys/{external_key_id}

Recupere uma única configuração de chave externa na organização do chamador pelo ID.

Atualizar chave externa
BetaExternalKey beta().organization().externalKeys().update(params = ExternalKeyUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/external_keys/{external_key_id}

Atualize parcialmente uma configuração de chave externa. Campos omitidos permanecem inalterados.

Excluir chave externa
ExternalKeyDeleteResponse beta().organization().externalKeys().delete(params = ExternalKeyDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/organizations/external_keys/{external_key_id}

Exclua uma configuração de chave externa.

Validar chave externa
ExternalKeyValidateResponse beta().organization().externalKeys().validate(params = ExternalKeyValidateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/external_keys/{external_key_id}/validate

Valide uma configuração de chave externa em relação ao KMS do cliente.

BetaOrganizaçãoFederaçãoEmissores

Criar emissor de federação
BetaFederationIssuer beta().organization().federation().issuers().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/federation_issuers

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.

Listar emissores de federação
IssuerListPage beta().organization().federation().issuers().list(params = IssuerListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/federation_issuers

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 emissor de federação
BetaFederationIssuer beta().organization().federation().issuers().retrieve(params = IssuerRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/federation_issuers/{federation_issuer_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 emissor de federação
BetaFederationIssuer beta().organization().federation().issuers().update(params = IssuerUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/federation_issuers/{federation_issuer_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.

Arquivar emissor de federação
BetaFederationIssuer beta().organization().federation().issuers().archive(params = IssuerArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

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.

BetaOrganizaçãoFederaçãoRegras

Criar regra de federação
BetaFederationRule beta().organization().federation().rules().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/federation_rules

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.

Listar regras de federação
RuleListPage beta().organization().federation().rules().list(params = RuleListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/federation_rules

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 regra de federação
BetaFederationRule beta().organization().federation().rules().retrieve(params = RuleRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/federation_rules/{federation_rule_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 regra de federação
BetaFederationRule beta().organization().federation().rules().update(params = RuleUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/federation_rules/{federation_rule_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.

Arquivar regra de federação
BetaFederationRule beta().organization().federation().rules().archive(params = RuleArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

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.

BetaOrganizaçãoFederaçãoRegrasEspaços de trabalho

Adicionar workspace à regra de federação
BetaFederationRuleWorkspace beta().organization().federation().rules().workspaces().add(params, requestOptions = RequestOptions.none())
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

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.

Listar workspaces da regra de federação
WorkspaceListPage beta().organization().federation().rules().workspaces().list(params = WorkspaceListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

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.

Remover workspace da regra de federação
WorkspaceRemoveResponse beta().organization().federation().rules().workspaces().remove(params, requestOptions = RequestOptions.none())
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_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.

BetaOrganizaçãoConvites

Criar convite
BetaOrganizationInvite beta().organization().invites().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/invites

Convide um usuário para ingressar na organização por e-mail.

Listar convites
InviteListPage beta().organization().invites().list(params = InviteListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/invites

Liste os convites da organização.

Obter convite
BetaOrganizationInvite beta().organization().invites().retrieve(params = InviteRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/invites/{invite_id}

Recupere um convite pelo ID.

Excluir convite
InviteDeleteResponse beta().organization().invites().delete(params = InviteDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/organizations/invites/{invite_id}

Exclua um convite pendente.

BetaOrganizaçãoContas de serviço

Criar conta de serviço
BetaServiceAccount beta().organization().serviceAccounts().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/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.

Listar contas de serviço
ServiceAccountListPage beta().organization().serviceAccounts().list(params = ServiceAccountListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/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 conta de serviço
BetaServiceAccount beta().organization().serviceAccounts().retrieve(params = ServiceAccountRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/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 conta de serviço
BetaServiceAccount beta().organization().serviceAccounts().update(params = ServiceAccountUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/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.

Arquivar conta de serviço
BetaServiceAccount beta().organization().serviceAccounts().archive(params = ServiceAccountArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/service_accounts/{service_account_id}/archive

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.

BetaOrganizaçãoContas de serviçoEspaços de trabalho

Adicionar workspace à conta de serviço
BetaServiceAccountWorkspaceMember beta().organization().serviceAccounts().workspaces().add(params, requestOptions = RequestOptions.none())
POST/v1/organizations/service_accounts/{service_account_id}/workspaces

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.

Listar workspaces da conta de serviço
WorkspaceListPage beta().organization().serviceAccounts().workspaces().list(params = WorkspaceListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/service_accounts/{service_account_id}/workspaces

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.

Remover workspace da conta de serviço
WorkspaceRemoveResponse beta().organization().serviceAccounts().workspaces().remove(params, requestOptions = RequestOptions.none())
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_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.

BetaOrganizaçãoUsuários

Listar usuários
UserListPage beta().organization().users().list(params = UserListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/users

Liste os membros da organização.

Obter usuário
BetaOrganizationUser beta().organization().users().retrieve(params = UserRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/users/{user_id}

Recupere um membro da organização pelo ID de usuário.

Atualizar usuário
BetaOrganizationUser beta().organization().users().update(params, requestOptions = RequestOptions.none())
POST/v1/organizations/users/{user_id}

Atualize a função de um membro na organização.

Remover usuário
UserRemoveResponse beta().organization().users().remove(params = UserRemoveParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/organizations/users/{user_id}

Remova um membro da organização.

BetaOrganizaçãoEspaços de trabalho

Listar workspaces
WorkspaceListPage beta().organization().workspaces().list(params = WorkspaceListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/workspaces
Criar workspace
BetaWorkspace beta().organization().workspaces().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/workspaces
Obter workspace
BetaWorkspace beta().organization().workspaces().retrieve(params = WorkspaceRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}
Atualizar workspace
BetaWorkspace beta().organization().workspaces().update(params = WorkspaceUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}
Arquivar workspace
BetaWorkspace beta().organization().workspaces().archive(params = WorkspaceArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/archive

BetaOrganizaçãoEspaços de trabalhoLimites de taxa

Listar limites de taxa do workspace
RateLimitListPage beta().organization().workspaces().rateLimits().list(params = RateLimitListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

Liste os limites de taxa de um workspace.

BetaOrganizaçãoEspaços de trabalhoMembros

Listar membros do workspace
MemberListPage beta().organization().workspaces().members().list(params = MemberListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/members
Criar membro do workspace
BetaWorkspaceMember beta().organization().workspaces().members().add(params, requestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/members
Obter membro do workspace
BetaWorkspaceMember beta().organization().workspaces().members().retrieve(params, requestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Atualizar membro do workspace
BetaWorkspaceMember beta().organization().workspaces().members().update(params, requestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Excluir membro do workspace
MemberRemoveResponse beta().organization().workspaces().members().remove(params, requestOptions = RequestOptions.none())
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

BetaOrganizaçãoEspaços de trabalhoContas de serviço

Listar membros de workspace de conta de serviço
ServiceAccountListPage beta().organization().workspaces().serviceAccounts().list(params = ServiceAccountListParams.none(), requestOptions = RequestOptions.none())
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(params, requestOptions = RequestOptions.none())
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(params, requestOptions = RequestOptions.none())
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(params, requestOptions = RequestOptions.none())
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(params, requestOptions = RequestOptions.none())
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.

BetaOrganizaçãoLimites de taxa

Listar limites de taxa da organização
RateLimitListPage beta().organization().rateLimits().list(params = RateLimitListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/rate_limits

Lista os "rate limits" (limites de taxa) da Messages API para sua organização.

BetaOrganizaçãoConfigurações de conformidade

Obter configurações de conformidade
BetaComplianceSettings beta().organization().complianceSettings().retrieve(params = ComplianceSettingRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/compliance_settings

Recupera as Configurações de conformidade da sua organização.

Atualizar configurações de conformidade
BetaComplianceSettings beta().organization().complianceSettings().update(params, requestOptions = RequestOptions.none())
POST/v1/organizations/compliance_settings

Atualiza as Configurações de conformidade da sua organização.

BetaOrganizaçãoAnálisesResumos

Obter resumos de atividade
SummaryListPage beta().organization().analytics().summaries().list(params, requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/summaries

Obtenha resumos de atividade de toda a organização para um intervalo de datas.

BetaOrganizaçãoAnálisesUsuários

Listar atividade de usuários
UserListPage beta().organization().analytics().users().list(params = UserListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/users

Obtém a atividade por usuário em um determinado dia, com paginação baseada em cursor.

BetaOrganizaçãoAnálisesAplicativosChatProjetos

Obter uso de projetos de chat
ProjectListPage beta().organization().analytics().apps().chat().projects().list(params = ProjectListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/apps/chat/projects

Obtém a atividade por projeto para um determinado dia, com paginação baseada em cursor.

BetaOrganizaçãoAnálisesConectores

Obter uso de conectores
ConnectorListPage beta().organization().analytics().connectors().list(params = ConnectorListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/connectors

Obtém o uso por conector em um determinado dia, com paginação baseada em cursor.

BetaOrganizaçãoAnálisesPlugins

Obter uso de plugins
PluginListPage beta().organization().analytics().plugins().list(params = PluginListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/plugins

Obtém o uso de instalação + invocação por plugin em um determinado dia, com paginação.

BetaOrganizaçãoAnálisesSkills

Obter uso de skills
SkillListPage beta().organization().analytics().skills().list(params = SkillListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/skills

Obtém o uso por skill em um determinado dia, com paginação baseada em cursor.

BetaOrganizaçãoAnálisesArtifacts

Obter atividade de artifacts
ArtifactListPage beta().organization().analytics().artifacts().list(params, requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/artifacts

Obtém a atividade de criação de artifacts em um determinado dia, detalhada por tipo MIME.

BetaOrganizaçãoAnálisesRelatório de uso

Obter uso de tokens ao longo do tempo
UsageReportListPage beta().organization().analytics().usageReport().list(params, requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/usage_report

Obtém o uso de tokens ao longo do tempo em um intervalo de datas.

BetaOrganizaçãoAnálisesRelatório de uso por usuário

Obter uso de tokens por usuário
UserUsageReportListPage beta().organization().analytics().userUsageReport().list(params, requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/user_usage_report

Obtém o uso de tokens por usuário em um intervalo de datas.

BetaOrganizaçãoAnálisesRelatório de custos

Obter custo ao longo do tempo
CostReportListPage beta().organization().analytics().costReport().list(params, requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/cost_report

Obtém o custo em USD ao longo do tempo em um intervalo de datas.

BetaOrganizaçãoAnálisesRelatório de custos por usuário

Obter custo por usuário
UserCostReportListPage beta().organization().analytics().userCostReport().list(params, requestOptions = RequestOptions.none())
GET/v1/organizations/analytics/user_cost_report

Obtém o custo por usuário em USD em um intervalo de datas.

BetaOrganizaçãoLimites de gastos

Definir limite de gastos
BetaSpendLimit beta().organization().spendLimits().set(params, requestOptions = RequestOptions.none())
POST/v1/organizations/spend_limits

Define um limite de gastos.

Obter limite de gastos
BetaSpendLimit beta().organization().spendLimits().retrieve(params = SpendLimitRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/spend_limits/{spend_limit_id}

Recupere um limite de gastos por ID.

Excluir limite de gastos
SpendLimitDeleteResponse beta().organization().spendLimits().delete(params = SpendLimitDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/organizations/spend_limits/{spend_limit_id}

Exclui um limite de gastos.

Listar limites de gastos
SpendLimitListPage beta().organization().spendLimits().list(params = SpendLimitListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/spend_limits

Lista os limites de gastos da organização.

BetaOrganizaçãoLimites de gastosEfetivos

Listar limites de gastos efetivos
EffectiveListPage beta().organization().spendLimits().effective().list(params = EffectiveListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/spend_limits/effective

Lista o limite de gastos efetivo de cada membro e os gastos acumulados no período.

BetaOrganizaçãoLimites de gastosSolicitações de aumento

Listar solicitações de aumento de limite de gastos
IncreaseRequestListPage beta().organization().spendLimits().increaseRequests().list(params = IncreaseRequestListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/spend_limit_increase_requests

Liste as solicitações de aumento de limite de gastos, mais recentes primeiro.

Obter solicitação de aumento de limite de gastos
BetaSpendLimitIncreaseRequest beta().organization().spendLimits().increaseRequests().retrieve(params = IncreaseRequestRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}

Recupere uma solicitação de aumento de limite de gastos.

Aprovar solicitação de aumento de limite de gastos
IncreaseRequestApproveResponse beta().organization().spendLimits().increaseRequests().approve(params, requestOptions = RequestOptions.none())
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve

Aprove uma solicitação pendente de aumento de limite de gastos.

Negar solicitação de aumento de limite de gastos
BetaSpendLimitIncreaseRequest beta().organization().spendLimits().increaseRequests().deny(params = IncreaseRequestDenyParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny

Negue uma solicitação pendente de aumento de limite de gastos.

BetaOrganizaçãoGrupos RBAC

Criar grupo RBAC
BetaRbacGroup beta().organization().rbacGroups().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/rbac_groups

Cria um grupo RBAC no tenant do Claude Enterprise. Grupos criados pela API têm o tipo de origem "direct".

Listar grupos RBAC
RbacGroupListPage beta().organization().rbacGroups().list(params = RbacGroupListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/rbac_groups

Lista os grupos RBAC no tenant do Claude Enterprise.

Obter grupo RBAC
BetaRbacGroup beta().organization().rbacGroups().retrieve(params = RbacGroupRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/rbac_groups/{rbac_group_id}

Recupera um grupo RBAC por ID.

Atualizar grupo RBAC
BetaRbacGroup beta().organization().rbacGroups().update(params = RbacGroupUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/rbac_groups/{rbac_group_id}

Atualiza o nome de um grupo RBAC. Grupos provisionados por um provedor de identidade (tipo de origem "scim") não podem ser modificados pela API enquanto uma organização no tenant usar provisionamento SCIM.

Excluir grupo RBAC
RbacGroupDeleteResponse beta().organization().rbacGroups().delete(params = RbacGroupDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/organizations/rbac_groups/{rbac_group_id}

Exclui um grupo RBAC. Grupos provisionados por um provedor de identidade (tipo de origem "scim") não podem ser excluídos pela API enquanto uma organização no tenant usar provisionamento SCIM.

BetaOrganizaçãoGrupos RBACMembros

Listar membros do grupo RBAC
MemberListPage beta().organization().rbacGroups().members().list(params = MemberListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/rbac_groups/{rbac_group_id}/members

Lista os membros de um grupo RBAC.

Adicionar membro ao grupo RBAC
BetaRbacGroupMember beta().organization().rbacGroups().members().add(params, requestOptions = RequestOptions.none())
POST/v1/organizations/rbac_groups/{rbac_group_id}/members

Adiciona um usuário a um grupo RBAC. A associação a grupos provisionados por um provedor de identidade (tipo de origem "scim") não pode ser modificada pela API enquanto uma organização no tenant usar provisionamento SCIM.

Remover membro do grupo RBAC
MemberRemoveResponse beta().organization().rbacGroups().members().remove(params, requestOptions = RequestOptions.none())
DELETE/v1/organizations/rbac_groups/{rbac_group_id}/members/{user_id}

Remove um usuário de um grupo RBAC. A associação a grupos provisionados por um provedor de identidade (tipo de origem "scim") não pode ser modificada pela API enquanto uma organização no tenant usar provisionamento SCIM.

BetaOrganizaçãoFunções RBAC

Listar funções RBAC
RbacRoleListPage beta().organization().rbacRoles().list(params = RbacRoleListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/rbac_roles

Lista as funções RBAC na organização.

Obter função RBAC
BetaRbacRole beta().organization().rbacRoles().retrieve(params = RbacRoleRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/rbac_roles/{rbac_role_id}

Recupera uma função RBAC por ID.

BetaOrganizaçãoFunções RBACPermissões

Listar permissões da função RBAC
PermissionListPage beta().organization().rbacRoles().permissions().list(params = PermissionListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/rbac_roles/{rbac_role_id}/permissions

Lista as permissões concedidas por uma função RBAC.

BetaOrganizaçãoPlugins

Criar plugin
BetaPlugin beta().organization().plugins().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/plugins

Cria um plugin pertencente à organização e sua primeira versão fazendo upload dos arquivos da versão.

Obter plugin
BetaPlugin beta().organization().plugins().retrieve(params = PluginRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/plugins/{plugin_id}

Recupera um plugin pelo ID.

Atualizar plugin
BetaPlugin beta().organization().plugins().update(params, requestOptions = RequestOptions.none())
POST/v1/organizations/plugins/{plugin_id}

Altere qual versão armazenada de um Plugin pertencente à organização é servida aos membros, por exemplo, para reverter para uma versão anterior. Isso fixa a versão servida: uploads posteriores são armazenados, mas deixam de alterar o que é servido, e a fixação atualmente não pode ser desfeita, nem aqui nem no claude.ai.

Listar Plugins
PluginListPage beta().organization().plugins().list(params = PluginListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/plugins

Liste os Plugins criados na organização, do mais recente para o mais antigo: os que estão nos marketplaces de plugins da própria organização e os que estão nos marketplaces de plugins pessoais dos membros.

Excluir Plugin
BetaDeletedPlugin beta().organization().plugins().delete(params = PluginDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/organizations/plugins/{plugin_id}

Exclua permanentemente um Plugin e todas as versões que ele contém, exatamente como quando um administrador o exclui no claude.ai. O Plugin pode pertencer à organização ou a um membro, incluindo um membro que já saiu da organização.

BetaOrganizaçãoPluginsVersões

Criar versão do Plugin
BetaPluginVersion beta().organization().plugins().versions().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/plugins/{plugin_id}/versions

Adicione uma versão a um Plugin pertencente à organização enviando os arquivos da nova versão; ela se torna a versão servida aos membros, a menos que a versão servida do Plugin tenha sido fixada.

Listar versões do Plugin
VersionListPage beta().organization().plugins().versions().list(params = VersionListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/plugins/{plugin_id}/versions

Liste as versões de um Plugin, da mais recente para a mais antiga.

Obter versão do Plugin
BetaPluginVersion beta().organization().plugins().versions().retrieve(params, requestOptions = RequestOptions.none())
GET/v1/organizations/plugins/{plugin_id}/versions/{version}

Recupere uma versão de um Plugin pelo seu ID, ou a versão mais recente do Plugin.

Baixar arquivo da versão do Plugin
HttpResponse beta().organization().plugins().versions().download(params, requestOptions = RequestOptions.none())
GET/v1/organizations/plugins/{plugin_id}/versions/{version}/content

Baixe o arquivo .zip de uma versão, exatamente como armazenado. Cada download de um Plugin do marketplace de plugins pessoal de um membro é registrado no feed de atividades da Compliance API.

BetaOrganizaçãoPluginsConfigurações de instalação

Listar configurações de instalação do Plugin
InstallationSettingListPage beta().organization().plugins().installationSettings().list(params = InstallationSettingListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/plugins/{plugin_id}/installation_settings

Liste as configurações de instalação de um Plugin pertencente à organização, que indicam para quais membros ele se destina, das criadas mais recentemente para as mais antigas.

Definir configuração de instalação do Plugin
BetaPluginInstallationSetting beta().organization().plugins().installationSettings().set(params, requestOptions = RequestOptions.none())
POST/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

Defina ou altere a configuração de instalação de um Plugin pertencente à organização para toda a organização ou para um Grupo RBAC.

Remover configuração de instalação do Plugin
BetaDeletedPluginInstallationSetting beta().organization().plugins().installationSettings().remove(params, requestOptions = RequestOptions.none())
DELETE/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

Remova a configuração de instalação própria de um Plugin pertencente à organização para toda a organização ou para um Grupo RBAC.

BetaOrganizaçãoPluginsCompartilhamentos

Listar compartilhamentos do Plugin
ShareListPage beta().organization().plugins().shares().list(params = ShareListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/plugins/{plugin_id}/shares

Liste os compartilhamentos que o proprietário de um Plugin pertencente a um membro concedeu — a todos os membros da organização, a um Grupo RBAC ou a um membro — dos concedidos mais recentemente para os mais antigos.

BetaOrganizaçãoMarketplaces de plugins

Listar marketplaces de plugins
PluginMarketplaceListPage beta().organization().pluginMarketplaces().list(params = PluginMarketplaceListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/plugin_marketplaces

Liste os marketplaces de plugins em que os Plugins estão, do mais recente para o mais antigo: os da própria organização e os pessoais de seus membros.

Obter marketplace de plugins
BetaPluginMarketplace beta().organization().pluginMarketplaces().retrieve(params = PluginMarketplaceRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/plugin_marketplaces/{marketplace_id}

Recupere um marketplace de plugins pelo ID.

Atualizar marketplace de plugins
BetaPluginMarketplace beta().organization().pluginMarketplaces().update(params, requestOptions = RequestOptions.none())
POST/v1/organizations/plugin_marketplaces/{marketplace_id}

Defina a configuração de instalação padrão de um dos marketplaces de plugins da própria organização. Todo Plugin nele sem uma configuração própria recebe esse padrão como sua configuração para toda a organização, incluindo Plugins adicionados posteriormente.

Validar repositório do marketplace de plugins
BetaPluginMarketplaceValidationReport beta().organization().pluginMarketplaces().validateRepository(params, requestOptions = RequestOptions.none())
POST/v1/organizations/plugin_marketplaces/validate_repository

Verifique se um marketplace de plugins mantido em um repositório público do GitHub seria sincronizado no claude.ai, sem conectá-lo nem armazená-lo.

Validar arquivo do marketplace de plugins
BetaPluginMarketplaceValidationReport beta().organization().pluginMarketplaces().validateArchive(params, requestOptions = RequestOptions.none())
POST/v1/organizations/plugin_marketplaces/validate_archive

Verifique se um marketplace de plugins, enviado como um .zip do diretório do marketplace, seria sincronizado no claude.ai, sem conectá-lo nem armazená-lo.

BetaOrganizaçãoDestinos de telemetria

Criar um destino de telemetria
BetaTelemetryDestination beta().organization().telemetryDestinations().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/telemetry_destinations

Registra um destino OpenTelemetry para a organização.

Listar destinos de telemetria
TelemetryDestinationListPage beta().organization().telemetryDestinations().list(params = TelemetryDestinationListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/telemetry_destinations

Lista os destinos da organização, do mais recente para o mais antigo, opcionalmente apenas aqueles que cobrem determinados workspaces.

Recuperar um destino de telemetria
BetaTelemetryDestination beta().organization().telemetryDestinations().retrieve(params = TelemetryDestinationRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/telemetry_destinations/{destination_id}

Lê a configuração, o estado e os resultados de entrega mais recentes de um destino.

Atualizar um destino de telemetria
BetaTelemetryDestination beta().organization().telemetryDestinations().update(params = TelemetryDestinationUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/telemetry_destinations/{destination_id}

Altera as configurações de um destino de telemetria, seu estado ou quais workspaces ele cobre.

Excluir um destino de telemetria
BetaDeletedTelemetryDestination beta().organization().telemetryDestinations().delete(params = TelemetryDestinationDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/organizations/telemetry_destinations/{destination_id}

Exclui um destino e sua lista de workspaces.

Testar um destino de telemetria
BetaTelemetryDestinationTestResponse beta().organization().telemetryDestinations().test(params = TelemetryDestinationTestParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/telemetry_destinations/{destination_id}/test

Envia um span de teste, chamado anthropic.test, ao destino com seus cabeçalhos registrados, uma única vez e sem novas tentativas, e relata a resposta do destino. A resposta é 200, quer o destino tenha respondido com um status 2xx ou não: seu result tem o tipo success, ou o tipo failure e o motivo em error. A configuração, o state e o delivery_health do destino não mudam. Um destino desabilitado também pode ser testado. Aguarde 10 segundos entre testes de um mesmo destino; uma solicitação que chegar antes disso pode ser respondida com o status 429.

BetaOrganizaçãoDestinos de telemetriaEspaços de trabalho

Listar workspaces de destino de telemetria
WorkspaceListPage beta().organization().telemetryDestinations().workspaces().list(params = WorkspaceListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/telemetry_destinations/{destination_id}/workspaces

Lista os workspaces na lista de workspaces de um destino, com a entrada mais recente primeiro.

Adicionar um workspace de destino de telemetria
BetaTelemetryDestinationWorkspace beta().organization().telemetryDestinations().workspaces().add(params, requestOptions = RequestOptions.none())
POST/v1/organizations/telemetry_destinations/{destination_id}/workspaces/{workspace_id}

Adiciona um workspace à lista de workspaces de um destino.

Remover um workspace de destino de telemetria
BetaDeletedTelemetryDestinationWorkspace beta().organization().telemetryDestinations().workspaces().remove(params, requestOptions = RequestOptions.none())
DELETE/v1/organizations/telemetry_destinations/{destination_id}/workspaces/{workspace_id}

Remove um workspace da lista de workspaces de um destino.