Skip to main content

​
Bienvenido a la API de Inagent

La API de Inagent permite crear, administrar y supervisar agentes virtuales, así como integrar herramientas externas y automatizar procesos en tiempo real. Está diseñada para que desarrolladores y equipos técnicos puedan orquestar sesiones, consultar información de reportes, integrar canales y manipular la experiencia del cliente desde sus propias aplicaciones.
Toda la API es RESTful y trabaja con datos en formato JSON.
Los endpoints están agrupados en categorías como Gestión de agentes y equipos, Supervisión y administración de sesiones, Reportes, Herramientas y Webhooks.

​
Autenticación

La autenticación puede variar por familia de endpoints. La referencia de Reportes usa el header apikey y cada página indica explícitamente los headers requeridos.
Protege siempre tus credenciales. Almacénalas como variables de entorno y no las incluyas en repositorios, logs o ejemplos compartidos.

​
Estructura de la API

La API está organizada en grupos de endpoints:
  • Equipos y Agentes
    Creación y gestión de equipos de agentes virtuales, incluyendo canales, configuraciones y publicación.
  • Sesiones y Administración
    Control en tiempo real de conversaciones: pausar, reanudar, agregar contexto, transferir a otro agente, enviar mensajes en nombre del asistente o inyectar herramientas.
  • Reportes y Métricas
    Consulta de reportes del sistema, KPIs personalizados y exportación de datos de conversación.
  • Herramientas y Webhooks
    Integración de herramientas externas, notificaciones en tiempo real y automatizaciones basadas en eventos.

​
Formato de respuesta

Cuando un endpoint devuelve contenido, la respuesta se entrega en JSON. Revisa la página de cada endpoint para confirmar la estructura exacta.
En caso de error, se devuelve un código HTTP adecuado (4xx o 5xx) y un objeto con detalles del fallo:

​
Próximos pasos

Canal API EventStream

Integra aplicaciones externas con asistentes de Inagent mediante REST y eventos SSE en tiempo real.

API de reportes

Consulta reportes estándar y personalizados mediante endpoints autenticados con apikey.

Diccionario de eventos

Interpreta los eventos que aparecen en el historial y en integraciones técnicas.

API de administración de sesiones

Controla y modifica conversaciones en vivo: agrega contexto, transfiere, pausa o finaliza sesiones.