Documentación de la API - LLM Pulse CLI, SDKs, API REST y MCP
Documentación de la API
Accede a tus datos de visibilidad en IA con la API REST, la CLI nativa de Rust, los SDK oficiales para 12 lenguajes o MCP. Crea paneles, pipelines ETL y flujos de trabajo automatizados.
LLM Pulse API
Crea paneles, pipelines de ETL y automatizaciones con una API limpia y bien tipada.
LLM Pulse es una plataforma de analítica de visibilidad en IA que monitoriza cómo aparece tu marca en las respuestas generadas por IA de ChatGPT, Perplexity, Gemini y otros LLM. La API te da acceso programático a todos tus datos de visibilidad, incluidas las métricas de menciones de marca, fuentes de citación, análisis de sentimiento y Share of Voice. Úsala para crear paneles personalizados, automatizar informes o integrar el seguimiento de visibilidad en IA en tus herramientas actuales.
Autenticación
Usa un token Bearer de tu clave de API.
Authorization: Bearer YOUR_API_KEY
URL base
Usa esta URL base para todos los endpoints que aparecen a continuación. Los ejemplos ya incluyen la ruta completa.
https://api.llmpulse.ai/api/v1
Autenticación
Envía tu clave en la cabecera Authorization como token Bearer. Rota o revoca la clave en Configuración → Claves de API.
Cabeceras ausentes o mal formadas devuelven 401 ERR_MISSING_AUTH. Las claves desconocidas devuelven 401 ERR_INVALID_API_KEY. Las claves revocadas devuelven 403 ERR_REVOKED_API_KEY.
Cada llamada se ejecuta en el contexto del usuario de la clave de API. Los proyectos deben pertenecer a ese usuario; de lo contrario, 404 ERR_PROJECT_NOT_FOUND.
Estos endpoints aceptan POST/PATCH/PUT/DELETE y requieren una clave de API con el ámbito read_write. Un token con el ámbito read recibe 403 ERR_INSUFFICIENT_SCOPE. Las escrituras comparten un límite de solicitudes más estricto (60/min por clave) además del tope global de 300/min por clave.
Inicio rápido
El flujo lógico es: listar recursos → (opcionalmente) obtener dimensiones → consultar métricas. La primera llamada a /dimensions/projects ya valida tu clave de API.
- Lista tus proyectos:
GET /dimensions/projects - (Opcional) Obtén las dimensiones del proyecto (competidores, modelos, locales, etiquetas)
- Consulta métricas en
/metrics/*
Comprobación de estado
GET /ping
La forma más económica de comprobar que una clave funciona y medir la latencia de ida y vuelta. Devuelve pong, el id del usuario autenticado y la hora del servidor. Pasa project_id para verificar también que la clave puede acceder a ese proyecto.
Parámetros:
project_id(opcional)
Cuenta y límites
GET /account
Plan, cadencia de monitorización, período de suscripción, cuánto se ha consumido de cada cuota (prompts, proyectos, competidores por proyecto, tareas mensuales de GEO Writer y miembros del equipo) y los límites de solicitudes de la API que se aplican a tu clave. Llámalo antes de cualquier operación que consuma cuota para poder informar de lo que queda en lugar de descubrir el tope al chocar con él.
- Parámetros: ninguno.
CLI y SDK oficiales
Usa la CLI nativa desde un terminal o añade un SDK con tipos a tu aplicación. Ambos se generan a partir del documento OpenAPI publicado y funcionan con las mismas claves de API y la misma URL base que se muestran en esta referencia.
CLI de Rust
Un cliente nativo en Rust para macOS, Linux y Windows con perfiles con nombre y salida en JSON, tabla y CSV. Úsalo para comprobaciones rápidas, scripts de shell, exportaciones programadas y trabajos de CI.
SDKs para 12 lenguajes
Clientes oficiales generados para TypeScript, Python, Go, Java, Kotlin, C#, PHP, Ruby, Rust, Swift, Dart y R. Cada cliente se mantiene alineado con el documento OpenAPI publicado.
Zona de pruebas de la API
Prueba los endpoints de la API en directo.
Ejemplo de solicitud
curl -X GET "https://api.llmpulse.ai/api/v1/ping" \
-H "Authorization: Bearer YOUR_API_KEY"
Enviar solicitud
Respuesta
La respuesta aparecerá aquí...
Explora la referencia de la API
Todos los endpoints, agrupados por el recurso al que pertenecen.
- Conceptos básicos: Las reglas que comparten todos los endpoints: filtros, definiciones de métricas, salida en JSON y CSV, caché, códigos de error y versionado.
- Proyectos: Un proyecto es una marca monitorizada: su dominio, configuración regional, prompts y competidores.
- Métricas: Datos agregados de visibilidad, Share of Voice, citaciones y posiciones de tu marca y sus competidores, listos para representar en gráficos.
- Competidores: Las marcas que monitorizas junto a la tuya.
- Prompts: Las preguntas que lanzamos a los modelos de IA cada semana y los registros de ejecución que genera cada ejecución.
- Colecciones y tags: Las colecciones agrupan los prompts por tema, etapa del embudo o campaña.
- Respuestas: Las respuestas de IA que hay detrás de cada métrica.
- Menciones y citaciones: Los registros brutos que hay detrás de las métricas de visibilidad.
- Sentimientos: Registros de sentimiento con sus comentarios, temas y puntuaciones.
- Fuentes e inteligencia de citaciones: Todas las URL que citaron los modelos.
- AI Model Insights: Partes agregadas del informe AI Model Insights de la aplicación.
- Tráfico de IA y de agentes: Lo que la IA envía realmente a tu sitio.
- Compras y anuncios: Espacios comerciales dentro de las respuestas de IA.
- Medios propios y comunidades: Qué canales propios y qué conversaciones de comunidad citan las respuestas de IA.
- Reputación y estudios: Informes analíticos multimodelo.
- Search Console: Datos de rendimiento de Google Search Console.
- Recomendaciones: Ejecuciones de recomendación.
- GEO Writer: Crea y gestiona tareas de GEO Writer con IA.
- Anotaciones: Marca una fecha en la cronología del proyecto.
- Webhooks: Recibe un HTTP POST firmado cada vez que ocurre algo en un proyecto.
- Integraciones: Formas listas para usar de llamar a la API.
- OAuth 2.1: OAuth 2.1 con PKCE y registro dinámico de clientes.
- Registro de cambios: Todos los cambios de la API REST.