API Documentation - LLM Pulse CLI, SDKs, REST API & MCP

API Documentation

Access your AI visibility data with the REST API, native Rust CLI, official SDKs for 12 languages, or MCP. Build dashboards, ETL pipelines, and automated workflows.

LLM Pulse API

Build dashboards, ETL pipelines and automations with a clean, well-typed API.

LLM Pulse is an AI visibility analytics platform that monitors how your brand appears in AI-generated responses from ChatGPT, Perplexity, Gemini, and other LLMs. The API gives you programmatic access to all your visibility data, including brand mentions, citation sources, sentiment analysis, and share of voice metrics. Use it to build custom dashboards, automate reports, or integrate AI visibility tracking into your existing tools.

Authentication

Use a Bearer token from your API Key.

Authorization: Bearer YOUR_API_KEY

Base URL

Use this base URL for all endpoints below. Examples already include the full path.

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.

100% UI-to-API parity, found a gap? We'll close it

We aim for 100% UI-to-API parity, anything you can see in the LLM Pulse dashboard should be reachable through the API. If you find a gap, report it and we commit to implementing it, typically within hours to a few days.

Authentication

Send your key in the Authorization header as a Bearer token. Rotate/revoke under Settings → API Keys.

Missing or malformed headers return 401 ERR_MISSING_AUTH. Unknown keys return 401 ERR_INVALID_API_KEY. Revoked keys return 403 ERR_REVOKED_API_KEY.

Each call runs in the context of the API key’s user. Projects must belong to that user; otherwise 404 ERR_PROJECT_NOT_FOUND.

These endpoints accept POST/PATCH/PUT/DELETE and require an API key with the read_write scope. A token with the read scope receives 403 ERR_INSUFFICIENT_SCOPE. Writes share a tighter rate limit (60/min/key) in addition to the global 300/min/key budget.

Quick start

The logical flow is: list resources → (optionally) fetch dimensions → query metrics. The first call to /dimensions/projects already validates your API key.

  1. List your projects: GET /dimensions/projects
  2. (Optional) Fetch project dimensions (competitors, models, locales, tags)
  3. Request metrics under /metrics/*

Health Check

GET /ping

Cheapest way to verify a key works and measure round-trip latency. Returns pong, the authenticated user id and the server time. Pass project_id to also assert the key can reach that project.

Params:

Account & Limits

GET /account

Plan, tracking cadence, subscription window, how much of each quota is used (prompts, projects, competitors per project, monthly GEO Writer tasks, team members) and the API rate limits that apply to your key. Call it before anything that spends quota so you can report what is left instead of finding the ceiling by hitting it. Limits resolve through the account owner, so a team member sees the capacity that applies to them. An unlimited quota returns limit and remaining as null, with unlimited set to true.

Official CLI & SDKs

Use the native CLI from a terminal or add a typed SDK to your application. Both are generated from the published OpenAPI document and work with the same API keys and base URL shown in this reference.

Rust CLI

A native Rust client for macOS, Linux, and Windows with named profiles plus JSON, table, and CSV output. Use it for quick checks, shell scripts, scheduled exports, and CI jobs.

SDKs for 12 languages

Official generated clients for TypeScript, Python, Go, Java, Kotlin, C#, PHP, Ruby, Rust, Swift, Dart, and R. Each client stays aligned with the published OpenAPI document.

API Playground

API Playground

Test API endpoints live

Request Preview

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

Response

Response will appear here...

Browse the API reference

Every endpoint, grouped by the resource it belongs to:

Full access. Cancel anytime.