Documentation de l’API

Accédez à vos données de visibilité IA avec l’API REST, la CLI native en Rust, les SDK officiels pour 12 langages ou le MCP. Créez des tableaux de bord, des pipelines ETL et des workflows automatisés.

API LLM Pulse

Créez des tableaux de bord, des pipelines ETL et des automatisations avec une API claire et bien typée.

LLM Pulse est une plateforme d’analyse de la visibilité IA qui suit la façon dont votre marque apparaît dans les réponses générées par ChatGPT, Perplexity, Gemini et d’autres LLM. L’API vous donne un accès programmatique à toutes vos données de visibilité, notamment les mentions de marque, les sources citées, l’analyse de sentiment et les métriques de Share of Voice. Utilisez-la pour créer des tableaux de bord sur mesure, automatiser vos rapports ou intégrer le suivi de la visibilité IA à vos outils existants.

Authentification

Utilisez votre clé API comme jeton Bearer.

Authorization: Bearer YOUR_API_KEY

URL de base

Utilisez cette URL de base pour tous les endpoints ci-dessous. Les exemples incluent déjà le chemin complet.

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).

Parité de 100 % entre interface et API : un manque ? Nous le comblons

Nous visons une parité de 100 % entre l’interface et l’API : tout ce que vous voyez dans le tableau de bord LLM Pulse doit être accessible via l’API. Si vous constatez un manque, signalez-le : nous nous engageons à le combler, généralement en quelques heures ou en quelques jours.

Authentification

Envoyez votre clé dans l’en-tête Authorization sous forme de jeton Bearer. Renouvelez-la ou révoquez-la dans Paramètres → Clés API.

Un en-tête absent ou mal formé renvoie 401 ERR_MISSING_AUTH. Une clé inconnue renvoie 401 ERR_INVALID_API_KEY. Une clé révoquée renvoie 403 ERR_REVOKED_API_KEY.

Chaque appel s’exécute dans le contexte de l’utilisateur de la clé API. Les projets doivent appartenir à cet utilisateur ; sinon, l’appel renvoie 404 ERR_PROJECT_NOT_FOUND.

Ces endpoints acceptent POST/PATCH/PUT/DELETE et exigent une clé API avec le scope read_write. Un jeton avec le scope read reçoit 403 ERR_INSUFFICIENT_SCOPE. Les écritures se partagent une limite de requêtes plus stricte (60/min par clé), qui s’ajoute au budget global de 300/min par clé.

Démarrage rapide

Le parcours logique est le suivant : lister les ressources → (facultatif) récupérer les dimensions → interroger les métriques. Le premier appel à /dimensions/projects valide déjà votre clé API.

  1. Lister vos projets : GET /dimensions/projects
  2. (Facultatif) Récupérer les dimensions du projet (concurrents, modèles, pays et langues, tags)
  3. Récupérer les métriques via /metrics/*

Test de connexion

GET/ping

Le moyen le plus léger de vérifier qu’une clé fonctionne et de mesurer la latence aller-retour. Renvoie ok, le user_id authentifié et un request_id. Passez project_id pour vérifier aussi que la clé a accès à ce projet : la réponse ajoute alors project avec son id, son name et son brand_name.

Paramètres :
  • project_idfacultatif

Compte et limites

GET/account

Forfait, fréquence de suivi, période d’abonnement, consommation de chaque quota (prompts, réponses de l’IA du cycle de suivi en cours, projets, concurrents par projet, tâches GEO Writer mensuelles, membres de l’équipe) et limites de requêtes de l’API qui s’appliquent à votre clé. Appelez-le avant toute opération qui consomme du quota : vous pourrez indiquer ce qu’il reste au lieu de découvrir le plafond en l’atteignant. Les limites sont celles du propriétaire du compte : un membre de l’équipe voit donc la capacité qui s’applique à lui. Un quota illimité renvoie limit et remaining à null, avec unlimited à true.

  • Paramètres : aucun.

CLI et SDK officiels

Utilisez la CLI native depuis un terminal ou ajoutez un SDK typé à votre application. Les SDK sont générés à partir du document OpenAPI publié ; la CLI est maintenue séparément selon le même contrat d’API. Les deux utilisent les clés API et l’URL de base indiquées dans cette référence.

CLI en Rust

Un client Rust natif pour macOS, Linux et Windows, avec profils nommés et sortie JSON, tableau ou CSV. Utilisez-le pour des vérifications rapides, des scripts shell, des exports planifiés et des jobs de CI.

npm install -g @llmpulse/cli

SDK pour 12 langages

Clients officiels générés pour TypeScript, Python, Go, Java, Kotlin, C#, PHP, Ruby, Rust, Swift, Dart et R. Chaque client reste aligné sur le document OpenAPI publié.

Playground de l’API

Playground de l’API

Testez les endpoints de l’API en direct
curl -X GET "https://api.llmpulse.ai/api/v1/ping" -H "Authorization: Bearer YOUR_API_KEY"
--
La réponse s’affichera ici…

Créez un compte pour obtenir votre clé API et commencer vos tests

Obtenir une clé API

Parcourir la référence de l’API

Tous les endpoints, regroupés par ressource.

Concepts clés

Les règles communes à tous les endpoints : filtres, définitions des métriques, sorties JSON et CSV, codes d’erreur et gestion des versions.

Projets

Un projet correspond à une marque suivie : son domaine, son pays et sa langue, ses prompts et ses concurrents.

Métriques

Données agrégées de visibilité, de Share of Voice, de citations et de position pour votre marque et ses concurrents, prêtes pour vos graphiques.

Concurrents

Les marques que vous suivez en plus de la vôtre.

Prompts

Les questions que nous posons aux modèles d’IA à la fréquence de suivi configurée pour le compte, et les enregistrements produits à chaque exécution.

Collections et tags

Les collections (appelées tags dans l’application) regroupent les prompts par thème, étape du tunnel de conversion ou campagne, pour que toutes les métriques...

Réponses de l’IA

Les réponses de l’IA derrière chaque métrique, avec leur texte intégral, leurs mentions, leurs citations et leur analyse de sentiment.

Mentions et citations

Les enregistrements bruts derrière les métriques de visibilité : une ligne par mention de marque ou par URL citée.

Sentiments

Les enregistrements de sentiment avec leurs commentaires, thèmes et scores, plus le catalogue de catégories utilisé pour les classer.

Sources et analyse des citations

Toutes les URL citées par les modèles, avec des vues groupées par URL, domaine et hôte, les métadonnées du cache des pages, les preuves de mention dans les...

Analyse des modèles d’IA

Les sections agrégées du rapport Analyse des modèles d’IA de l’application.

Trafic IA et agents

Ce que l’IA envoie réellement vers votre site : le trafic référent couvre les visiteurs humains venus des assistants IA, le trafic des agents couvre les...

Shopping et publicités

Les formats commerciaux dans les réponses de l’IA : les fiches produits que renvoient les modèles, les emplacements payants affichés à côté, et les...

Médias propriétaires et communautés

Vos propres canaux et les conversations communautaires que citent les réponses de l’IA.

Réputation et études

Des rapports d’analyse multimodèles : le score mensuel de réputation de votre marque face à ses concurrents, et les études IA personnalisées que vous...

Search Console

Données de performance Google Search Console (impressions, clics, CTR, position moyenne) des projets dont une propriété GSC est connectée.

Rapports personnalisés

Les rapports personnalisés créés dans la section Rapports personnalisés de l’application : listez-les, lisez-en un avec les données de chaque widget telles...

Recommandations

Les mêmes exécutions de recommandations que celles qui alimentent la page Recommandations de l’application, ainsi que l’endpoint qui en lance une nouvelle.

GEO Writer

Créez et gérez des tâches GEO Writer assistées par l’IA.

Rapports GEO techniques

Lancez le lot GEO technique pour une URL, puis listez, interrogez et récupérez chaque rapport. Les rapports s’exécutent de façon asynchrone.

Audits GEO

Surveillez un domaine ou une URL avec un contrôle GEO technique et suivez son évolution.

Annotations

Marquez une date sur la chronologie du projet (lancement de campagne, migration de site, refonte) pour qu’un graphique montre ce qui s’est passé et quand.

Équipe

Gérez l’équipe du compte : listez les membres et les invitations en attente, invitez une personne par e-mail en choisissant ses projets et ses accès,...

Clés API

Listez vos clés API, créez une clé limitée à certains de vos projets (par exemple une par projet client) et révoquez-en une.

Intégrations de boutique

Les endpoints de l’application LLM Pulse pour Shopify : associer une boutique à son projet, envoyer les commandes que les assistants d’IA ont apportées à la...

Webhooks

Recevez une requête HTTP POST signée chaque fois qu’un événement se produit dans un projet, sans avoir à interroger l’API.

Intégrations

Des solutions prêtes à l’emploi pour appeler l’API : extraits de code dans sept langages, collection Postman et serveur MCP pour les clients IA.

OAuth 2.1

OAuth 2.1 avec PKCE et enregistrement dynamique des clients, pour qu’un client MCP puisse se connecter à LLM Pulse sans que l’utilisateur ait à coller une clé API.

Nouveautés

Toutes les modifications de l’API REST et des outils MCP, des plus récentes aux plus anciennes.