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
Descrição: explique claramente para a IA quando e por que essa API deve ser usada
💡 Dica importante:
A descrição 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.”
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
{{ }}Exemplo:
https://api.exemplo.com/clima?cidade={{cidade}}
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.
Boas práticas
Use descrições claras
A descrição da API orienta o raciocínio da IA. Seja explícito sobre:
O que a API retorna
Em quais situações ela deve ser usada
Planeje tratamento de erros
Sempre que possível, retorne mensagens de erro claras no JSON ou instrua o agente sobre como lidar com falhas.
Precisa de ajuda?
Se tiver dúvidas técnicas ou problemas na configuração, entre em contato com o suporte.