Documentação

Chaves de API

Gere e gerencie chaves de API para acesso programático.

As chaves de API permitem acesso programático aos seus agentes. Use-as para integrar o Agentkit aos seus aplicativos ou conectar serviços de terceiros.

Observação: as chaves de API exigem um plano Hobby ou superior com faturamento ativo. Workspaces gratuitos, com pagamento em atraso ou não pagos não têm acesso à API. Faça upgrade do seu plano →

Criando uma chave de API

  1. Vá até o seu workspace
  2. Clique em Chaves de API na barra lateral
  3. Clique em Criar chave de API
  4. Confirme na caixa de diálogo

A nova chave aparece na lista e pode ser revelada ou copiada a qualquer momento.

Visualizando e copiando chaves

Cada chave na lista é mascarada por padrão. Use o ícone de olho para revelar uma chave e o ícone de copiar para copiá-la para a área de transferência.

Usando chaves de API

Inclua a chave nas requisições de API:

curl -X POST 'https://your-domain.com/api/v1/chat' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"chatbotId": "uuid", "messages": [{"role": "user", "content": "Hello"}]}'

Documentação completa da API →

Gerenciando chaves

Ver todas as chaves

Todas as chaves do workspace são listadas na página Chaves de API.

Excluir uma chave

  1. Encontre a chave na lista
  2. Clique no ícone de lixeira
  3. Confirme a exclusão

As chaves excluídas param de funcionar imediatamente.

Boas práticas de segurança

Nunca exponha as chaves

  • Não faça commit de chaves em repositórios git
  • Não inclua chaves em código do lado do cliente
  • Use variáveis de ambiente

Rotacione as chaves periodicamente

  • Crie novas chaves periodicamente
  • Atualize seus aplicativos
  • Exclua chaves antigas

Use chaves separadas

Crie chaves diferentes para:

  • Produção vs. desenvolvimento
  • Aplicativos diferentes
  • Membros de equipe ou serviços diferentes

Escopo da chave

As chaves de API são restritas ao workspace em que foram criadas e têm acesso a:

  • Todos os agentes do workspace
  • Endpoints da API de chat
  • Gerenciamento de webhooks

As chaves não podem:

  • Gerenciar membros da equipe
  • Acessar o faturamento
  • Criar outras chaves de API

Conexão com o Zapier

Ao conectar ao Zapier:

  1. Crie uma chave de API dedicada para o Zapier
  2. Use essa chave na conexão do Zapier
  3. Mantenha a chave separada de outros usos

Configurar o Zapier →

Solução de problemas

Erro "Invalid API key"

  • Verifique se a chave foi copiada corretamente
  • Verifique se há espaços antes/depois da chave
  • Confirme que a chave não foi excluída

Erro "Key not authorized"

  • Garanta que o agente pertence ao seu workspace
  • Verifique se o workspace da chave corresponde
  • Confirme que seu workspace está no plano Hobby ou superior com faturamento ativo

A chave não funciona após a criação

  • Tente atualizar a página
  • Aguarde 30 segundos para a propagação
  • Crie uma nova chave se os problemas persistirem

Próximos passos