Referencia de API

API de chat

Controle las conversaciones por programación — de forma síncrona o en streaming, con las fuentes de recuperación en cada respuesta.

Cómo se procesa un turno

Todo mensaje, venga del widget, de la API o de un canal de mensajería, recorre el mismo flujo. Primero la autenticación y los controles de pertenencia y cuota; después la recuperación fundamenta la respuesta; luego se ejecuta el bucle de herramientas; y por último el turno se persiste con cifrado por campo, mientras la memoria y la difusión entre canales suceden en segundo plano.

Chat síncrono

curl https://chat.agent4.io/chat \
  -H "X-API-Key: tk_live_…" \
  -H "X-End-User: lead-1024" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Necesito un préstamo puente a 3 meses",
    "session_id": null,
    "agent": null
  }'

Campos de la petición

CampoTipoNotas
messagestringEl mensaje del usuario.
session_idstring | nullOmítalo para iniciar una sesión nueva; pase el id devuelto para continuarla.
agentstring | nullNombre del agente; omítalo para usar el predeterminado del inquilino.
knumber | nullCambia cuántos fragmentos de conocimiento se recuperan.
imagesstring[] | nullImágenes en data-URL (base64) para este turno (multimodal).
audiostring | nullAudio en data-URL; se transcribe en el servidor y se usa como mensaje.

Respuesta

{
  "session_id": "6f1e…",
  "reply": "Para un préstamo puente a 3 meses nuestras condiciones actuales son…",
  "sources": [
    { "document_id": "a3b4…", "distance": 0.18 }
  ],
  "transcript": null
}

sources enumera los documentos de la base de conocimiento en los que se fundamentó la respuesta; úselos para mostrar las citas. transcript se rellena cuando usted envió audio.

Streaming

POST /chat/stream acepta el mismo cuerpo y devuelve server-sent events, de modo que puede ir mostrando los tokens a medida que llegan:

curl -N https://chat.agent4.io/chat/stream \
  -H "X-API-Key: tk_live_…" \
  -H "X-End-User: lead-1024" \
  -H "Content-Type: application/json" \
  -d '{ "message": "Compare sus condiciones a 3 y a 6 meses" }'

Idioma

El idioma de la respuesta sigue al de la conversación. Envíe una cabecera Accept-Language para dirigir los mensajes de sistema y los correos de seguimiento; los siete idiomas de la plataforma son en, zh, zh-TW, es y ru.

El catálogo completo de endpoints —sesiones, documentos, espacios, consumo— se genera a partir del esquema OpenAPI en vivo, en la página API docs de la consola.