Visão geral da API Admin
The Admin API is unavailable for individual accounts. To collaborate with teammates and add members, set up your organization in Console → Settings → Organization.
A API Admin permite que você gerencie programaticamente os recursos da sua organização, incluindo membros da organização, espaços de trabalho e chaves de API. Isso fornece controle programático sobre tarefas administrativas que, de outra forma, exigiriam configuração manual no Console Claude.
A API Admin requer acesso especial
A API Admin requer uma chave de API Admin especial (começando com sk-ant-admin...) que difere das chaves de API padrão. Apenas membros da organização com função de administrador podem provisionar chaves de API Admin através do Console Claude.
Como funciona a API Admin
Quando você usa a API Admin:
- Você faz solicitações usando sua chave de API Admin no cabeçalho
x-api-key - A API permite que você gerencie:
- Membros da organização e suas funções
- Convites de membros da organização
- Espaços de trabalho e seus membros
- Chaves de API
Isso é útil para:
- Automatizar integração/desligamento de usuários
- Gerenciar programaticamente o acesso ao espaço de trabalho
- Monitorar e gerenciar o uso de chaves de API
Funções e permissões da organização
Existem cinco funções no nível da organização. Veja mais detalhes aqui.
| Função | Permissões |
|---|---|
| user | Pode usar o Workbench |
| claude_code_user | Pode usar o Workbench e Claude Code |
| developer | Pode usar o Workbench e gerenciar chaves de API |
| billing | Pode usar o Workbench e gerenciar detalhes de cobrança |
| admin | Pode fazer tudo o que foi mencionado acima, além de gerenciar usuários |
Conceitos principais
Membros da Organização
Você pode listar membros da organização, atualizar funções de membros e remover membros.
# Listar membros da organização
curl "https://api.anthropic.com/v1/organizations/users?limit=10" \
--header "anthropic-version: 2023-06-01" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY"
# Atualizar função do membro
curl "https://api.anthropic.com/v1/organizations/users/{user_id}" \
--header "anthropic-version: 2023-06-01" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
--data '{"role": "developer"}'
# Remover membro
curl --request DELETE "https://api.anthropic.com/v1/organizations/users/{user_id}" \
--header "anthropic-version: 2023-06-01" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY"Convites da Organização
Você pode convidar usuários para organizações e gerenciar esses convites.
# Criar convite
curl --request POST "https://api.anthropic.com/v1/organizations/invites" \
--header "anthropic-version: 2023-06-01" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
--data '{
"email": "[email protected]",
"role": "developer"
}'
# Listar convites
curl "https://api.anthropic.com/v1/organizations/invites?limit=10" \
--header "anthropic-version: 2023-06-01" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY"
# Excluir convite
curl --request DELETE "https://api.anthropic.com/v1/organizations/invites/{invite_id}" \
--header "anthropic-version: 2023-06-01" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY"Espaços de Trabalho
Crie e gerencie espaços de trabalho (console) para organizar seus recursos:
# Criar espaço de trabalho
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces" \
--header "anthropic-version: 2023-06-01" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
--data '{"name": "Production"}'
# Listar espaços de trabalho
curl "https://api.anthropic.com/v1/organizations/workspaces?limit=10&include_archived=false" \
--header "anthropic-version: 2023-06-01" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY"
# Arquivar espaço de trabalho
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/archive" \
--header "anthropic-version: 2023-06-01" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY"Membros do Espaço de Trabalho
Gerencie acesso de usuários a espaços de trabalho específicos:
# Adicionar membro ao espaço de trabalho
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members" \
--header "anthropic-version: 2023-06-01" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
--data '{
"user_id": "user_xxx",
"workspace_role": "workspace_developer"
}'
# Listar membros do espaço de trabalho
curl "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members?limit=10" \
--header "anthropic-version: 2023-06-01" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY"
# Atualizar função do membro
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members/{user_id}" \
--header "anthropic-version: 2023-06-01" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
--data '{
"workspace_role": "workspace_admin"
}'
# Remover membro do espaço de trabalho
curl --request DELETE "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members/{user_id}" \
--header "anthropic-version: 2023-06-01" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY"Chaves de API
Monitore e gerencie chaves de API:
# Listar chaves de API
curl "https://api.anthropic.com/v1/organizations/api_keys?limit=10&status=active&workspace_id=wrkspc_xxx" \
--header "anthropic-version: 2023-06-01" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY"
# Atualizar chave de API
curl --request POST "https://api.anthropic.com/v1/organizations/api_keys/{api_key_id}" \
--header "anthropic-version: 2023-06-01" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
--data '{
"status": "inactive",
"name": "New Key Name"
}'Acessando informações da organização
Obtenha informações sobre sua organização programaticamente com o endpoint /v1/organizations/me.
Por exemplo:
curl "https://api.anthropic.com/v1/organizations/me" \
--header "anthropic-version: 2023-06-01" \
--header "x-api-key: $ADMIN_API_KEY"{
"id": "12345678-1234-5678-1234-567812345678",
"type": "organization",
"name": "Organization Name"
}Este endpoint é útil para determinar programaticamente a qual organização uma chave de API Admin pertence.
Para detalhes completos de parâmetros e esquemas de resposta, consulte a referência da API de Informações da Organização.
Acessando relatórios de uso e custo
Para acessar relatórios de uso e custo da sua organização, use os endpoints da API de Uso e Custo:
- O endpoint de Uso (
/v1/organizations/usage_report/messages) fornece dados detalhados de uso, incluindo contagens de tokens e métricas de solicitação, agrupados por várias dimensões como espaço de trabalho, usuário e modelo. - O endpoint de Custo (
/v1/organizations/cost_report) fornece dados de custo associados ao uso da sua organização, permitindo que você rastreie despesas e aloque custos por espaço de trabalho ou descrição.
Esses endpoints fornecem insights detalhados sobre o uso da sua organização e custos associados.
Acessando análises do Claude Code
Para organizações que usam Claude Code, a API de Análises do Claude Code fornece métricas detalhadas de produtividade e insights de uso:
- O endpoint de Análises do Claude Code (
/v1/organizations/usage_report/claude_code) fornece métricas agregadas diárias para uso do Claude Code, incluindo sessões, linhas de código, commits, pull requests, estatísticas de uso de ferramentas e dados de custo divididos por usuário e modelo.
Esta API permite que você rastreie a produtividade do desenvolvedor, analise a adoção do Claude Code e construa dashboards personalizados para sua organização.
Melhores práticas
Para usar efetivamente a API Admin:
- Use nomes e descrições significativos para espaços de trabalho e chaves de API
- Implemente tratamento adequado de erros para operações falhadas
- Audite regularmente funções e permissões de membros
- Limpe espaços de trabalho não utilizados e convites expirados
- Monitore o uso de chaves de API e faça rotação das chaves periodicamente