LLM Pulse Account API
Plan, subscription window, quota consumption and API rate limits for the authenticated account. Read it before spending quota so an integration can see its remaining budget instead of discovering the ceiling by hitting it.
Plan, subscription window, quota consumption and API rate limits for the authenticated account. Read it before spending quota so an integration can see its remaining budget instead of discovering the ceiling by hitting it.
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-account-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 Account 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: Account
description: Plan, subscription window, quota consumption and API rate limits for the authenticated account. Read it before spending quota so an integration can see its remaining budget instead of discovering the ceiling by hitting it.
paths:
/account:
get:
tags:
- Account
summary: Account plan, quota usage and rate limits
x-llms-description: Plan, subscription window, quota usage (prompts, AI answers this tracking cycle, projects, competitors, intelligence tasks, pitch projects) and API rate limits for the authenticated account.
description: 'Returns the account plan, tracking cadence, subscription window, how much of each quota is used (prompts, projects, competitors per project, monthly GEO Writer tasks, team members, active recurring GEO audits, manual GEO audit runs in the last 24 hours, AI answers spent in the current tracking window with its reset time, and pitch projects created this month, with the account''s pitch project access) and the published API rate limits. 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, since Infinity is not representable in JSON. The subscription block is only present for callers who can access Billing and Plans in the app (the account owner, or a team member with billing access); everyone else gets the same response without that key. requests_per_minute is the ceiling of the key used for the call, not a fixed number. For a key limited to some projects, the response carries nothing about the rest of the account: plan, plan_name, subscription and limits.team_members are absent, api_key_project_ids lists the key''s projects, limits.prompts.used counts those projects'' prompts, limits.prompts, limits.intelligence_tasks, the two GEO audit quotas and limits.prompt_executions show only remaining and unlimited (the capacity the key can still spend, without the account total), limits.pitch_projects is absent, and the projects quota is capped at the projects it reaches. tracking_frequency stays, as the cadence those projects'' data is collected at.'
operationId: getAccount
x-mcp-tool: get_account_usage
responses:
'200':
description: Account usage snapshot
content:
application/json:
schema:
type: object
properties:
plan:
type: string
description: Plan key (starter, growth, scale, ...). Absent for a key limited to some projects.
plan_name:
type: string
description: Display name of the plan to show people (e.g. Scale++ for the scaleplusplus key). Absent for a key limited to some projects.
tracking_frequency:
type: string
description: How often prompts run (weekly, daily, monthly, ...)
role:
type: string
enum:
- owner
- member
description: Whether the key belongs to the account owner or a team member
api_key_project_ids:
type:
- array
- 'null'
items:
type: integer
description: The projects the calling API key is limited to; null for a key that sees the whole account, and for OAuth
subscription:
type: object
description: Billing state. Present only for callers who can access Billing and Plans in the app; absent otherwise.
properties:
status:
type: string
trialing:
type: boolean
current_period_ends_at:
type:
- string
- 'null'
format: date-time
limits:
type: object
properties:
prompts:
$ref: '#/components/schemas/AccountQuota'
projects:
$ref: '#/components/schemas/AccountQuota'
competitors_per_project:
$ref: '#/components/schemas/AccountCapacity'
intelligence_tasks:
$ref: '#/components/schemas/AccountQuota'
team_members:
$ref: '#/components/schemas/AccountCapacity'
recurring_geo_audits:
$ref: '#/components/schemas/AccountQuota'
geo_audit_manual_runs:
$ref: '#/components/schemas/AccountQuota'
prompt_executions:
$ref: '#/components/schemas/AccountExecutionQuota'
pitch_projects:
$ref: '#/components/schemas/AccountPitchQuota'
rate_limits:
type: object
properties:
requests_per_minute:
type: integer
description: The ceiling enforced for the API key used on this call, which may be above the 300/min default.
write_requests_per_minute:
type: integer
description: Flat ceiling on write requests, the same for every key.
request_id:
type: string
'401':
$ref: '#/components/responses/Unauthorized'
components:
schemas:
AccountQuota:
type: object
description: 'A consumable quota. limit and remaining are null when unlimited is true. For a key limited to some projects, prompts and intelligence_tasks carry no limit (and intelligence_tasks no used): only the capacity left.'
properties:
limit:
type:
- integer
- 'null'
used:
type: integer
remaining:
type:
- integer
- 'null'
unlimited:
type: boolean
period:
type: string
description: Reset window for quotas that reset (e.g. month)
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
AccountExecutionQuota:
type: object
description: 'The account''s allowance of AI answers for the current tracking window: its prompt limit times its enabled AI models, plus 5% so prompts can be replaced during the window. Every scheduled run and every first run of a new prompt spends one answer per AI model, and deleting a prompt gives nothing back. When it is used up, new prompts wait until resets_at. limit and remaining are null when unlimited is true. For a key limited to some projects, only remaining and unlimited (the account-wide answers left), period and resets_at.'
properties:
limit:
type:
- integer
- 'null'
used:
type: integer
remaining:
type:
- integer
- 'null'
unlimited:
type: boolean
period:
type: string
enum:
- day
- week
- month
description: The tracking window, from the account's tracking cadence (week runs Monday to Sunday)
resets_at:
type: string
format: date-time
description: When the next window starts and the allowance is full again (00:00 Europe/Madrid)
AccountCapacity:
type: object
description: A ceiling with no usage counter attached. limit is null when unlimited is true.
properties:
limit:
type:
- integer
- 'null'
unlimited:
type: boolean
AccountPitchQuota:
type: object
description: Pitch projects created this calendar month (Europe/Madrid) against the monthly allowance, which pitch projects use instead of a project slot. limit and remaining are null when unlimited is true.
properties:
limit:
type:
- integer
- 'null'
used:
type: integer
remaining:
type:
- integer
- 'null'
unlimited:
type: boolean
period:
type: string
description: Always month
resets_on:
type: string
format: date
description: The first day of next month, when the allowance starts again
access:
type: string
enum:
- none
- pending
- approved
- dormant
- rejected
- revoked
description: Whether the account may create pitch projects, which are for agency and platform accounts (the account type, which the account owner or an account admin changes in Account Settings > Profile). none means the account is not an agency; approved access goes dormant while the account is below the Scale tier, on a trial, has a payment problem, is set to cancel or has an allowance of 0; revoked means our team turned it off. pending and rejected are no longer returned
responses:
Unauthorized:
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
code: ERR_MISSING_AUTH
message: missing_authorization
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