This page is not yet available in English. Read it in Portuguese

Skip to content
Menu da documentação

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.

http
Authorization: Bearer aiuby_...

#Escopos

Um escopo só pode ser escolhido se o produto correspondente estiver adicionado à organização.

Nome na telaIdentificadorProduto exigido
Buscar no Knowledgeknowledge:readKnowledge
Enviar documentos ao Knowledgeknowledge:writeKnowledge
Executar agentesagents:runAgents
Executar promptsprompts:runAgents
Executar fluxosflows:runAgents
Exportar auditoriaaudit:readGuard
Chamar modelos pelo Gatewaygateway:invokeModels
Guard no navegador (extensão)guard:decideGuard
Guard no perímetro (proxy)guard:perimeterGuard
Ler o Compute (CLI)compute:readCompute
Gerenciar aplicações do Compute (CLI)compute:writeCompute
Implantar no Compute (CLI)compute:deployCompute
Chamar aplicações do Computecompute:invokeCompute
Ler a engenharia (API v1)engineering:readCortex
SDK de feature flags (servidor)flags:evaluateCortex
Baixar skills publicadasskills:readCortex
Check de resiliência no CIresilience:checkCortex
Check de IaC no CIiac:checkCortex
Check de migrações no CIdb:checkCortex
Relatar migrações de banco no CIdb:reportCortex
Ler o histórico de bancos e migraçõesdb:readCortex
Rodar suítes Playwright no CItests:runCortex
Rodar plan e apply gerenciados de IaCiac:runCortex
Aprovar estágios de release (CLI)delivery:approveCortex
Voltar releases (CLI)delivery:rollbackCortex
Ler o portão de segurança no CIsecurity:readCortex
Enviar SARIF e SBOM do CIsecurity:writeCortex
Pedir scan de segurança (agente de código)security:scanCortex
Enviar itens de trabalho (tickets)engineering:ingestCortex
Enviar tráfego de APIs (log do gateway)api-security:ingestCortex
Teste de carga (pipeline e Terraform)load-test:runCortex
Enviar uso de Kubernetes e métricas de negóciocosts:ingestGuard
Avaliações de agentes (SDK e MCP)agents:evalAgents
Traces de agentes externos (OpenTelemetry)agents:traceAgents
Pipelines: criar e editar (entrega ponta a ponta)pipelines:writeCortex
Pipelines: disparar, cancelar e repetirpipelines:runCortex
Code Automation: tickets, plano, patch e PRcode:writeCortex

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.