APIs v2 dos Agents
A API v2 dos Agents da Tech4AI permite que você integre agentes inteligentes em suas aplicações, possibilitando conversas naturais e interações complexas com seus usuários.
O que você pode fazer com a API?
A API v2 oferece funcionalidades completas para gerenciar interações com agentes:
- Gerenciar Conversas: Abrir e encerrar sessões de interação com agentes
- Enviar Mensagens: Enviar mensagens de texto, áudio, imagens, documentos e vídeos e receber respostas do agente via webhook em tempo real
- Gerenciar Arquivos: Fazer upload e download de arquivos para uso nas conversas
Autenticação
Todas as requisições para a API v2 requerem autenticação via chave de API no header:
x-client-key: YOUR_API_KEY
Obtendo sua chave de API
Consulte a seção Chaves de API para aprender como gerar e gerenciar suas chaves.
Base URL
Todas as requisições devem ser feitas para:
https://api.tech4.ai/agent/v2
Fluxo Básico de Uso
- Abrir Conversa: Use o endpoint Open Conversation para iniciar uma sessão e configurar o webhook de retorno das respostas do agente
- Enviar Mensagens: Use o endpoint Add Message para enviar mensagens do usuário
- Upload e Download de Arquivos: Use o endpoint Upload File para fazer upload de arquivos para uso nas conversas e o endpoint Download File para baixar arquivos enviados pelo agente
- Encerrar Conversa: Use o endpoint Close Conversation quando finalizar
Endpoints Disponíveis
| Endpoint | Método | Descrição |
|---|---|---|
/conversation/open | POST | Abre uma nova sessão com o agente |
/conversation/{session_id}/close | POST | Encerra uma sessão existente |
/conversation/{session_id}/message | POST | Envia uma mensagem para o agente |
/files/upload | POST | Faz upload de um arquivo |
/files/{file_id} | GET | Obtém URL de download de um arquivo |
Webhooks
As respostas do agente são enviadas via webhook para a URL configurada ao abrir a conversa. O webhook recebe:
- Mensagens de resposta do agente (texto, documentos, imagens, etc.)
- Metadados com funções a serem executadas
- Informações da sessão coletadas durante a conversa
Importante
Certifique-se de que seu webhook retorna status 200 para confirmar o recebimento das mensagens.
Próximos Passos
Agora que você conhece a API v2, explore: