Claude Platform Docs

Beta

Models
class BetaApiError { Type = "api_error"; Message; }
JsonElement Type = "api_error"
required string Message
class BetaAuthenticationError { Type = "authentication_error"; Message; }
JsonElement Type = "authentication_error"
required string Message
class BetaBillingError { Type = "billing_error"; Message; }
JsonElement Type = "billing_error"
required string Message
enum BetaCurrency
Usd("USD")
class BetaError: union
class BetaErrorResponse { Type = "error"; Error; RequestID; }
JsonElement Type = "error"
required BetaError Error
One of the following:
required string? RequestID
class BetaGatewayTimeoutError { Type = "timeout_error"; Message; }
JsonElement Type = "timeout_error"
required string Message
class BetaInvalidRequestError { Type = "invalid_request_error"; Message; }
JsonElement Type = "invalid_request_error"
required string Message
class BetaMonetaryAmount { Amount; Currency; }

A monetary amount in a specific currency.

required 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.

required 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; }
JsonElement Type = "not_found_error"
required string Message
class BetaOverloadedError { Type = "overloaded_error"; Message; }
JsonElement Type = "overloaded_error"
required string Message
class BetaPermissionError { Type = "permission_error"; Message; }
JsonElement Type = "permission_error"
required string Message
class BetaRateLimitError { Type = "rate_limit_error"; Message; }
JsonElement Type = "rate_limit_error"
required string Message

BetaModelos

Listar modelos
ModelListPage Beta.Models.List(parameters, cancellationToken = default)
GET/v1/models

Liste os modelos disponíveis.

Obter um modelo
BetaModelInfo Beta.Models.Retrieve(parameters, cancellationToken = default)
GET/v1/models/{model_id}

Obtenha um modelo específico.

BetaMensagens

Criar uma mensagem
BetaMessage Beta.Messages.Create(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
DELETE/v1/messages/batches/{message_batch_id}

Exclua um lote de mensagens.

Recuperar resultados de um lote de mensagens
BetaMessageBatchIndividualResponse Beta.Messages.Batches.ResultsStreaming(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
POST/v1/agents
Listar agentes
AgentListPage Beta.Agents.List(parameters, cancellationToken = default)
GET/v1/agents
Obter agente
BetaManagedAgentsAgent Beta.Agents.Retrieve(parameters, cancellationToken = default)
GET/v1/agents/{agent_id}
Atualizar agente
BetaManagedAgentsAgent Beta.Agents.Update(parameters, cancellationToken = default)
POST/v1/agents/{agent_id}
Arquivar agente
BetaManagedAgentsAgent Beta.Agents.Archive(parameters, cancellationToken = default)
POST/v1/agents/{agent_id}/archive

BetaAgentesVersões

Listar versões do agente
VersionListPage Beta.Agents.Versions.List(parameters, cancellationToken = default)
GET/v1/agents/{agent_id}/versions

BetaAmbientes

Criar ambiente
BetaEnvironment Beta.Environments.Create(parameters, cancellationToken = default)
POST/v1/environments

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

Listar ambientes
EnvironmentListPage Beta.Environments.List(parameters, cancellationToken = default)
GET/v1/environments

Liste ambientes com suporte a paginação.

Obter ambiente
BetaEnvironment Beta.Environments.Retrieve(parameters, cancellationToken = default)
GET/v1/environments/{environment_id}

Recupere um ambiente específico por ID.

Atualizar ambiente
BetaEnvironment Beta.Environments.Update(parameters, cancellationToken = default)
POST/v1/environments/{environment_id}

Atualize a configuração de um ambiente existente.

Excluir ambiente
BetaEnvironmentDeleteResponse Beta.Environments.Delete(parameters, cancellationToken = default)
DELETE/v1/environments/{environment_id}

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

Arquivar ambiente
BetaEnvironment Beta.Environments.Archive(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
POST/v1/sessions
Listar sessões
SessionListPage Beta.Sessions.List(parameters, cancellationToken = default)
GET/v1/sessions
Obter sessão
BetaManagedAgentsSession Beta.Sessions.Retrieve(parameters, cancellationToken = default)
GET/v1/sessions/{session_id}
Atualizar sessão
BetaManagedAgentsSession Beta.Sessions.Update(parameters, cancellationToken = default)
POST/v1/sessions/{session_id}
Excluir sessão
BetaManagedAgentsDeletedSession Beta.Sessions.Delete(parameters, cancellationToken = default)
DELETE/v1/sessions/{session_id}
Arquivar sessão
BetaManagedAgentsSession Beta.Sessions.Archive(parameters, cancellationToken = default)
POST/v1/sessions/{session_id}/archive

BetaSessõesEventos

Listar eventos
EventListPage Beta.Sessions.Events.List(parameters, cancellationToken = default)
GET/v1/sessions/{session_id}/events
Enviar eventos
BetaManagedAgentsSendSessionEvents Beta.Sessions.Events.Send(parameters, cancellationToken = default)
POST/v1/sessions/{session_id}/events
Fazer streaming de eventos
BetaManagedAgentsStreamSessionEvents Beta.Sessions.Events.StreamStreaming(parameters, cancellationToken = default)
GET/v1/sessions/{session_id}/events/stream

BetaSessõesRecursos

Adicionar recurso de sessão
BetaManagedAgentsFileResource Beta.Sessions.Resources.Add(parameters, cancellationToken = default)
POST/v1/sessions/{session_id}/resources
Listar recursos de sessão
ResourceListPage Beta.Sessions.Resources.List(parameters, cancellationToken = default)
GET/v1/sessions/{session_id}/resources
Obter recurso de sessão
ResourceRetrieveResponse Beta.Sessions.Resources.Retrieve(parameters, cancellationToken = default)
GET/v1/sessions/{session_id}/resources/{resource_id}
Atualizar recurso de sessão
ResourceUpdateResponse Beta.Sessions.Resources.Update(parameters, cancellationToken = default)
POST/v1/sessions/{session_id}/resources/{resource_id}
Excluir recurso de sessão
BetaManagedAgentsDeleteSessionResource Beta.Sessions.Resources.Delete(parameters, cancellationToken = default)
DELETE/v1/sessions/{session_id}/resources/{resource_id}

BetaSessõesThreads

Listar threads de sessão
ThreadListPage Beta.Sessions.Threads.List(parameters, cancellationToken = default)
GET/v1/sessions/{session_id}/threads
Obter thread de sessão
BetaManagedAgentsSessionThread Beta.Sessions.Threads.Retrieve(parameters, cancellationToken = default)
GET/v1/sessions/{session_id}/threads/{thread_id}
Arquivar thread de sessão
BetaManagedAgentsSessionThread Beta.Sessions.Threads.Archive(parameters, cancellationToken = default)
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

BetaSessõesThreadsEventos

Listar eventos de thread de sessão
EventListPage Beta.Sessions.Threads.Events.List(parameters, cancellationToken = default)
GET/v1/sessions/{session_id}/threads/{thread_id}/events
Fazer streaming de eventos de thread de sessão
BetaManagedAgentsStreamSessionThreadEvents Beta.Sessions.Threads.Events.StreamStreaming(parameters, cancellationToken = default)
GET/v1/sessions/{session_id}/threads/{thread_id}/stream

BetaImplantações

Criar implantação
BetaManagedAgentsDeployment Beta.Deployments.Create(parameters, cancellationToken = default)
POST/v1/deployments
Listar implantações
DeploymentListPage Beta.Deployments.List(parameters, cancellationToken = default)
GET/v1/deployments
Obter implantação
BetaManagedAgentsDeployment Beta.Deployments.Retrieve(parameters, cancellationToken = default)
GET/v1/deployments/{deployment_id}
Atualizar implantação
BetaManagedAgentsDeployment Beta.Deployments.Update(parameters, cancellationToken = default)
POST/v1/deployments/{deployment_id}
Arquivar implantação
BetaManagedAgentsDeployment Beta.Deployments.Archive(parameters, cancellationToken = default)
POST/v1/deployments/{deployment_id}/archive
Executar implantação agora
BetaManagedAgentsDeploymentRun Beta.Deployments.Run(parameters, cancellationToken = default)
POST/v1/deployments/{deployment_id}/run
Pausar implantação
BetaManagedAgentsDeployment Beta.Deployments.Pause(parameters, cancellationToken = default)
POST/v1/deployments/{deployment_id}/pause
Retomar implantação
BetaManagedAgentsDeployment Beta.Deployments.Unpause(parameters, cancellationToken = default)
POST/v1/deployments/{deployment_id}/unpause

BetaExecuções de implantação

Listar execuções de implantação
DeploymentRunListPage Beta.DeploymentRuns.List(parameters, cancellationToken = default)
GET/v1/deployment_runs
Obter execução de implantação
BetaManagedAgentsDeploymentRun Beta.DeploymentRuns.Retrieve(parameters, cancellationToken = default)
GET/v1/deployment_runs/{deployment_run_id}

BetaCofres

Criar cofre
BetaManagedAgentsVault Beta.Vaults.Create(parameters, cancellationToken = default)
POST/v1/vaults
Listar cofres
VaultListPage Beta.Vaults.List(parameters, cancellationToken = default)
GET/v1/vaults
Obter cofre
BetaManagedAgentsVault Beta.Vaults.Retrieve(parameters, cancellationToken = default)
GET/v1/vaults/{vault_id}
Atualizar cofre
BetaManagedAgentsVault Beta.Vaults.Update(parameters, cancellationToken = default)
POST/v1/vaults/{vault_id}
Excluir cofre
BetaManagedAgentsDeletedVault Beta.Vaults.Delete(parameters, cancellationToken = default)
DELETE/v1/vaults/{vault_id}
Arquivar cofre
BetaManagedAgentsVault Beta.Vaults.Archive(parameters, cancellationToken = default)
POST/v1/vaults/{vault_id}/archive

BetaCofresCredenciais

Criar credencial
BetaManagedAgentsCredential Beta.Vaults.Credentials.Create(parameters, cancellationToken = default)
POST/v1/vaults/{vault_id}/credentials
Listar credenciais
CredentialListPage Beta.Vaults.Credentials.List(parameters, cancellationToken = default)
GET/v1/vaults/{vault_id}/credentials
Obter credencial
BetaManagedAgentsCredential Beta.Vaults.Credentials.Retrieve(parameters, cancellationToken = default)
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Atualizar credencial
BetaManagedAgentsCredential Beta.Vaults.Credentials.Update(parameters, cancellationToken = default)
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Excluir credencial
BetaManagedAgentsDeletedCredential Beta.Vaults.Credentials.Delete(parameters, cancellationToken = default)
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Arquivar credencial
BetaManagedAgentsCredential Beta.Vaults.Credentials.Archive(parameters, cancellationToken = default)
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Validar credencial
BetaManagedAgentsCredentialValidation Beta.Vaults.Credentials.McpOAuthValidate(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
POST/v1/memory_stores
Listar armazenamentos de memória
MemoryStoreListPage Beta.MemoryStores.List(parameters, cancellationToken = default)
GET/v1/memory_stores
Recuperar um armazenamento de memória
BetaManagedAgentsMemoryStore Beta.MemoryStores.Retrieve(parameters, cancellationToken = default)
GET/v1/memory_stores/{memory_store_id}
Atualizar um armazenamento de memória
BetaManagedAgentsMemoryStore Beta.MemoryStores.Update(parameters, cancellationToken = default)
POST/v1/memory_stores/{memory_store_id}
Excluir um armazenamento de memória
BetaManagedAgentsDeletedMemoryStore Beta.MemoryStores.Delete(parameters, cancellationToken = default)
DELETE/v1/memory_stores/{memory_store_id}
Arquivar um armazenamento de memória
BetaManagedAgentsMemoryStore Beta.MemoryStores.Archive(parameters, cancellationToken = default)
POST/v1/memory_stores/{memory_store_id}/archive

BetaArmazenamentos de memóriaMemórias

Criar uma memória
BetaManagedAgentsMemory Beta.MemoryStores.Memories.Create(parameters, cancellationToken = default)
POST/v1/memory_stores/{memory_store_id}/memories
Listar memórias
MemoryListPage Beta.MemoryStores.Memories.List(parameters, cancellationToken = default)
GET/v1/memory_stores/{memory_store_id}/memories
Recuperar uma memória
BetaManagedAgentsMemory Beta.MemoryStores.Memories.Retrieve(parameters, cancellationToken = default)
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Atualizar uma memória
BetaManagedAgentsMemory Beta.MemoryStores.Memories.Update(parameters, cancellationToken = default)
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Excluir uma memória
BetaManagedAgentsDeletedMemory Beta.MemoryStores.Memories.Delete(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
GET/v1/memory_stores/{memory_store_id}/memory_versions
Recuperar uma versão de memória
BetaManagedAgentsMemoryVersion Beta.MemoryStores.MemoryVersions.Retrieve(parameters, cancellationToken = default)
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
Suprimir uma versão de memória
BetaManagedAgentsMemoryVersion Beta.MemoryStores.MemoryVersions.Redact(parameters, cancellationToken = default)
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

BetaArquivos

Fazer upload de arquivo
BetaFileMetadata Beta.Files.Upload(parameters, cancellationToken = default)
POST/v1/files
Listar arquivos
FileListPage Beta.Files.List(parameters, cancellationToken = default)
GET/v1/files
Baixar arquivo
HttpResponse Beta.Files.Download(parameters, cancellationToken = default)
GET/v1/files/{file_id}/content
Obter metadados do arquivo
BetaFileMetadata Beta.Files.RetrieveMetadata(parameters, cancellationToken = default)
GET/v1/files/{file_id}
Excluir arquivo
BetaDeletedFile Beta.Files.Delete(parameters, cancellationToken = default)
DELETE/v1/files/{file_id}

BetaSkills

Criar skill
BetaSkill Beta.Skills.Create(parameters, cancellationToken = default)
POST/v1/skills
Listar skills
SkillListPage Beta.Skills.List(parameters, cancellationToken = default)
GET/v1/skills
Obter skill
BetaSkill Beta.Skills.Retrieve(parameters, cancellationToken = default)
GET/v1/skills/{skill_id}
Excluir skill
BetaDeletedSkill Beta.Skills.Delete(parameters, cancellationToken = default)
DELETE/v1/skills/{skill_id}

BetaSkillsVersões

Criar versão de skill
BetaSkillVersion Beta.Skills.Versions.Create(parameters, cancellationToken = default)
POST/v1/skills/{skill_id}/versions
Listar versões de skill
VersionListPage Beta.Skills.Versions.List(parameters, cancellationToken = default)
GET/v1/skills/{skill_id}/versions
Baixar conteúdo de versão de skill
HttpResponse Beta.Skills.Versions.Download(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
GET/v1/skills/{skill_id}/versions/{version}
Excluir versão de skill
BetaDeletedSkillVersion Beta.Skills.Versions.Delete(parameters, cancellationToken = default)
DELETE/v1/skills/{skill_id}/versions/{version}

BetaPerfis de usuário

Criar perfil de usuário
BetaUserProfile Beta.UserProfiles.Create(parameters, cancellationToken = default)
POST/v1/user_profiles
Listar perfis de usuário
UserProfileListPage Beta.UserProfiles.List(parameters, cancellationToken = default)
GET/v1/user_profiles
Obter perfil de usuário
BetaUserProfile Beta.UserProfiles.Retrieve(parameters, cancellationToken = default)
GET/v1/user_profiles/{user_profile_id}
Atualizar perfil de usuário
BetaUserProfile Beta.UserProfiles.Update(parameters, cancellationToken = default)
POST/v1/user_profiles/{user_profile_id}
Criar URL de inscrição
BetaUserProfileEnrollmentUrl Beta.UserProfiles.CreateEnrollmentUrl(parameters, cancellationToken = default)
POST/v1/user_profiles/{user_profile_id}/enrollment_url

BetaDreams

Criar um Dream
BetaDream Beta.Dreams.Create(parameters, cancellationToken = default)
POST/v1/dreams
Listar Dreams
DreamListPage Beta.Dreams.List(parameters, cancellationToken = default)
GET/v1/dreams
Obter um Dream
BetaDream Beta.Dreams.Retrieve(parameters, cancellationToken = default)
GET/v1/dreams/{dream_id}
Cancelar um Dream
BetaDream Beta.Dreams.Cancel(parameters, cancellationToken = default)
POST/v1/dreams/{dream_id}/cancel
Arquivar um Dream
BetaDream Beta.Dreams.Archive(parameters, cancellationToken = default)
POST/v1/dreams/{dream_id}/archive

BetaTúneis

Criar túnel
BetaTunnel Beta.Tunnels.Create(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
GET/v1/organizations/api_keys
Recuperar chave de API (Admin API)
BetaApiKey Beta.Organization.ApiKeys.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/api_keys/{api_key_id}

Recupere informações sobre uma única chave de API na sua organização, consultada pelo ID. Este endpoint da Admin API requer uma chave de API Admin, 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(parameters, cancellationToken = default)
POST/v1/organizations/api_keys/{api_key_id}

BetaOrganizaçãoChaves externas

Criar chave externa
BetaExternalKey Beta.Organization.ExternalKeys.Create(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
GET/v1/organizations/external_keys

Liste as configurações de chave externa na organização do chamador.

Obter chave externa
BetaExternalKey Beta.Organization.ExternalKeys.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/external_keys/{external_key_id}

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

Atualizar chave externa
BetaExternalKey Beta.Organization.ExternalKeys.Update(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
DELETE/v1/organizations/external_keys/{external_key_id}

Exclua uma configuração de chave externa.

Validar chave externa
ExternalKeyValidateResponse Beta.Organization.ExternalKeys.Validate(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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(parameters, cancellationToken = default)
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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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(parameters, cancellationToken = default)
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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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(parameters, cancellationToken = default)
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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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(parameters, cancellationToken = default)
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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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(parameters, cancellationToken = default)
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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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(parameters, cancellationToken = default)
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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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(parameters, cancellationToken = default)
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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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(parameters, cancellationToken = default)
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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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(parameters, cancellationToken = default)
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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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(parameters, cancellationToken = default)
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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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(parameters, cancellationToken = default)
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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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(parameters, cancellationToken = default)
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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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(parameters, cancellationToken = default)
POST/v1/organizations/invites

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

Listar convites
InviteListPage Beta.Organization.Invites.List(parameters, cancellationToken = default)
GET/v1/organizations/invites

Liste os convites da organização.

Obter convite
BetaOrganizationInvite Beta.Organization.Invites.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/invites/{invite_id}

Recupere um convite por ID.

Excluir convite
InviteDeleteResponse Beta.Organization.Invites.Delete(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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(parameters, cancellationToken = default)
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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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(parameters, cancellationToken = default)
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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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(parameters, cancellationToken = default)
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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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(parameters, cancellationToken = default)
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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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(parameters, cancellationToken = default)
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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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(parameters, cancellationToken = default)
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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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(parameters, cancellationToken = default)
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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); 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(parameters, cancellationToken = default)
GET/v1/organizations/users

Liste os membros da organização.

Obter usuário
BetaOrganizationUser Beta.Organization.Users.Retrieve(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
POST/v1/organizations/users/{user_id}

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

Remover usuário
UserRemoveResponse Beta.Organization.Users.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/users/{user_id}

Remova um membro da organização.

BetaOrganizaçãoEspaç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

BetaOrganizaçãoEspaç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 as substituições de limite de taxa configuradas para um workspace.

BetaOrganizaçãoEspaç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}

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

Listar membros de conta de serviço do workspace
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 por uma regra de workload identity federation (federação de identidade de carga de trabalho); chaves de Admin API não são aceitas. Consulte Gerenciar WIF com a Admin API.

Criar membro de conta de serviço do workspace
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 por uma regra de federação de identidade de carga de trabalho; chaves de API de administrador não são aceitas. Consulte Gerenciar WIF com a Admin API.

Obter membro de conta de serviço do workspace
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 por uma regra de federação de identidade de carga de trabalho; chaves de API de administrador não são aceitas. Consulte Gerenciar WIF com a Admin API.

Atualizar membro de conta de serviço do workspace
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 por uma regra de federação de identidade de carga de trabalho; chaves de API de administrador não são aceitas. Consulte Gerenciar WIF com a Admin API.

Excluir membro de conta de serviço do workspace
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 administrador 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(parameters, cancellationToken = default)
GET/v1/organizations/rate_limits

Lista os 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(parameters, cancellationToken = default)
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(parameters, cancellationToken = default)
POST/v1/organizations/compliance_settings

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