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.

Empieza gratis Descargar la especificación OpenAPI

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

Using an AI agent? Read the llms.txt

We serve a machine-readable version of these docs so coding agents (Claude Code, Cursor, ChatGPT, etc.) can find the right endpoint without parsing this page.

/api-docs/llms.txt : short index, generated from the live route table.

/api-docs/llms-full.txt : full reference (every endpoint, every parameter).

Paridad del 100% entre UI y API, ¿has encontrado una carencia? La cerraremos

Buscamos una paridad del 100% entre UI y API: todo lo que puedes ver en el panel de LLM Pulse debe poder consultarse a través de la API. Si encuentras alguna carencia, avísanos y nos comprometemos a implementarla, normalmente en cuestión de horas o unos pocos días.

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_idopcional

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. Los límites se resuelven a través del propietario de la cuenta, por lo que un miembro del equipo ve la capacidad que le corresponde. Una cuota ilimitada devuelve limit y remaining como null, con unlimited establecido en true.

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.

Descargar la CLI Leer la guía de la CLI

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.

Explorar los repositorios de SDK Leer la guía del SDK

Zona de pruebas de la API

Prueba los endpoints de la API en directo

Clave de API

Endpoint

Parámetros

Vista previa de la solicitud

curl -X GET "https://api.llmpulse.ai/api/v1/ping" -H "Authorization: Bearer YOUR_API_KEY"

Respuesta

\--

La respuesta aparecerá aquí...

Regístrate para obtener tu clave de API y empezar a probar

Obtener clave de API

Ejemplos de código

Download: OpenAPI Swagger Postman

Preguntar a la IA: Abrir en ChatGPT Abrir en Claude Ver como Markdown

Idioma

Quick Start Example

curl -X GET -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.llmpulse.ai/api/v1/metrics/timeseries?project_id=PROJECT_ID&metrics=mentions,visibility&granularity=day&range=30"

const response = await fetch("https://api.llmpulse.ai/api/v1/metrics/timeseries?project_id=PROJECT_ID&metrics=mentions,visibility&granularity=day&range=30", {
  headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();

import requests

response = requests.get(
    "https://api.llmpulse.ai/api/v1/metrics/timeseries?project_id=PROJECT_ID&metrics=mentions,visibility&granularity=day&range=30",
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)
data = response.json()

require 'httparty'

response = HTTParty.get(
  "https://api.llmpulse.ai/api/v1/metrics/timeseries?project_id=PROJECT_ID&metrics=mentions,visibility&granularity=day&range=30",
  headers: { "Authorization" => "Bearer YOUR_API_KEY" }
)
data = response.parsed_response

req, _ := http.NewRequest("GET", "https://api.llmpulse.ai/api/v1/metrics/timeseries?project_id=PROJECT_ID&metrics=mentions,visibility&granularity=day&range=30", nil)
req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://api.llmpulse.ai/api/v1/metrics/timeseries?project_id=PROJECT_ID&metrics=mentions,visibility&granularity=day&range=30', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_KEY']
]);
$data = json_decode($response->getBody(), true);

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.llmpulse.ai/api/v1/metrics/timeseries?project_id=PROJECT_ID&metrics=mentions,visibility&granularity=day&range=30"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

Authorization Header

curl -X GET -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.llmpulse.ai/api/v1/ping"

req, _ := http.NewRequest("GET", "https://api.llmpulse.ai/api/v1/ping", nil)
req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://api.llmpulse.ai/api/v1/ping', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_KEY']
]);
$data = json_decode($response->getBody(), true);

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.llmpulse.ai/api/v1/ping"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());

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. Los IDs de competidor devueltos aquí son los valores actor_id con los que informan los endpoints de métricas.

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 (denominadas Tags en la aplicación) agrupan los prompts por tema, etapa del embudo o campaña, de modo que cualquier métrica pueda filtrarse...

Respuestas (respuestas de IA)

Las respuestas de IA que hay detrás de cada métrica, con su texto completo, menciones, citaciones y análisis de sentimiento.

Menciones y citaciones

Los registros brutos que hay detrás de las métricas de visibilidad: una fila por mención de marca o por URL citada.

Sentimientos

Registros de sentimiento con sus comentarios, temas y puntuaciones, además del catálogo de categorías utilizado para etiquetarlos.

Fuentes e inteligencia de citaciones

Todas las URL que citaron los modelos, además de vistas agrupadas por URL, dominio y host, metadatos de caché de página, evidencia de menciones dentro de las...

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: el tráfico de referencia cubre a las personas que llegan desde asistentes de IA y el tráfico de agentes cubre los...

Compras y anuncios

Espacios comerciales dentro de las respuestas de IA: las tarjetas de producto que devuelven los modelos y los emplazamientos de pago que aparecen junto a...

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: la puntuación mensual de reputación de tu marca frente a sus competidores y los estudios de IA personalizados que defines...

Search Console

Datos de rendimiento de Google Search Console (impresiones, clics, CTR y posición media) para proyectos con una propiedad de GSC conectada.

Recomendaciones

Las mismas ejecuciones de recomendación que alimentan la página Recomendaciones de la aplicación, más el endpoint que lanza una nueva.

GEO Writer

Crea y gestiona tareas de GEO Writer con IA. Las tareas se procesan de forma asíncrona, así que crea una y haz polling hasta que se complete.

Informes técnicos de GEO

Ejecuta el conjunto de informes GEO técnicos para una URL; después, lista, consulta el estado y recupera cada informe.

Anotaciones

Marca una fecha en la cronología del proyecto (el lanzamiento de una campaña, una migración del sitio, un rediseño) para que un gráfico muestre qué ocurrió y...

Webhooks

Recibe un HTTP POST firmado cada vez que ocurre algo en un proyecto, sin necesidad de polling.

Integraciones

Formas listas para usar de llamar a la API: fragmentos de código en siete lenguajes, la colección de Postman y el servidor MCP para clientes de IA.

OAuth 2.1

OAuth 2.1 con PKCE y registro dinámico de clientes, para que un cliente MCP pueda conectarse a LLM Pulse sin que el usuario tenga que pegar una clave de API.

Registro de cambios

Todos los cambios de la API REST y las herramientas MCP, de los más recientes a los más antiguos.