Aumo Docs

Chaves de API

Autenticar aplicações e integrações que chamam a plataforma neste workspace.

Chaves de API, chamadas de chaves de projeto na plataforma, autenticam aplicações e integrações que chamam a AUMO sem uma pessoa na frente.

A tela é exclusiva do Proprietário do workspace. Nenhum outro papel a alcança, nem em leitura.

Por que só o Proprietário

Emitir uma chave é conceder acesso programático ao workspace, sem login e sem a barreira de uma sessão.

A restrição é deliberada e não acompanha os demais papéis de construção: Curador e Editor criam Agentes e Coleções, mas não emitem credenciais.

Criar uma chave

Clique em + Chave de projeto e preencha a janela Nova chave de projeto:

  • Nome: o que aparece na listagem e nos relatórios de consumo. Descreva o sistema que vai usar a chave.
  • Expiração: 30 dias por padrão, com opções de 7, 60 e 90 dias, data personalizada ou sem expiração.
  • Escopos: para cada recurso, Nenhum, Leitura ou Leitura e escrita, entre outros níveis. Você só concede escopos que você mesmo tem no workspace. Para conversar com um agente, a própria janela indica o mínimo: Conversas em leitura e escrita, Agente e Modelos em leitura.

Clique em Gerar chave. A chave aparece em um cartão no topo da lista, com a opção de copiar.

Entre no workspace
Entre no workspace

Na barra estreita à esquerda, clique em Workspace.

1 / 8

O valor da chave é exibido uma única vez, no momento da criação. Guarde-o antes de fechar a tela; não há como recuperá-lo depois, apenas revogar e emitir outra.

A lista

A busca filtra por nome, prefixo ou escopo. O prefixo é a parte visível da chave, suficiente para identificar qual credencial está em uso sem expor o valor.

O botão Mostrar revogadas traz também as chaves já invalidadas, que somem da lista por padrão.

Revogar

Revogar invalida a chave imediatamente. Tudo que a usava para de autenticar, e a falha aparece no sistema chamador, não aqui.

Uma chave revogada permanece no registro, para que o consumo passado continue atribuível.

Consumo e quotas

Chaves de projeto consomem do workspace como qualquer outra chamada, e têm aba própria em Quotas.

Vale usá-la: uma integração em laço consome sem pausa e sem ninguém olhando, o que é exatamente o caso que um teto por chave evita.

Próximos passos

Nesta página