Pular para o conteúdo principal

Ferramentas externas (APIs personalizadas)

Conecte APIs próprias — CRM, catálogo de produtos, estoque, base de imóveis ou qualquer sistema com API HTTP — para que seus agentes de IA consultem dados em tempo real durante conversas.


O que é

As ferramentas externas permitem que um agente Treffen AI chame a sua API como se fosse uma ferramenta interna. Durante uma conversa, a IA decide quando consultar sua API, envia os parâmetros corretos e usa a resposta para responder ao cliente.

Exemplo (imobiliária): o cliente pergunta "Vocês têm apartamento de 2 quartos em São Paulo até R$ 800 mil?". O agente chama a ferramenta search_properties na API do CRM e responde com os imóveis disponíveis.


Quando usar

CenárioExemplo de ferramenta
Catálogo ou estoquesearch_products, get_product
CRM ou base de clientesget_customer, update_lead
Imóveis ou veículossearch_properties, get_property
Disponibilidade externacheck_stock, get_price
Quando não usar

Se o dado já está no Treffen (contatos, tickets, calendário de reservas), use as ferramentas nativas da plataforma. APIs personalizadas são para sistemas externos que você já opera.


Como configurar

1. Criar a integração

No painel administrativo, acesse a área de Integrações (ou APIs personalizadas, conforme o menu do seu tenant) e crie uma nova integração:

CampoDescrição
NomeIdentificação interna (ex.: "CRM Imobiliária")
URL baseEndereço HTTPS da sua API (ex.: https://api.seucrm.com/v1)
AutenticaçãoBearer token, API key no header ou Basic
Hosts permitidosDomínios que a plataforma pode chamar (segurança)

Use Testar integração para validar credenciais e conectividade antes de ativar.

2. Definir ferramentas

Para cada operação que a IA pode executar, crie uma ferramenta:

CampoDescrição
Nome da ferramentaIdentificador em minúsculas com underscore (ex.: search_properties)
DescriçãoO que a ferramenta faz — a IA usa isso para decidir quando chamá-la
Método HTTPGET, POST, etc.
CaminhoPath com parâmetros entre chaves (ex.: /properties?city={city}&max_price={max_price})
ParâmetrosSchema JSON dos parâmetros aceitos (cidade, quartos, preço máximo, etc.)

Exemplo de ferramenta de busca de imóveis:

  • Nome: search_properties
  • Descrição: Buscar imóveis disponíveis por cidade, quartos e preço máximo em BRL
  • Método: GET
  • Caminho: /properties?city={city}&bedrooms={bedrooms}&max_price={max_price}
  • Parâmetros obrigatórios: city

3. Ativar a integração

Após criar pelo menos uma ferramenta habilitada, ative a integração. Integrações inativas não são usadas pelos agentes.

4. Habilitar no agente

Em Treffen AIAgentes, edite o agente desejado e inclua as ferramentas externas no conjunto de ferramentas habilitadas (enabled toolsets). Somente ferramentas habilitadas no agente podem ser chamadas durante conversas.

Veja também Como criar um agente.


Segurança e limites

A plataforma aplica proteções automáticas ao chamar APIs externas:

ProteçãoO que significa para você
HTTPS obrigatórioApenas URLs seguras (exceto em ambientes de desenvolvimento)
Bloqueio de endereços internosIPs privados e redes internas não são acessíveis (proteção SSRF)
Hosts permitidosSó domínios que você autorizou podem ser chamados
Limite de respostaRespostas muito grandes são truncadas antes de chegar à IA
Isolamento por tenantCada conta só acessa suas próprias integrações
TimeoutChamadas que demoram demais são encerradas (máx. ~30 segundos)

Credenciais (tokens, senhas) são armazenadas de forma criptografada e nunca aparecem em logs ou respostas da IA.


Solução de problemas

ProblemaPossível causaO que fazer
Ferramenta não encontradaNome incorreto ou integração inativaVerifique o nome exato e se a integração está ativa
TimeoutAPI lenta ou indisponívelTeste a API diretamente; otimize tempo de resposta
Host não permitidoDomínio fora da lista de hostsAdicione o domínio em Hosts permitidos
Erro 4xx/5xxCredenciais ou path incorretosUse Testar integração e revise path e parâmetros
IA não chama a ferramentaFerramenta não habilitada no agenteInclua a ferramenta no agente em enabled toolsets
Resposta incompletaMuitos registros na respostaReduza o volume retornado pela sua API ou use filtros mais específicos

Perguntas frequentes

Preciso de desenvolvedor para configurar? Sim, é necessário que sua API esteja documentada e acessível via HTTPS. A configuração no Treffen pode ser feita por um administrador com os dados da API.

A IA vê minhas credenciais? Não. A plataforma injeta a autenticação automaticamente; a IA recebe apenas o resultado da consulta.

Quantas ferramentas posso criar? Não há limite fixo documentado; organize por integração (ex.: uma integração "CRM" com várias ferramentas).

Funciona com qualquer API REST? Sim, desde que use HTTPS, retorne JSON e os endpoints estejam acessíveis publicamente (com autenticação).