Skip to main content
Version: 0.1.0

AI Findr API

Acceso programático a la plataforma AI Findr.

AI Findr permite a las organizaciones crear experiencias conversacionales impulsadas por IA utilizando su propia base de conocimientos de contenido. Nuestra plataforma proporciona respuestas precisas y conscientes del contexto, mientras recopila análisis valiosos sobre las interacciones con los clientes y las brechas de conocimiento.

Introducción​

Esta API está documentada en formato OpenAPI y proporciona acceso completo a la plataforma AI Findr. Permite a los desarrolladores integrar AI Findr directamente en sus aplicaciones, ofreciendo una alternativa a nuestra solución de widget embebible.

Características Clave:

  • IA Conversacional: Haz preguntas y recibe respuestas inteligentes basadas en tu contenido ingresado.
  • Gestión de Contenido: Ingresa y administra la base de conocimientos de tu organización a través de diversas fuentes.
  • Analítica en Tiempo Real: Realiza seguimiento de conversaciones, identifica brechas de conocimiento y comprende las necesidades de los clientes.
  • Personalización de Marca: Personaliza la experiencia con la marca y el estilo de tu organización.
  • Soporte de Streaming: Obtén respuestas en tiempo real con Server-Sent Events (SSE) para una mejor experiencia de usuario.

Autenticación​

AI Findr admite dos métodos de autenticación:

Autenticación con Clave API (Recomendado para M2M)​

Para integraciones de máquina a máquina, utiliza la autenticación por clave API incluyendo el encabezado X-API-KEY en tus solicitudes. Las claves API se pueden generar a través del AI Findr Hub.

Autenticación con Token Bearer​

Para operaciones en contexto de usuario, utiliza tokens JWT bearer en el encabezado Authorization con el formato: Bearer {token}

Contexto de Organización​

La mayoría de los endpoints de la API requieren el encabezado X-Organization-Id para especificar dentro de qué contexto de organización operar. Esto asegura el aislamiento adecuado de los datos y el control de acceso.

Estructura de la API​

La API expone endpoints públicos para interacciones conversacionales, información de proyectos y seguimiento analítico.

Límites de Frecuencia​

Las solicitudes a la API están sujetas a límites de frecuencia para garantizar el uso justo y la estabilidad del sistema. Los límites varían según el endpoint y el método de autenticación.

Pruebas de la API​

Al probar endpoints en Swagger UI:

  1. Elegir Autenticación: Ingresa tu Clave API (ApiKeyAuth) en el botón "Authorize"
  2. Probar Endpoints: Todas las solicitudes ahora incluirán automáticamente el encabezado requerido

Soporte​

Para soporte técnico y consultas, contacta a nuestro equipo de ingeniería en producteam@aifindr.ai.

Aprende más sobre AI Findr en https://aifindr.ai.

Authentication​

Clave API para autenticación máquina a máquina. Genera una a través del AI Findr Hub. Recomendado para integraciones del lado del servidor y flujos de trabajo automatizados.

Security Scheme Type:

apiKey

Header parameter name:

X-API-KEY

Contact

Equipo de Producto de AI Findr: producteam@aifindr.ai