Skip to main content
POST
Este endpoint cria uma nova sessão de conversa com um assistente de IA. Use para iniciar uma sessão de chat baseada em texto através do seu widget web ou aplicação.

Corpo da Requisição

string
required
O UUID do assistente para iniciar a conversa. Deve ser um UUID de assistente válido que existe no sistema.
string
default:"widget"
O tipo de conversa. Valores possíveis:
  • widget - Conversa de widget web (padrão, cobrada)
  • test - Conversa de teste (grátis, para desenvolvimento)
object
Variáveis personalizadas para passar ao assistente. Essas variáveis podem ser usadas no prompt do sistema e mensagem inicial do assistente usando a sintaxe {{nome_variavel}}.Casos de uso comuns:
  • Pré-preenchimento de informações do cliente de formulários
  • Passagem de contexto da sua aplicação
  • Personalização do comportamento do assistente por sessão

Campos de Resposta

boolean
Indica se a requisição foi bem-sucedida
string
O identificador UUID único para a conversa criada. Use este ID para requisições de mensagem subsequentes.
array
O histórico inicial da conversa. Se o assistente tem uma mensagem inicial configurada, ela será incluída aqui.

Respostas de Erro

boolean
Será false quando um erro ocorrer
string
Mensagem de erro descrevendo o que deu errado. Valores possíveis:
  • Assistant not found - O assistant_id fornecido não existe
  • Insufficient balance. Please top up your account. - O saldo da conta do proprietário do assistente está muito baixo

Preços

  • Conversas de widget: $0.01 por mensagem do usuário
  • Conversas de teste: Grátis (para desenvolvimento e testes)

Próximos Passos

Após criar uma conversa, use o endpoint Send Message para trocar mensagens com o assistente.