Información General

Acerca de la API

La API de Agente IA es un servicio que permite integrar capacidades de inteligencia artificial conversacional en aplicaciones y sistemas. Proporciona un conjunto de endpoints para interactuar con un agente de IA, gestionar bases de conocimiento personalizadas y monitorear el uso del servicio.

La URL base para todos los endpoints de esta API es:https://api.integrationit.co/

Autenticación

Todas las solicitudes a la API deben incluir un header de autenticación:

x-api-key: SU_API_KEY_AQUI

La API key es única para cada cliente y debe ser solicitada directamente a Integration IT.

Las API keys son confidenciales y no deben compartirse. Cada cliente recibe una API key única que identifica sus solicitudes y determina los límites de uso según su plan contratado.

Estructura de la API

La API está organizada en tres categorías principales de endpoints:

1. Comunicación con el Agente

/api/conectia - Endpoint principal para enviar mensajes al agente de IA

2. Gestión de Base de Conocimiento

/api/upload-knowledge - Subir archivos a la base de conocimiento
/api/knowledge-files - Listar archivos de la base de conocimiento
/api/delete-knowledge - Eliminar archivos de la base de conocimiento
/api/process-knowledge - Iniciar procesamiento asíncrono de archivos
/api/knowledge-processing-status - Consultar estado del procesamiento

3. Monitoreo de Uso

/api/usage - Obtener información de uso actual
/api/usage-history - Obtener historial de uso por períodos

Formatos de Respuesta

Todas las respuestas de la API se devuelven en formato JSON. Cada respuesta incluye al menos un camposuccess que indica si la solicitud fue exitosa.

En caso de error, la respuesta incluirá un campo error con un mensaje descriptivo.

Ejemplo de respuesta exitosa:

{
  "success": true,
  "message": "Operación completada correctamente",
  "data": {}
}

Ejemplo de respuesta de error:

{
  "success": false,
  "error": "Descripción del error",
  "code": "ERROR_CODE"
}

Límites y Consideraciones

El número máximo de solicitudes permitidas depende del plan contratado.
El tamaño máximo de archivos para subir a la base de conocimiento es de 10MB.
Los formatos de archivo soportados son: PDF.
Las solicitudes que excedan los límites recibirán un código de error 429 (Too Many Requests).
Se recomienda implementar mecanismos de reintento con backoff exponencial para manejar errores temporales.

Soporte

Para obtener ayuda con la integración o reportar problemas, contacte al equipo de soporte de Integration IT:

Email: soporte@integrationit.co
Horario de atención: Lunes a Viernes, 9:00 AM - 6:00 PM (GMT-5)