Além de arquivos, links e FAQs, o Whizz Studio permite conectar APIs externas à base de conhecimento.
Isso dá mais poder ao agente, permitindo que ele consulte dados dinâmicos em tempo real durante a conversa.
Quando usar uma API
Use uma API quando o agente precisar:
Consultar dados em tempo real (ex: status de pedido)
Validar informações em sistemas externos
Buscar dados variáveis (clima, cotação, saldo, etc.)
Passo a passo para configurar uma API
Passo 1: Iniciar a configuração
Acesse Whizz Studio > Base de conhecimento
Clique na aba API
Clique em Configurar API ou Adicionar
Passo 2: Preencher dados básicos
Informe os dados iniciais da API:
Nome: identificador interno da integração
Passo 3: Configurar a requisição
Defina os detalhes técnicos da chamada:
Método HTTP: geralmente
GETouPOSTURL (Endpoint): endereço da API
Use variáveis dinâmicas com
{{ }}
Passo 4: Autenticação e headers
Se a API exigir autenticação:
Configure o tipo de autenticação (Bearer Token, API Key, etc.)
Adicione headers personalizados, como:
Content-Type: application/json
🔒 Boa prática: nunca inclua credenciais diretamente na URL.
Passo 5: Mapear parâmetros
Defina quais informações o agente deve extrair da conversa para enviar à API.
Exemplo:
Variável:
cidadeInstrução: extrair o nome da cidade mencionada pelo usuário
Isso ajuda a IA a preencher corretamente a requisição.
Passo 6: Configurar hooks (opcional)
Hooks permitem transformar a requisição antes de enviá-la e a resposta antes de entregá-la ao agente, usando JavaScript.
Pré-hook: modifica os dados da requisição antes do envio (ex: adicionar headers dinâmicos, ajustar o corpo da requisição)
Pós-hook: filtra ou formata a resposta antes de o agente usá-la (ex: extrair apenas os campos relevantes)
Template padrão:
function transform(request) { return request; }Atenção: hooks rodam em ambiente isolado. Não suportam requisições HTTP externas, async/await ou acesso a bibliotecas do Node.js.
Testar a API antes de salvar
Antes de salvar, é possível simular a execução da API diretamente na interface.
Clique em Testar API no formulário de configuração
Preencha os valores de teste para os parâmetros que o agente normalmente extrairia da conversa
Execute a simulação e veja o resultado de cada etapa:
Pré-hook — transformação antes do envio (se configurado)
Build Request — montagem da requisição com os valores informados
Requisição HTTP — chamada ao endpoint externo
Pós-hook — transformação da resposta (se configurado)
Use o testador para validar a configuração antes de ativar o agente em conversas reais.
Passo 7: Cria uma habilidade customizada e conecte a API
Acesse Whizz Studio > Agentes
Clique no agente que utilizará API configurada
Clique na aba Habilidades > Habilidades personalizadas - Editar
Clique em Criar nova habilidade
Na sidebar da nova habilidade, inclua:
Nome: identificador interno da habilidade
Quando deve ser acionada: Descrição de uso da API, explique claramente para a IA quando e por que essa API deve ser usada
Conexão com API: Selecione a API configurada nos passos anteriores
O que fazer após responder: Seleciona qual ação do agente deverá fazer após utitlizar a API
Seguir fluxo padrão da conversa (Recomendado para que dê sequência a conversa)
Transferir para um time
Finalizar conversa
💡 Dica importante:
A descrição de quando a API deve ser acionada funciona como um prompt. Quanto mais clara, melhor será o uso da API pelo agente.
Exemplo de descrição:
“Use esta API quando o usuário perguntar sobre a previsão do tempo em uma cidade específica.”
Boas práticas
Use descrições claras
A descrição de uso API orienta o raciocínio da IA. Seja explícito sobre:
O que a API retorna
Em quais situações ela deve ser usada
Precisa de ajuda?
Se tiver dúvidas técnicas ou problemas na configuração, entre em contato com o suporte.