Skip to main content
POST
https://suasofia.online/api/
/
conversations
/
{uuid}
/
messages
curl -X POST "https://suasofia.online/api/conversations/7c9e6679-7425-40de-944b-e07fc1f90ae7/messages" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Gostaria de agendar uma demonstração para a próxima semana"
  }'
{
  "status": true,
  "message": "Ficarei feliz em ajudar você a agendar uma demonstração! Tenho disponibilidade na segunda-feira às 14h, quarta-feira às 10h ou sexta-feira às 15h. Qual horário funciona melhor para você?",
  "function_calls": []
}
Este endpoint envia uma mensagem do usuário para uma conversa existente e retorna a resposta do assistente. O assistente processa a mensagem usando o modelo de IA configurado e quaisquer ferramentas disponíveis.

Parâmetros de Caminho

uuid
string
required
O identificador UUID único da conversa

Corpo da Requisição

message
string
required
A mensagem do usuário para enviar ao assistente. Comprimento máximo: 2000 caracteres.

Campos da Resposta

status
boolean
Indica se a requisição foi bem-sucedida
message
string
A resposta do assistente à mensagem do usuário
function_calls
array
Array de chamadas de função feitas pelo assistente durante o processamento da mensagem. Array vazio se nenhuma função foi chamada.

Respostas de Erro

status
boolean
Será false quando ocorrer um erro
error
string
Mensagem de erro. Valores possíveis:
  • Conversation not found - O UUID fornecido não corresponde a nenhuma conversa
  • Insufficient balance. Please top up your account. - O saldo da conta do proprietário do assistente está muito baixo
  • Failed to process message: [details] - Ocorreu um erro durante o processamento da mensagem
curl -X POST "https://suasofia.online/api/conversations/7c9e6679-7425-40de-944b-e07fc1f90ae7/messages" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Gostaria de agendar uma demonstração para a próxima semana"
  }'
{
  "status": true,
  "message": "Ficarei feliz em ajudar você a agendar uma demonstração! Tenho disponibilidade na segunda-feira às 14h, quarta-feira às 10h ou sexta-feira às 15h. Qual horário funciona melhor para você?",
  "function_calls": []
}

Preços

Cada mensagem do usuário em uma conversa de widget custa $0.01. Conversas de teste são gratuitas.

Chamadas de Função

O assistente pode executar funções durante o processamento de mensagens, tais como:
  • Operações de calendário: Verificar disponibilidade, agendar compromissos
  • Consultas à base de conhecimento: Pesquisar documentação ou FAQs
  • Integrações personalizadas: Chamar seus endpoints de webhook configurados
Os resultados das chamadas de função são incluídos na resposta para que você possa exibir informações relevantes ao usuário ou rastrear ações realizadas.

Melhores Práticas

  1. Lidar com erros de forma elegante: Exibir mensagens amigáveis quando ocorrerem erros
  2. Mostrar estados de carregamento: O assistente pode levar alguns segundos para responder, especialmente ao executar funções
  3. Preservar ID da conversa: Armazenar o UUID da conversa para permitir que usuários retomem conversas
  4. Respeitar limites de taxa: Implementar atrasos apropriados entre mensagens se necessário