Claude Platform Docs

Beta

Models
AnthropicBeta = string or "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 47 more
One of the following:
BetaAPIError object{ type: "api_error", message }
type: "api_error"
defaultapi_error
message: string
defaultInternal server error
BetaAuthenticationError object{ type: "authentication_error", message }
type: "authentication_error"
defaultauthentication_error
message: string
defaultAuthentication error
BetaBillingError object{ type: "billing_error", message }
type: "billing_error"
defaultbilling_error
message: string
defaultBilling error
BetaCurrency = "USD"
BetaError = BetaInvalidRequestError or BetaAuthenticationError or BetaBillingError or 6 more
One of the following:
BetaErrorResponse object{ type: "error", error, request_id }
type: "error"
defaulterror
error: BetaError
One of the following:
request_id: string or null
BetaGatewayTimeoutError object{ type: "timeout_error", message }
type: "timeout_error"
defaulttimeout_error
message: string
defaultRequest timeout
BetaInvalidRequestError object{ type: "invalid_request_error", message }
type: "invalid_request_error"
defaultinvalid_request_error
message: string
defaultInvalid request
BetaMonetaryAmount object{ amount, currency }

A monetary amount in a specific currency.

amount: string

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.

currency: BetaCurrency

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.

BetaNotFoundError object{ type: "not_found_error", message }
type: "not_found_error"
defaultnot_found_error
message: string
defaultNot found
BetaOverloadedError object{ type: "overloaded_error", message }
type: "overloaded_error"
defaultoverloaded_error
message: string
defaultOverloaded
BetaPermissionError object{ type: "permission_error", message }
type: "permission_error"
defaultpermission_error
message: string
defaultPermission denied
BetaRateLimitError object{ type: "rate_limit_error", message }
type: "rate_limit_error"
defaultrate_limit_error
message: string
defaultRate limited

BetaModelos

Listar modelos
GET/v1/models

Liste os modelos disponíveis.

Obter um modelo
GET/v1/models/{model_id}

Obtenha um modelo específico.

BetaMensagens

Criar uma mensagem
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
POST/v1/messages/count_tokens

Conte o número de tokens em uma mensagem.

BetaMensagensLotes

Criar um lote de mensagens
POST/v1/messages/batches

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

Recuperar um lote de mensagens
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
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
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
DELETE/v1/messages/batches/{message_batch_id}

Exclua um lote de mensagens.

Recuperar resultados de um lote de mensagens
GET/v1/messages/batches/{message_batch_id}/results

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

BetaAgentes

Criar agente
POST/v1/agents
Listar agentes
GET/v1/agents
Obter agente
GET/v1/agents/{agent_id}
Atualizar agente
POST/v1/agents/{agent_id}
Arquivar agente
POST/v1/agents/{agent_id}/archive

BetaAgentesVersões

Listar versões do agente
GET/v1/agents/{agent_id}/versions

BetaAmbientes

Criar ambiente
POST/v1/environments

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

Listar ambientes
GET/v1/environments

Liste ambientes com suporte a paginação.

Obter ambiente
GET/v1/environments/{environment_id}

Recupere um ambiente específico por ID.

Atualizar ambiente
POST/v1/environments/{environment_id}

Atualize a configuração de um ambiente existente.

Excluir ambiente
DELETE/v1/environments/{environment_id}

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

Arquivar ambiente
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
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
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
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
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
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
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
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
GET/v1/environments/{environment_id}/work/stats

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

BetaSessões

Criar sessão
POST/v1/sessions
Listar sessões
GET/v1/sessions
Obter sessão
GET/v1/sessions/{session_id}
Atualizar sessão
POST/v1/sessions/{session_id}
Excluir sessão
DELETE/v1/sessions/{session_id}
Arquivar sessão
POST/v1/sessions/{session_id}/archive

BetaSessõesEventos

Listar eventos
GET/v1/sessions/{session_id}/events
Enviar eventos
POST/v1/sessions/{session_id}/events
Fazer streaming de eventos
GET/v1/sessions/{session_id}/events/stream

BetaSessõesRecursos

Adicionar recurso de sessão
POST/v1/sessions/{session_id}/resources
Listar recursos de sessão
GET/v1/sessions/{session_id}/resources
Obter recurso de sessão
GET/v1/sessions/{session_id}/resources/{resource_id}
Atualizar recurso de sessão
POST/v1/sessions/{session_id}/resources/{resource_id}
Excluir recurso de sessão
DELETE/v1/sessions/{session_id}/resources/{resource_id}

BetaSessõesThreads

Listar threads de sessão
GET/v1/sessions/{session_id}/threads
Obter thread de sessão
GET/v1/sessions/{session_id}/threads/{thread_id}
Arquivar thread de sessão
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

BetaSessõesThreadsEventos

Listar eventos de thread de sessão
GET/v1/sessions/{session_id}/threads/{thread_id}/events
Fazer streaming de eventos de thread de sessão
GET/v1/sessions/{session_id}/threads/{thread_id}/stream

BetaImplantações

Criar implantação
POST/v1/deployments
Listar implantações
GET/v1/deployments
Obter implantação
GET/v1/deployments/{deployment_id}
Atualizar implantação
POST/v1/deployments/{deployment_id}
Arquivar implantação
POST/v1/deployments/{deployment_id}/archive
Executar implantação agora
POST/v1/deployments/{deployment_id}/run
Pausar implantação
POST/v1/deployments/{deployment_id}/pause
Retomar implantação
POST/v1/deployments/{deployment_id}/unpause

BetaExecuções de implantação

Listar execuções de implantação
GET/v1/deployment_runs
Obter execução de implantação
GET/v1/deployment_runs/{deployment_run_id}

BetaCofres

Criar cofre
POST/v1/vaults
Listar cofres
GET/v1/vaults
Obter cofre
GET/v1/vaults/{vault_id}
Atualizar cofre
POST/v1/vaults/{vault_id}
Excluir cofre
DELETE/v1/vaults/{vault_id}
Arquivar cofre
POST/v1/vaults/{vault_id}/archive

BetaCofresCredenciais

Criar credencial
POST/v1/vaults/{vault_id}/credentials
Listar credenciais
GET/v1/vaults/{vault_id}/credentials
Obter credencial
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Atualizar credencial
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Excluir credencial
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Arquivar credencial
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Validar credencial
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate

BetaArmazenamentos de memória

Criar um armazenamento de memória
POST/v1/memory_stores
Listar armazenamentos de memória
GET/v1/memory_stores
Recuperar um armazenamento de memória
GET/v1/memory_stores/{memory_store_id}
Atualizar um armazenamento de memória
POST/v1/memory_stores/{memory_store_id}
Excluir um armazenamento de memória
DELETE/v1/memory_stores/{memory_store_id}
Arquivar um armazenamento de memória
POST/v1/memory_stores/{memory_store_id}/archive

BetaArmazenamentos de memóriaMemórias

Criar uma memória
POST/v1/memory_stores/{memory_store_id}/memories
Listar memórias
GET/v1/memory_stores/{memory_store_id}/memories
Recuperar uma memória
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Atualizar uma memória
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Excluir uma memória
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}

BetaArmazenamentos de memóriaVersões de memória

Listar versões de memória
GET/v1/memory_stores/{memory_store_id}/memory_versions
Recuperar uma versão de memória
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
Suprimir uma versão de memória
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

BetaArquivos

Fazer upload de arquivo
POST/v1/files
Listar arquivos
GET/v1/files
Baixar arquivo
GET/v1/files/{file_id}/content
Obter metadados do arquivo
GET/v1/files/{file_id}
Excluir arquivo
DELETE/v1/files/{file_id}

BetaSkills

Criar skill
POST/v1/skills
Listar skills
GET/v1/skills
Obter skill
GET/v1/skills/{skill_id}
Excluir skill
DELETE/v1/skills/{skill_id}

BetaSkillsVersões

Criar versão de skill
POST/v1/skills/{skill_id}/versions
Listar versões de skill
GET/v1/skills/{skill_id}/versions
Baixar conteúdo de versão de skill
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
GET/v1/skills/{skill_id}/versions/{version}
Excluir versão de skill
DELETE/v1/skills/{skill_id}/versions/{version}

BetaPerfis de usuário

Criar perfil de usuário
POST/v1/user_profiles
Listar perfis de usuário
GET/v1/user_profiles
Obter perfil de usuário
GET/v1/user_profiles/{user_profile_id}
Atualizar perfil de usuário
POST/v1/user_profiles/{user_profile_id}
Criar URL de inscrição
POST/v1/user_profiles/{user_profile_id}/enrollment_url

BetaDreams

Criar um Dream
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
GET/v1/dreams

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

Obter um Dream
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
POST/v1/dreams/{dream_id}/cancel

Interrompe um dream pending ou running.

Arquivar um Dream
POST/v1/dreams/{dream_id}/archive

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

BetaTúneis

Criar túnel
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
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
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
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
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
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
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
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
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
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
GET/v1/organizations/me

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

BetaOrganizaçãoChaves de API

Listar chaves de API
GET/v1/organizations/api_keys
Recuperar chave de API (Admin API)
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
POST/v1/organizations/api_keys/{api_key_id}

BetaOrganizaçãoChaves externas

Criar chave externa
POST/v1/organizations/external_keys

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

Listar chaves externas
GET/v1/organizations/external_keys

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

Obter chave externa
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
POST/v1/organizations/external_keys/{external_key_id}

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

Excluir chave externa
DELETE/v1/organizations/external_keys/{external_key_id}

Exclua uma configuração de chave externa.

Validar chave externa
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
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
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
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
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
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
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
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
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
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
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
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
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
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
POST/v1/organizations/invites

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

Listar convites
GET/v1/organizations/invites

Liste os convites da organização.

Obter convite
GET/v1/organizations/invites/{invite_id}

Recupere um convite por ID.

Excluir convite
DELETE/v1/organizations/invites/{invite_id}

Exclua um convite pendente.

BetaOrganizaçãoContas de serviço

Criar conta de serviço
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
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
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
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
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
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
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
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
GET/v1/organizations/users

Liste os membros da organização.

Obter usuário
GET/v1/organizations/users/{user_id}

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

Atualizar usuário
POST/v1/organizations/users/{user_id}

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

Remover usuário
DELETE/v1/organizations/users/{user_id}

Remova um membro da organização.

BetaOrganizaçãoEspaços de trabalho

Listar workspaces
GET/v1/organizations/workspaces
Criar workspace
POST/v1/organizations/workspaces
Obter workspace
GET/v1/organizations/workspaces/{workspace_id}
Atualizar workspace
POST/v1/organizations/workspaces/{workspace_id}
Arquivar workspace
POST/v1/organizations/workspaces/{workspace_id}/archive

BetaOrganizaçãoEspaços de trabalhoLimites de taxa

Listar limites de taxa do workspace
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

Lista os "rate limits" (limites de taxa) de um workspace.

BetaOrganizaçãoEspaços de trabalhoMembros

Listar membros do workspace
GET/v1/organizations/workspaces/{workspace_id}/members
Criar membro do workspace
POST/v1/organizations/workspaces/{workspace_id}/members
Obter membro do workspace
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Atualizar membro do workspace
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Excluir membro do workspace
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
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
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
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
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
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
GET/v1/organizations/rate_limits

List Messages API rate limits for your organization.

BetaOrganizaçãoConfigurações de conformidade

Obter configurações de conformidade
GET/v1/organizations/compliance_settings

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

Atualizar configurações de conformidade
POST/v1/organizations/compliance_settings

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

BetaOrganizaçãoRelatório de uso

Obter relatório de uso de mensagens
GET/v1/organizations/usage_report/messages
Obter relatório de uso do Claude Code
GET/v1/organizations/usage_report/claude_code

Recupere métricas de uso diárias agregadas para usuários do Claude Code. Permite que as organizações analisem a produtividade dos desenvolvedores e criem dashboards personalizados.

BetaOrganizaçãoRelatório de custos

Obter relatório de custos
GET/v1/organizations/cost_report

BetaOrganizaçãoTúneis MCP

Listar túneis
Deprecated
GET/v1/organizations/tunnels

Descontinuado. Este endpoint da Admin API foi substituído por /v1/tunnels na API Claude e será removido após uma janela de migração. Novas integrações devem usar /v1/tunnels com o cabeçalho anthropic-beta: mcp-tunnels-2026-06-22 e um token WIF com o escopo workspace:manage_tunnels. As integrações existentes continuam funcionando com o cabeçalho mcp-tunnels-2026-05-19 e o escopo org:manage_tunnels durante a janela de migração.

Obter túnel
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}

Descontinuado. Este endpoint da Admin API foi substituído por /v1/tunnels na Claude API e será removido após uma janela de migração. Novas integrações devem usar /v1/tunnels com o cabeçalho anthropic-beta: mcp-tunnels-2026-06-22 e um token WIF com o escopo workspace:manage_tunnels. As integrações existentes continuam funcionando com o cabeçalho mcp-tunnels-2026-05-19 e o escopo org:manage_tunnels durante a janela de migração.

Arquivar túnel
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/archive

Descontinuado. Este endpoint da Admin API foi substituído por /v1/tunnels na Claude API e será removido após uma janela de migração. Novas integrações devem usar /v1/tunnels com o cabeçalho anthropic-beta: mcp-tunnels-2026-06-22 e um token WIF com o escopo workspace:manage_tunnels. As integrações existentes continuam funcionando com o cabeçalho mcp-tunnels-2026-05-19 e o escopo org:manage_tunnels durante a janela de migração.

Revelar token do túnel
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/reveal_token

Descontinuado. Este endpoint da Admin API foi substituído por /v1/tunnels na API Claude e será removido após uma janela de migração. Novas integrações devem usar /v1/tunnels com o cabeçalho anthropic-beta: mcp-tunnels-2026-06-22 e um token WIF com o escopo workspace:manage_tunnels. As integrações existentes continuam funcionando com o cabeçalho mcp-tunnels-2026-05-19 e o escopo org:manage_tunnels durante a janela de migração.

Rotacionar token do túnel
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/rotate_token

Descontinuado. Este endpoint da Admin API foi substituído por /v1/tunnels na API Claude e será removido após uma janela de migração. Novas integrações devem usar /v1/tunnels com o cabeçalho anthropic-beta: mcp-tunnels-2026-06-22 e um token WIF com o escopo workspace:manage_tunnels. As integrações existentes continuam funcionando com o cabeçalho mcp-tunnels-2026-05-19 e o escopo org:manage_tunnels durante a janela de migração.

BetaOrganizaçãoTúneis MCPCertificados de túnel

Criar certificado de túnel
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates

Descontinuado. Este endpoint da Admin API foi substituído por /v1/tunnels na Claude API e será removido após uma janela de migração. Novas integrações devem usar /v1/tunnels com o cabeçalho anthropic-beta: mcp-tunnels-2026-06-22 e um token WIF com o escopo workspace:manage_tunnels. As integrações existentes continuam funcionando com o cabeçalho mcp-tunnels-2026-05-19 e o escopo org:manage_tunnels durante a janela de migração.

Listar certificados de túnel
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates

Descontinuado. Este endpoint da Admin API foi substituído por /v1/tunnels na API Claude e será removido após uma janela de migração. Novas integrações devem usar /v1/tunnels com o cabeçalho anthropic-beta: mcp-tunnels-2026-06-22 e um token WIF com o escopo workspace:manage_tunnels. As integrações existentes continuam funcionando com o cabeçalho mcp-tunnels-2026-05-19 e o escopo org:manage_tunnels durante a janela de migração.

Obter certificado de túnel
Deprecated
GET/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}

Descontinuado. Este endpoint da Admin API foi substituído por /v1/tunnels na Claude API e será removido após uma janela de migração. Novas integrações devem usar /v1/tunnels com o cabeçalho anthropic-beta: mcp-tunnels-2026-06-22 e um token WIF com o escopo workspace:manage_tunnels. As integrações existentes continuam funcionando com o cabeçalho mcp-tunnels-2026-05-19 e o escopo org:manage_tunnels durante a janela de migração.

Arquivar certificado de túnel
Deprecated
POST/v1/organizations/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

Descontinuado. Este endpoint da Admin API foi substituído por /v1/tunnels na Claude API e será removido após uma janela de migração. Novas integrações devem usar /v1/tunnels com o cabeçalho anthropic-beta: mcp-tunnels-2026-06-22 e um token WIF com o escopo workspace:manage_tunnels. As integrações existentes continuam funcionando com o cabeçalho mcp-tunnels-2026-05-19 e o escopo org:manage_tunnels durante a janela de migração.

BetaOrganizaçãoAnálisesSummaries

Obter resumos de atividade
GET/v1/organizations/analytics/summaries

Get organization-wide activity summaries for a date range.

BetaOrganizaçãoAnálisesUsuários

Listar atividade de usuários
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
GET/v1/organizations/analytics/apps/chat/projects

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

BetaOrganizaçãoAnálisesConectores

Obter uso de conectores
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
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
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
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
GET/v1/organizations/analytics/usage_report

Obtenha o uso de tokens ao longo do tempo em um intervalo de datas.

BetaOrganizaçãoAnálisesUser Usage Report

Obter uso de tokens por usuário
GET/v1/organizations/analytics/user_usage_report

Obtenha o uso de tokens por usuário em um intervalo de datas.

BetaOrganizaçãoAnálisesRelatório de custos

Obter custo ao longo do tempo
GET/v1/organizations/analytics/cost_report

Obtenha o custo em USD ao longo do tempo em um intervalo de datas.

BetaOrganizaçãoAnálisesUser Cost Report

Obter custo por usuário
GET/v1/organizations/analytics/user_cost_report

Obtenha o custo por usuário em USD em um intervalo de datas.

BetaOrganizaçãoLimites de gastos

Definir limite de gastos
POST/v1/organizations/spend_limits

Define um limite de gastos.

Obter limite de gastos
GET/v1/organizations/spend_limits/{spend_limit_id}

Recupere um limite de gastos por ID.

Excluir limite de gastos
DELETE/v1/organizations/spend_limits/{spend_limit_id}

Exclui um limite de gastos.

List Spend Limits
GET/v1/organizations/spend_limits

List the organization's spend limits.

BetaOrganizaçãoLimites de gastosEffective

Listar limites de gastos efetivos
GET/v1/organizations/spend_limits/effective

Liste o limite de gastos efetivo de cada membro e o gasto acumulado no período.

BetaOrganizaçãoLimites de gastosSolicitações de aumento

Listar solicitações de aumento de limite de gastos
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
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
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
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
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
GET/v1/organizations/rbac_groups

Lista os grupos RBAC no tenant do Claude Enterprise.

Obter grupo RBAC
GET/v1/organizations/rbac_groups/{rbac_group_id}

Recupera um grupo RBAC por ID.

Atualizar grupo RBAC
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
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
GET/v1/organizations/rbac_groups/{rbac_group_id}/members

Lista os membros de um grupo RBAC.

Adicionar membro ao grupo RBAC
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
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
GET/v1/organizations/rbac_roles

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

Obter função RBAC
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
GET/v1/organizations/rbac_roles/{rbac_role_id}/permissions

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

BetaOrganizaçãoPlugins

Create Plugin
POST/v1/organizations/plugins

Create an organization-owned Plugin and its first version by uploading the version's files.

Get Plugin
GET/v1/organizations/plugins/{plugin_id}

Retrieve a Plugin by ID.

Update Plugin
POST/v1/organizations/plugins/{plugin_id}

Change which stored version of an organization-owned Plugin is served to members, for example to roll back to an earlier one. This pins the served version: later uploads are stored but no longer change what is served, and pinning cannot currently be undone, here or in claude.ai.

List Plugins
GET/v1/organizations/plugins

List the Plugins created under the organization, newest first: those in the organization's own plugin marketplaces and those in members' personal plugin marketplaces.

Delete Plugin
DELETE/v1/organizations/plugins/{plugin_id}

Permanently delete a Plugin and every version it holds, exactly as when an administrator deletes it in claude.ai. The Plugin may belong to the organization or to a member, including a member who has since left the organization.

BetaOrganizaçãoPluginsVersões

Create Plugin Version
POST/v1/organizations/plugins/{plugin_id}/versions

Add a version to an organization-owned Plugin by uploading the new version's files; it becomes the version served to members unless the Plugin's served version has been pinned.

List Plugin Versions
GET/v1/organizations/plugins/{plugin_id}/versions

List a Plugin's versions, newest first.

Get Plugin Version
GET/v1/organizations/plugins/{plugin_id}/versions/{version}

Retrieve one version of a Plugin by its ID, or the Plugin's newest version.

Download Plugin Version Archive
GET/v1/organizations/plugins/{plugin_id}/versions/{version}/content

Download one version's .zip archive, exactly as stored. Each download of a Plugin from a member's personal plugin marketplace is recorded on the Compliance API activity feed.

BetaOrganizaçãoPluginsInstallation Settings

List Plugin Installation Settings
GET/v1/organizations/plugins/{plugin_id}/installation_settings

List an organization-owned Plugin's installation settings, which say which members it is for, most recently created first.

Set Plugin Installation Setting
POST/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

Set or change an organization-owned Plugin's installation setting for the whole organization or for one RBAC Group.

Remove Plugin Installation Setting
DELETE/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

Remove an organization-owned Plugin's own installation setting for the whole organization or for one RBAC Group.

BetaOrganizaçãoPluginsShares

List Plugin Shares
GET/v1/organizations/plugins/{plugin_id}/shares

List the shares the owner of a member-owned Plugin has given — to every member of the organization, to an RBAC Group, or to one member — most recently granted first.

BetaOrganizaçãoPlugin Marketplaces

List Plugin Marketplaces
GET/v1/organizations/plugin_marketplaces

List the plugin marketplaces Plugins live in, newest first: the organization's own and its members' personal ones.

Get Plugin Marketplace
GET/v1/organizations/plugin_marketplaces/{marketplace_id}

Retrieve a plugin marketplace by ID.

Update Plugin Marketplace
POST/v1/organizations/plugin_marketplaces/{marketplace_id}

Set the default installation setting of one of the organization's own plugin marketplaces. Every Plugin in it without a setting of its own gets this default as its organization-wide setting, including Plugins added later.

Validate Plugin Marketplace Repository
POST/v1/organizations/plugin_marketplaces/validate_repository

Check whether a plugin marketplace held in a public GitHub repository would synchronize into claude.ai, without connecting or storing it.

Validate Plugin Marketplace Archive
POST/v1/organizations/plugin_marketplaces/validate_archive

Check whether a plugin marketplace, uploaded as a .zip of the marketplace directory, would synchronize into claude.ai, without connecting or storing it.