Get the current user's available AI tokens
Returns the number of AI tokens available to the authenticated user.
These tokens fund EVERY AI feature in SERPmantics — meta, outline,
intent, internal-links, EEAT, EEAT competitors, score, AND the
AISSistant prompts. The endpoint lives under /aissistant
Get user balance (guide credits + AI tokens)
Returns the authenticated user's full balance.
SERPmantics has TWO distinct currencies:
- **credits** (`credits`): how many NEW GUIDES the user can still create.
Consumed once per guide creation. `"unlimited"` if the user's plan
grants unlimited gu
Get E-E-A-T analysis results for a guide's competitors
Retrieves the E-E-A-T analysis results for the top competitors of a guide.
Poll this endpoint until `pending` is `0` to know when the full analysis is complete.
Individual competitor results are available as soon as their `status` is `done`.
Start an E-E-A-T analysis on a guide's top SERP competitors
Starts an asynchronous E-E-A-T analysis on the top competitors of the guide's SERP.
Each competitor is fetched and scored individually. Use GET /api/v1/eeat-competitors to
poll for results until `pending` reaches `0`.
**Token cost:** This
Get E-E-A-T analysis results
Retrieves the result of an E-E-A-T analysis.
`guideId` is **always required**: access is granted on the guide, so a request without it
is answered with `404 Guide not found`. `eeatId` is an optional filter on top of it: pass it
to fetch one specific analysis of that gu
Start an E-E-A-T analysis on a guide content
Starts an asynchronous E-E-A-T (Experience, Expertise, Authoritativeness, Trustworthiness) analysis
on the HTML content provided for a given guide. The analysis runs in the background — use
GET /api/v1/eeat to poll for results until `status` is `done` (o
Generate search intent analysis for a guide
Analyzes search intent for a guide and optionally analyzes provided content against that intent.
**Note:** This endpoint uses tokens (check /api/v1/tokens-usage for the cost, might vary).
Generate internal linking suggestions for a guide
Analyzes a guide and generates internal linking suggestions based on content analysis.
**Note:** This endpoint uses tokens (check /api/v1/tokens-usage for the cost, might vary).
Generate SEO meta titles and descriptions for a guide
Generates optimized meta titles and descriptions based on guide content analysis.
**Note:** This endpoint uses tokens (check /api/v1/tokens-usage for the cost, might vary).
Generate content outline for a guide
Generates a content outline based on SERP analysis for a guide.
**Note:** This endpoint uses tokens (check /api/v1/tokens-usage for the cost, might vary).
Get API token usage costs for different endpoints
Returns the number of tokens required for each API endpoint operation.
Note: `eeatCompetitorsTokensCostPerCompetitor` is a **per-competitor** cost.
The total cost of POST /api/v1/eeat-competitors equals this value × the number of
competitors analyz
Read an AI citation test, poll until it is done
Returns the test started by `POST /api/v1/tools/citation-check`. While `status` is `pending` or
`running`, call again every 3 seconds: each engine fills in as soon as it has answered. When
`status` is `done`, at least one engine answered; `summary.cit
Test whether ChatGPT, Perplexity and Google AI Overview cite a website for one question (free tool)
Asks one question to three AI answer engines (ChatGPT with web search, Perplexity, Google AI
Overview) in the chosen market, and reports for each engine whether your domain is cited as a
source (`cit
Read a comparison of editorial velocities, poll until it is done
Returns the comparison started by `POST /api/v1/tools/editorial-velocity/comparisons`. While `status` is
`pending` or `running`, call again every 15 seconds. Each site has its own `state` (queued, running, done,
failed); its numbers a
Compare the editorial velocity of competitors, paid in tokens (account only)
Measures how many articles each site publishes per month, for a list of sites or for the sites ranking
in the Google top 10 of a keyword, then returns the median of the competitors and a recommendation for
your own site. E
Read an editorial velocity analysis, poll until it is done
Returns the analysis started by `POST /api/v1/tools/editorial-velocity`. While `status` is `pending` or
`running`, call again every 5 seconds; `progress` gives the current stage (robots, sitemap, pages,
summary) and `pagesRead` out of `page
Measure how many articles a website publishes per month and per week (free tool)
Reads the sitemap of one website and the date shown on each of its pages, then counts the
articles published over the last 12 full months (UTC), per month, per section, per language,
and how many articles were updated.
Find the representative pages of a website from its sitemaps, before generating a persona brief (free tool)
Reads the sitemaps of a website (declared in robots.txt, otherwise /sitemap.xml,
/sitemap_index.xml and /wp-sitemap.xml) and returns up to 200 URLs of the same host, editorial
pages first. Th
Read an AI persona and brand voice brief, poll until it is done
Returns the brief started by `POST /api/v1/tools/persona-brief`. While `status` is `pending`,
`fetching`, `analyzing` or `synthesizing`, call again every 3 seconds: `progress` and `pages`
show what has been read so far. When `status` i
Generate an AI persona and brand voice brief from the pages of a website (free tool)
Reads public pages of a website and produces an editorial persona and writing style brief:
who writes, for whom, tone on 6 axes, vocabulary, structure, do and don't lists, verified
quotes from the pages, style metr
Get current API usage and quota status
Returns the current period's API guide usage (guides created through the API or MCP), quota limit, remaining count and the renewal date. Aligned on the Stripe subscription billing cycle, or on the calendar month (UTC) for a Conqueror account without a subscrip
Grand-livre crédits d'un compte (admin)
Timeline complète et immuable des mouvements de crédits d'un utilisateur (octrois, consommations, refunds, resets, ajustements admin), avec libellés FR en clair, delta signé, solde après, source, auteur et référence. Inclut le solde reconstruit à une date arb
Get data for a specific guide
Retrieves details of a specific guide. While the guide is being created, the endpoint returns 202 (poll again later). If the creation failed permanently (explicit terminal flag, or a failure older than 15 minutes with no retry left, see progressStatus.terminalInferred)
Delete a guide
Deletes a specific guide. Deliberately NOT blocked by the 180-day expiry: an expired guide can no longer be read, but it can always be deleted, so that you can still clean up your account.
List user's guides
Returns a list of guides for the authenticated user.
Use `query` to check whether a guide already exists before creating one
(creating a duplicate costs credits). Beware of two behaviours of this endpoint:
- `query` and `group` are case-insensitive REGULAR EXPRESSIONS, not exact
Create new guides
Create one or more new guides based on provided queries.
Each guide targets exactly ONE engine and ONE analysis mode, chosen with the optional `source` field (default `google`).
How to request each guide type:
1. Google SERP guide (1 credit per guide): omit `source`, or pass `sou
Analyze content optimization score
Analyzes the optimization score of the provided content for a specific guide
MCP channel defaults: this tool sends scoreProgressive=false, includeEmbedding=false when you leave them out. That is specific to this channel and overrides the default documented on tho
FAQ
Questions
How do I install Serpmantics?
Copy the http config for Cursor, Claude Desktop, Claude Code, or VS Code on this page. It uses the publisher's install, not a PlugMCP proxy.
Does Serpmantics need an API key?
No required environment variable is listed on this record.
What transport does Serpmantics use?
Serpmantics is reached over HTTP.
When was Serpmantics last checked?
Last checked 2026-11-08. French-first SEO: semantic content guides, scoring, E-E-A-T audits for Google, ChatGPT & Claude.
