Chamar API
Permite que o agente faça requisições HTTP a APIs externas com método, headers e corpo definidos na configuração. O agente decide o corpo da requisição com base no contexto da conversa.
Configuração
| Campo | Obrigatório | Descrição |
|---|---|---|
| Endpoint da API | Sim | URL completa do endpoint a ser chamado (ex: https://api.exemplo.com/v1/clientes) |
| Método HTTP | Sim | Método da requisição: GET, POST, PUT, DELETE ou PATCH |
| Headers (JSON) | Não | Cabeçalhos da requisição como objeto JSON (ex: { "Authorization": "Bearer token123", "Content-Type": "application/json" }) |
Como funciona
Ao receber uma tarefa relacionada a essa API, o agente:
- Usa o endpoint e o método configurados.
- Aplica os headers definidos na configuração.
- Decide o corpo da requisição com base no contexto da conversa.
- Retorna o status HTTP e os dados recebidos na resposta.
Parâmetros de entrada (em tempo de execução)
| Parâmetro | Descrição |
|---|---|
| Corpo | Corpo da requisição (para métodos POST, PUT, PATCH). O agente preenche este campo com base no contexto |
Resposta
| Campo | Descrição |
|---|---|
| Status | Código HTTP da resposta (ex: 200, 201, 404) |
| Dados | Conteúdo retornado pela API |
tip
Use a descrição da ação para instruir o agente sobre o que essa API faz e quando utilizá-la. Quanto mais precisa a descrição, melhor o agente decide quando e como chamar o endpoint.