Conta e acesso
Chaves de API
Como criar, usar, trocar e revogar chaves de API, e a lista dos escopos que definem o que cada chave pode fazer.
#Criar uma chave
Na área do cliente, em Acesso → Chaves de API. Quem cria é o dono ou um administrador. Toda chave pertence a um workspace, escolhido na criação.
- O token tem o formato
aiuby_seguido de um identificador e de um segredo, e aparece uma única vez. - Cada workspace pode ter até 20 chaves ativas.
#Usar a chave
Envie o token no cabeçalho de autorização. O Gateway também aceita o cabeçalho x-api-key.
Authorization: Bearer aiuby_...#Escopos
Um escopo só pode ser escolhido se o produto correspondente estiver adicionado à organização.
| Nome na tela | Identificador | Produto exigido |
|---|---|---|
| Buscar no Knowledge | knowledge:read | Knowledge |
| Enviar documentos ao Knowledge | knowledge:write | Knowledge |
| Executar agentes | agents:run | Agents |
| Executar prompts | prompts:run | Agents |
| Executar fluxos | flows:run | Agents |
| Exportar auditoria | audit:read | Guard |
| Chamar modelos pelo Gateway | gateway:invoke | Models |
| Guard no navegador (extensão) | guard:decide | Guard |
| Guard no perímetro (proxy) | guard:perimeter | Guard |
| Ler o Compute (CLI) | compute:read | Compute |
| Gerenciar aplicações do Compute (CLI) | compute:write | Compute |
| Implantar no Compute (CLI) | compute:deploy | Compute |
| Chamar aplicações do Compute | compute:invoke | Compute |
| Ler a engenharia (API v1) | engineering:read | Cortex |
| SDK de feature flags (servidor) | flags:evaluate | Cortex |
| Baixar skills publicadas | skills:read | Cortex |
| Check de resiliência no CI | resilience:check | Cortex |
| Check de IaC no CI | iac:check | Cortex |
| Check de migrações no CI | db:check | Cortex |
| Relatar migrações de banco no CI | db:report | Cortex |
| Ler o histórico de bancos e migrações | db:read | Cortex |
| Rodar suítes Playwright no CI | tests:run | Cortex |
| Rodar plan e apply gerenciados de IaC | iac:run | Cortex |
| Aprovar estágios de release (CLI) | delivery:approve | Cortex |
| Voltar releases (CLI) | delivery:rollback | Cortex |
| Ler o portão de segurança no CI | security:read | Cortex |
| Enviar SARIF e SBOM do CI | security:write | Cortex |
| Pedir scan de segurança (agente de código) | security:scan | Cortex |
| Enviar itens de trabalho (tickets) | engineering:ingest | Cortex |
| Enviar tráfego de APIs (log do gateway) | api-security:ingest | Cortex |
| Teste de carga (pipeline e Terraform) | load-test:run | Cortex |
| Enviar uso de Kubernetes e métricas de negócio | costs:ingest | Guard |
| Avaliações de agentes (SDK e MCP) | agents:eval | Agents |
| Traces de agentes externos (OpenTelemetry) | agents:trace | Agents |
| Pipelines: criar e editar (entrega ponta a ponta) | pipelines:write | Cortex |
| Pipelines: disparar, cancelar e repetir | pipelines:run | Cortex |
| Code Automation: tickets, plano, patch e PR | code:write | Cortex |
O que cada escopo permite e o que ele não faz aparece na tela, ao escolher o escopo. As rotas de cada escopo de engenharia estão na referência da API v1.
Nota
"Exportar auditoria" só pode ser concedido por quem administra a organização inteira.
#Validade, troca e revogação
- Validade: 90 dias por padrão, até 365.
- Troca: ao trocar o token, o anterior pode continuar valendo por até 24 horas, para você atualizar os sistemas sem interrupção.
- Revogação: imediata, pela mesma tela.
#Boas práticas
- Uma chave por sistema, com o menor conjunto de escopos que resolve.
- Guarde o token num cofre de segredos; nunca no código nem no histórico do terminal.
- Tudo o que a chave faz fica na auditoria com o nome dela: dê nomes que identifiquem o sistema.