DoubleX AgentesDocs

Guias › Integração

Chaves de API

Gere, use, troque e revogue as chaves que dão acesso à API e à CLI.

Toda chamada à API, exceto os webhooks de gatilho, precisa de uma chave. As chaves começam com dbx_ e agem como a pessoa dona delas: veem e alteram só o que essa pessoa vê e altera na tela.

Tipos de chave#

TipoOnde nasceQuantasUse para
Chave pessoalConfigurações › Perfil › Acesso pela APIUma por pessoa. Gerar de novo troca a anterior.Scripts, sistemas e integrações que você mantém.
Chave de terminalCriada pelo doublex login, uma por computadorUma por loginA CLI daquele computador. Ela fica no chaveiro do sistema e você nunca precisa vê-la.

As duas funcionam da mesma forma na API. A diferença é como nascem e como são revogadas.

Gerar a chave pessoal#

  1. Entre no app e abra Configurações › Perfil.
  2. Na seção Acesso pela API, clique em Gerar chave de API.
  3. Copie a chave na hora. Por segurança, ela aparece uma única vez.

A tela mostra depois só o final da chave (dbx_••••••••••••a1b2), a data de criação e o último uso.

Usar a chave#

Envie a chave no cabeçalho Authorization com o esquema Bearer:

curl https://doublex.ai/api/me \
  -H "Authorization: Bearer $DOUBLEX_API_KEY"

Sem a chave, ou com uma chave inválida ou revogada, a API responde 401.

Trocar e revogar#

AçãoComoEfeito
Trocar a chave pessoalPerfil › Acesso pela API › ⋯ › Gerar nova chaveA chave antiga para de funcionar na hora. Atualize tudo que a usa.
Revogar a chave pessoalPerfil › Acesso pela API › ⋯ › Revogar chaveTudo que usa a chave para de funcionar.
Desconectar um terminalPerfil › Terminal (CLI) › Terminais conectados › DesconectarA CLI daquele computador precisa de um novo doublex login.
Sair pelo terminaldoublex logoutRevoga a chave daquele terminal no servidor e a apaga do chaveiro. Se você entrou com a chave pessoal (--api-key), ela só sai do chaveiro e continua valendo.

Quando uma pessoa sai da organização, as chaves dela deixam de funcionar.

Trocar ou redefinir a senha revoga todas as suas chaves (a pessoal e as dos terminais): gere a pessoal de novo e rode doublex login nos terminais. A chave de um terminal parado por 90 dias também deixa de valer.

O que a chave pode fazer#

A chave tem as mesmas permissões da pessoa:

  • vê os agentes, skills, documentos do Brain e conectores do escopo dela (Pessoal, dos times dela e da Organização);
  • edita só o que a pessoa pode editar na tela;
  • usa os créditos da organização, como o uso pelo app.

Algumas ações só funcionam no navegador, mesmo com uma chave válida:

  • gerar, trocar ou revogar a chave pessoal;
  • autorizar o login de um terminal;
  • adicionar créditos à organização.

Boas práticas#

  • Guarde a chave como uma senha: num cofre de segredos ou numa variável de ambiente, nunca no código nem no Git.
  • Use a chave de terminal (doublex login) no seu computador e a chave pessoal só em servidores e automações.
  • Se uma chave vazar, revogue-a no Perfil. Nada que ela fez antes é desfeito, mas ela para de funcionar na hora.
  • O prefixo dbx_ existe para os scanners de segredos (como o do GitHub) reconhecerem uma chave publicada por engano.

Próximos passos#