Skip to main content
POST
El endpoint de Chat es la forma principal de interactuar con tus agentes programáticamente.

Endpoint

Autenticación

Path Parameters

string
required
ID único del agente. Lo encontrás en el dashboard o en la URL del agente.

Headers

string
required
Bearer token con tu API key. Formato: Bearer sk_live_xxx
string
required
Siempre application/json
string
Usar text/event-stream para respuestas en streaming

Request Body

string
required
Mensaje del usuario a enviar al agente.
string
required
ID de la conversación. Usá el mismo ID para mantener el contexto entre mensajes.
string
ID único del visitante/usuario. Requerido para agentes públicos.
boolean
default:"false"
Si es true, la respuesta se envía token por token via Server-Sent Events (SSE).
string
default:"api"
Canal de origen del mensaje. Valores: api, website, whatsapp, widget, dashboard
object
Datos del contacto para CRM.
object
Filtros para limitar la búsqueda en datastores.
array
Archivos adjuntos al mensaje.
string
Override del modelo a usar. Valores: gpt-4o, gpt-4o-mini, claude-3-5-sonnet, gemini-1-5-pro

Response

string
required
Respuesta generada por el agente.
string
required
ID de la conversación (mismo que enviaste o uno nuevo si no existía).
string
required
ID único del mensaje generado.
array
Fuentes de conocimiento utilizadas para generar la respuesta.
object
Métricas de uso de tokens.
object
Información adicional sobre la respuesta.

Streaming (SSE)

Para recibir la respuesta token por token en tiempo real, usá streaming: true:

Eventos SSE


Agentes públicos (sin API key)

Para agentes con visibilidad pública, no necesitás API key pero sí visitorId:

Listar conversaciones del agente

string
Filtrar por visitante. Requerido para agentes públicos.
number
default:"10"
Cantidad de resultados. Máximo 50.

Errores comunes