Visión General
La plataforma ofrece APIs REST completas para integración, automatización y desarrollo. Cada servicio de la plataforma posee su propia API documentada con especificaciones OpenAPI (Swagger). Lo que encontrarás aquí:- Documentación completa de todas las APIs disponibles
- Especificaciones OpenAPI para cada servicio
- Ejemplos de uso e integración
- Guías de autenticación y autorización
APIs Disponibles
La plataforma está compuesta por múltiples microservicios, cada uno con su propia API:Servicios de Aplicación
EvoAI Core Service- Gestión de agentes de IA
- Custom Tools y MCP (Model Context Protocol)
- Sincronización con bots Evolution
- Base URL:
https://api.evoai.app
- Gestión de conversaciones y mensajes
- CRUD de contactos y agentes
- Configuración de inboxes y canales
- Base URL:
https://api.evoai.app
- Autenticación y autorización
- Multi-Factor Authentication (MFA)
- Role-Based Access Control (RBAC)
- Base URL:
https://api.evoai.app
- Creación y gestión de campañas
- Segmentación de contactos
- Automatizaciones y workflows
- Base URL:
https://api.evoai.app
- Procesamiento asíncrono de agentes
- Ejecución de workflows de IA
- Gestión de colas
- Base URL:
https://api.evoai.app
- Carga y gestión de documentos
- Búsqueda semántica
- RAG (Retrieval-Augmented Generation)
- Base URL:
https://api.evoai.app
Servicios de Infraestructura Evolution
Evolution API- Gestión de instancias WhatsApp
- Envío y recepción de mensajes
- Integraciones con chatbots
- Base URL:
https://api.evoai.app
- Gateway de alto rendimiento
- Procesamiento concurrente
- Base URL:
https://api.evoai.app
Base URL
Todos los servicios utilizan la misma Base URL:- Base URL:
https://api.evoai.app
OpenAPI / Swagger
Todas las APIs poseen especificaciones OpenAPI completas en formato YAML. Puedes importar estas especificaciones en herramientas como Postman, Insomnia, o generar SDKs automáticamente.Especificaciones Disponibles
Servicios de Aplicación
- Evo Auth Service - Autenticación, gestión de usuarios y cuentas
- EvoAI Core Service - Agentes de IA, herramientas MCP y procesamiento inteligente
- EvoAI CRM Service - Gestión de contactos, conversaciones, inboxes, etiquetas y macros
- EvoAI Processor Service - Procesamiento de IA, integraciones y sesiones
- EvoAI Knowledge Service - Base de conocimiento y gestión de memoria
Servicios de Infraestructura Evolution
- Evolution API - API principal de Evolution para WhatsApp
- Evolution Go - Implementación en Go de Evolution
Autenticación
El estándar principal de autenticación en las APIs EvoAI es API Access Token (UUID) enviado en el headerapi_access_token.
Para obtener credenciales y entender los detalles completos de autenticación, consulta la guía dedicada:
Guía Completa de Autenticación
Ejemplo rápido:
Cómo Usar Esta Documentación
Navegación
- Introducción (esta página) - Visión general de las APIs y cómo empezar
- Autenticación - Guía completa de API Access Token y multi-tenant
- Especificaciones OpenAPI - Documentación interactiva de cada servicio (ver sección arriba)
Especificaciones OpenAPI
Cada API posee una especificación OpenAPI completa en formato YAML. Puedes:- Importar en Postman, Insomnia u otras herramientas
- Generar clientes SDK automáticamente usando
openapi-generator - Visualizar interactivamente usando Swagger UI
Ejemplos de Solicitudes
Cada endpoint incluye ejemplos de solicitudes y respuestas con:- Códigos de estado HTTP esperados
- Estructura de payloads de solicitud
- Formato de respuestas JSON
Códigos de Estado HTTP
Todas las APIs siguen patrones consistentes: Códigos de Éxito:200- OK (solicitud exitosa)201- Created (recurso creado exitosamente)
400- Bad Request (datos inválidos)401- Unauthorized (token inválido o ausente)403- Forbidden (sin permiso)404- Not Found (recurso no encontrado)500- Internal Server Error (error del servidor)522- Connection Timed Out (timeout en la conexión)
Quick Start
Ejemplo: Listar Agentes IA
Ejemplo: Crear un Agente IA
Convenciones
Formato de Fecha
Todas las APIs usan formato ISO 8601:Paginación
Las APIs que retornan listas soportan paginación:Filtros y Búsqueda
Muchas APIs soportan filtros vía query parameters:Herramientas Recomendadas
- Postman - Colección de APIs y pruebas
- Insomnia - Cliente REST alternativo
- Swagger UI - Visualización interactiva de las APIs
- OpenAPI Generator - Generación automática de SDKs
- curl - Pruebas rápidas vía línea de comandos
Próximos Pasos
- Elige la API que necesitas usar
- Consulta la especificación OpenAPI correspondiente
- Configura autenticación obteniendo tu API Access Token
- Comienza a integrar usando los ejemplos proporcionados
FAQ
¿Cómo obtengo credenciales de API?
El API Access Token (UUID) puede ser obtenido a través del panel de configuraciones del usuario o administrador. Consulta la guía completa de autenticación para detalles.¿Puedo usar las APIs en producción?
Sí, todas las APIs son estables y listas para producción. Asegúrate de usar HTTPS y gestionar tus tokens de forma segura.¿Las APIs soportan rate limiting?
Sí, la mayoría de las APIs implementa rate limiting. Consulta la documentación específica de cada API para límites detallados.¿Cómo reporto problemas o sugiero mejoras?
Abre una issue en GitHub o contacta a través del email de soporte.¿Listo para comenzar?
- Configura la autenticación para obtener tu API Access Token
- Explora las especificaciones OpenAPI de cada servicio
- Consulta los ejemplos de uso a continuación o en las guías específicas de integración