Skip to main content
Disponible en: el plan Enterprise

​
Descripción general

Nuestra API permite a los desarrolladores interactuar de forma programática con los datos que se muestran en nuestra plataforma. Todas las respuestas de la API se devuelven en formato JSON, lo que facilita la integración con aplicaciones y herramientas modernas.

​
URL base

Todas las solicitudes a la API deben realizarse a:
Capacidades clave:
  • Automatizar tareas de obtención y procesamiento de datos
  • Crear integraciones con aplicaciones de terceros
  • Generar reportes y analítica personalizados
  • Acceder a reportes procesados y a datos sin procesar de prompts y respuestas por ejecución

​
Funciones de la API

​
Generación de reportes

Crea reportes completos con datos procesados de nuestro sistema de prompts. Compara métricas de rendimiento entre distintas empresas, periodos o criterios de evaluación para obtener información sobre tus datos.

​
Datos sin procesar por ejecución

Accede a filas sin procesar de prompts y respuestas por ejecución mediante POST /v2/prompts/answers, incluidas las respuestas de los modelos, las menciones, las citas y las consultas de búsqueda.

​
Datos limitados a la organización

Cada clave de API proporciona acceso a los datos de su organización asociada, lo que garantiza el aislamiento y la seguridad adecuados de los datos.

​
Primeros pasos

Para empezar a usar la API, necesitarás una clave de API de tu perfil de usuario en nuestra plataforma. Esta clave autentica tus solicitudes y otorga acceso a los datos de tu organización. Para conocer los detalles de autenticación y ver ejemplos de solicitudes, consulta:

​
Fundamentos de la API

​
Organización de los datos

Cada organización tiene acceso a categorías y conjuntos de datos específicos. Usa los endpoints /v1/org para:
  • Descubrir las categorías de datos disponibles
  • Obtener identificadores para filtrar
  • Comprender el alcance y los permisos de tus datos

​
Parámetros obligatorios

Los reportes de Answer Engine Insights requieren un identificador de categoría y parámetros de rango de fechas (start_date y end_date). Los reportes de tráfico de bots y referencias, en cambio, están limitados por dominio. Consulta Rangos de fechas y zonas horarias para conocer el formato correcto.

​
Versionado de la API

Actualmente, la API tiene endpoints v1 y v2:
  • Los endpoints v1 siguen activos, incluidos los endpoints de reportes V1 existentes
  • v2 ahora abarca los reportes de Answer Engine Insights en /v2/reports/visibility, /v2/reports/citations, /v2/reports/sentiment, /v2/reports/query-fanouts, /v2/reports/factcheck y /v2/reports/factcheck/claims, así como /v2/prompts/answers. Cada uno tiene una variante SSE /stream.
Las rutas versionadas garantizan la compatibilidad a medida que la API evoluciona.

​
Límites de solicitudes

Límites predeterminados: 600 solicitudes por hora por clave de API.

​
Encabezados de límite de solicitudes

Todas las respuestas de la API incluyen estos encabezados:
  • X-RateLimit-Limit: tu límite total de solicitudes
  • X-RateLimit-Remaining: solicitudes restantes en el periodo actual
  • X-RateLimit-Reset: cuándo se restablece el límite (marca de tiempo Unix)

​
Manejo de los límites de solicitudes

Cuando superas el límite, recibes un error 429 Too Many Requests. La respuesta incluye un encabezado Retry-After que indica cuánto tiempo debes esperar antes de reintentar. ¿Necesitas límites más altos? Contacta a nuestro equipo de soporte para hablar sobre tus requisitos.

​
Formato de respuesta

Todas las respuestas de la API usan formato JSON con una estructura coherente para los errores y las respuestas exitosas.