LLM Pulse Reputation & Studies API
Multi-model analyst reports: the monthly reputation scoring of your brand against its competitors, and the custom AI studies you define over any subjects and dimensions. Requires reputation monitoring.
Multi-model analyst reports: the monthly reputation scoring of your brand against its competitors, and the custom AI studies you define over any subjects and dimensions. Requires reputation monitoring.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/llmpulse-ai:llmpulse-ai-reputation-studies-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: LLM Pulse Reputation & Studies API
description: 'REST API for the LLM Pulse AI visibility platform. Track brand mentions, citations, sentiment, and Share of Voice across AI-generated answers (ChatGPT, Perplexity, Gemini, Google AI Overviews, Google AI Mode, and optional add-on models). Includes the MCP (Model Context Protocol) endpoint for AI clients. MCP is available on every plan and during eligible trials via OAuth 2.1, with Bearer-token API keys also accepted for headless integrations on the Scale plan or above. Full machine-readable reference at https://llmpulse.ai/api-docs/llms-full.txt. An API key can be limited to one or several projects when it is created, and the set never changes. Such a key sees only those projects: any other project id, domain or name answers ERR_PROJECT_NOT_FOUND exactly like a project that does not exist, listings return only those projects'' rows, and operations on the whole account (creating or deleting a project, the project draft wizard) answer ERR_KEY_PROJECT_SCOPED. Operations carry vendor extensions: x-plan is the plan or entitlement the endpoint requires beyond an API key (growth, scale or reputation_access), x-write marks endpoints that need a read and write key, x-mcp-tool names the MCP tool that returns the same data, x-mcp-plan gives that tool''s plan where it differs, and x-rest-only explains an endpoint with no MCP tool. Parameters are read strictly, on REST and MCP alike: a value outside a documented enum, a boolean other than true, false, 1 or 0, an id or count that is not a plain positive number (12abc, 1.0 or 0), an id of a record the project does not have, or a from later than to answers 422 ERR_INVALID_PARAM naming the parameter, never an ignored filter. A listed value, in a query or a request body, matches in any letter case and is read in its documented spelling (granularity=Week reads as week, aggregation_type=BYPAGE as byPage, event_type=Mention.Created as mention.created). page and per_page keep their own rule: a value that is not a number reads as absent and an out-of-range one is clamped.'
version: 1.97.0
contact:
name: LLM Pulse Support
url: https://llmpulse.ai
email: info@llmpulse.ai
license:
name: Proprietary
url: https://llmpulse.ai/terms
servers:
- url: https://api.llmpulse.ai/api/v1
description: Production API
security:
- BearerAuth: []
tags:
- name: Reputation & Studies
description: 'Multi-model analyst reports: the monthly reputation scoring of your brand against its competitors, and the custom AI studies you define over any subjects and dimensions. Requires reputation monitoring.'
paths:
/reputation/reports:
get:
tags:
- Reputation & Studies
summary: List reputation reports
x-llms-description: List the monthly reputation reports for a project, newest first, with status and which analyst models produced data.
operationId: listReputationReports
x-mcp-tool: list_reputation_reports
x-plan: reputation_access
description: 'The monthly multi-model analyst reports scoring the tracked brand and its competitors, newest first. Pending and failed reports are included on purpose: whether this month ran at all is often the question. Each row carries the report id, its status, and which analyst models produced data. Requires reputation monitoring to be enabled on the account.'
parameters:
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PerPage'
- $ref: '#/components/parameters/Output'
responses:
'200':
description: Paginated report summaries
post:
tags:
- Reputation & Studies
summary: Start a reputation report
x-llms-description: Start this month's reputation report for a project, or use the one manual recalculation a month with recalculate=true; poll GET /reputation/reports until it completes.
operationId: createReputationReport
x-mcp-tool: create_reputation_report
x-plan: reputation_access
x-write: true
description: 'Starts this month''s Brand Reputation report, like the Generate button on the Reputation page: 201 with the new report (status pending). When the month already holds a report that did not fail, whether it is still running or finished, nothing new starts and the answer is 200 with created false and that report. With recalculate true it uses the month''s one manual recalculation instead (the Recalculate This Month button): a fresh run across every analyst model, 201 when it starts, 200 with created false while a report is still running, and ERR_LIMIT_REACHED once the month holds two reports. Generation runs in the background: poll GET /reputation/reports until status is completed, then read the scores with GET /reputation/reports/{id}. ERR_RATE_LIMITED (429, with Retry-After) means another request is starting a report for the same project; retry after a few seconds. recalculate must be true or false and unknown fields are refused (ERR_INVALID_PARAM). Requires reputation monitoring on the account, a `read_write` scope API key and, for team members, create permission on Reputation.'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- project_id
properties:
project_id:
type: integer
recalculate:
type: boolean
default: false
description: Use this month's one manual recalculation instead of returning the existing report
responses:
'200':
description: Nothing new started; the report that already holds this month
content:
application/json:
schema:
$ref: '#/components/schemas/ReputationReportCreateResponse'
'201':
description: The new report, status pending
content:
application/json:
schema:
$ref: '#/components/schemas/ReputationReportCreateResponse'
'403':
$ref: '#/components/responses/InsufficientScope'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'429':
description: Another request is starting a report for this project; retry after a few seconds
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/reputation/reports/{id}:
get:
tags:
- Reputation & Studies
summary: Get reputation report scores
x-llms-description: 'Reputation report scores as flat rows: one row per analyst model, brand, dimension and attribute, with score and reasoning.'
operationId: getReputationReport
x-mcp-tool: get_reputation_report
x-plan: reputation_access
description: 'One reputation report''s scores as flat rows: one row per analyst model, brand, dimension and attribute, with its 0-100 score and the reasoning the model gave. Scores come from several analyst models independently, so compare models rather than averaging them blindly.'
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The report id from GET /reputation/reports
- $ref: '#/components/parameters/ProjectId'
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PerPage'
- name: model
in: query
required: false
schema:
type: string
enum:
- chatgpt
- perplexity
- gemini
- deepseek
- grok
- claude
description: Restrict to one analyst model
- name: brand
in: query
required: false
schema:
type: string
description: Restrict to one brand name, or a comma-separated list
- name: dimension
in: query
required: false
schema:
type: string
description: Restrict to one reputation dimension key
- $ref: '#/components/parameters/Output'
responses:
'200':
description: Paginated score rows plus the report summary
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
/studies:
get:
tags:
- Reputation & Studies
summary: List custom AI studies
x-llms-description: List the custom AI studies defined on the account (account-scoped; project_id is an optional filter).
operationId: listStudies
x-mcp-tool: list_studies
x-plan: reputation_access
description: 'The custom AI studies defined on the account: analyst reports over any set of subjects (brands, sectors, topics) and any set of dimensions. Studies belong to the ACCOUNT, not to a project, so project_id is an optional filter here and account-level studies are returned whichever project you filter by. A team member whose project access is restricted sees only the studies of the projects they can reach. Requires reputation monitoring to be enabled on the account.'
parameters:
- name: project_id
in: query
required: false
schema:
type: integer
description: Restrict to studies attached to this project (plus account-level ones)
- name: status
in: query
required: false
schema:
type: string
enum:
- active
- archived
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PerPage'
- $ref: '#/components/parameters/Output'
responses:
'200':
description: Paginated study summaries
/studies/{id}:
get:
tags:
- Reputation & Studies
summary: Get a custom AI study
x-llms-description: One custom AI study with its brief, subjects, dimensions and report history.
operationId: getStudy
x-mcp-tool: get_study
x-plan: reputation_access
description: One study with its brief, the subjects it compares, the dimensions it scores them on, and its report history. Use the ids in `reports` with GET /studies/{id}/reports/{report_id}.
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
'200':
description: The study
'404':
$ref: '#/components/responses/NotFound'
/studies/{id}/reports/{report_id}:
get:
tags:
- Reputation & Studies
summary: Get custom study report scores
x-llms-description: 'Custom study report scores as flat rows: one row per analyst model, subject, dimension and attribute, with score and reasoning.'
operationId: getStudyReport
x-mcp-tool: get_study_report
x-plan: reputation_access
description: 'One custom-study report''s scores as flat rows: one row per analyst model, subject, dimension and attribute, with its 0-100 score and the reasoning the model gave.'
parameters:
- name: id
in: path
required: true
schema:
type: integer
- name: report_id
in: path
required: true
schema:
type: string
description: The report id from GET /studies/{id}
- $ref: '#/components/parameters/Page'
- $ref: '#/components/parameters/PerPage'
- name: model
in: query
required: false
schema:
type: string
enum:
- chatgpt
- perplexity
- gemini
- deepseek
- grok
- claude
description: Restrict to one analyst model
- name: subject
in: query
required: false
schema:
type: string
description: Restrict to one subject name, or a comma-separated list
- name: dimension
in: query
required: false
schema:
type: string
description: Restrict to one dimension key
- $ref: '#/components/parameters/Output'
responses:
'200':
description: Paginated score rows plus the report summary
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
components:
parameters:
ProjectId:
name: project_id
in: query
required: true
schema:
type: integer
description: Project ID
PerPage:
name: per_page
in: query
schema:
type: integer
default: 20
maximum: 100
minimum: 1
Output:
name: output
in: query
schema:
type: string
enum:
- flat
- csv
description: Rectangular output for BI tools (Tableau, Excel, Sheets, ELT). Omit for the default nested JSON. 'flat' returns the same metadata plus 'columns' and 'rows'; 'csv' returns those rows as text/csv. Errors are always returned as JSON.
Page:
name: page
in: query
schema:
type: integer
default: 1
minimum: 1
schemas:
Error:
type: object
properties:
error:
type: object
properties:
code:
type: string
enum:
- ERR_MISSING_AUTH
- ERR_INVALID_API_KEY
- ERR_REVOKED_API_KEY
- ERR_INSUFFICIENT_SCOPE
- ERR_INSUFFICIENT_PERMISSION
- ERR_KEY_PROJECT_SCOPED
- ERR_PLAN_REQUIRED
- ERR_INTEGRATION_UNAVAILABLE
- ERR_GENERATION_FAILED
- ERR_ACCOUNT_INACTIVE
- ERR_DRAFT_NOT_FOUND
- ERR_DRAFT_STATE
- ERR_PROJECT_NOT_FOUND
- ERR_NOT_FOUND
- ERR_SEARCH_CONSOLE_NOT_CONNECTED
- ERR_SEARCH_CONSOLE_ACCESS_REVOKED
- ERR_SEARCH_CONSOLE_UPSTREAM
- ERR_CMS_NOT_CONNECTED
- ERR_CMS_ACCESS_REVOKED
- ERR_CMS_REJECTED
- ERR_CMS_UPSTREAM
- ERR_AI_TRAFFIC_NOT_CONNECTED
- ERR_WEB_ANALYTICS_NOT_CONNECTED
- ERR_WEB_ANALYTICS_INVALID_QUERY
- ERR_WEB_ANALYTICS_ACCESS_REVOKED
- ERR_WEB_ANALYTICS_UPSTREAM
- ERR_AGENT_TRAFFIC_NOT_CONNECTED
- ERR_INVALID_PARAM
- ERR_INVALID_RANGE
- ERR_LIMIT_REACHED
- ERR_QUOTA_EXCEEDED
- ERR_STALE_CONTENT
- ERR_RATE_LIMITED
message:
type: string
meta:
type: object
description: Extra detail for some codes. A not-connected or access-revoked error from the Search Console, AI traffic, web analytics or agent traffic endpoints carries connect_url, the in-app page where the user connects or reconnects the source. A prompt write refused because a launched pitch project's prompts are fixed carries reason pitch_prompts_frozen.
request_id:
type: string
ReputationReportCreateResponse:
type: object
required:
- project_id
- created
- report
properties:
project_id:
type: integer
created:
type: boolean
description: True when this request started a new report; false when it returned the one that already holds the month
report:
$ref: '#/components/schemas/ReputationReportSummary'
request_id:
type: string
ReputationReportSummary:
type: object
description: One reputation report's status and analyst model coverage
required:
- id
- status
- created_at
- available_models
- missing_models
properties:
id:
type: string
description: Report id for GET /reputation/reports/{id}
status:
type: string
enum:
- pending
- processing
- completed
- failed
created_at:
type: string
format: date-time
processed_at:
type:
- string
- 'null'
format: date-time
available_models:
type: array
description: Analyst models that produced data
items:
type: string
enum:
- chatgpt
- perplexity
- gemini
- deepseek
- grok
- claude
missing_models:
type: array
description: Analyst models with no data yet
items:
type: string
enum:
- chatgpt
- perplexity
- gemini
- deepseek
- grok
- claude
error_message:
type:
- string
- 'null'
description: Why the report failed; null unless status is failed
responses:
UnprocessableEntity:
description: Invalid parameters
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: ERR_INVALID_PARAM
message: invalid metrics
request_id: abc-123
NotFound:
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: ERR_PROJECT_NOT_FOUND
message: project_not_found
request_id: abc-123
InsufficientScope:
description: API key lacks write permission
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: ERR_INSUFFICIENT_SCOPE
message: insufficient_scope_write_required
request_id: abc-123
securitySchemes:
BearerAuth:
type: http
scheme: bearer
description: API key authentication. Keys are managed at https://llmpulse.ai/app/api_keys (Scale plan or above). Used for the REST API and as a headless option for /mcp. A key can be limited to one or several projects when it is created; the set cannot be changed later.
OAuth2:
type: oauth2
description: OAuth 2.1 with PKCE-S256 and Dynamic Client Registration. Accepted on /mcp only, available on every plan and during eligible trials. Discovery metadata at /.well-known/oauth-authorization-server.
flows:
authorizationCode:
authorizationUrl: https://api.llmpulse.ai/oauth/authorize
tokenUrl: https://api.llmpulse.ai/oauth/token
scopes:
mcp:read: Read data via MCP tools
mcp:write: Create resources via MCP write tools