create_citation_check | 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 (`cited`, a citation on your registrable domain or one of its subdomains), whether your
brand is named in the answer (`mentioned`, which is NOT a citation), which of your pages are cited,
an excerpt of the answer, its sources, and the domains cited instead of yours.
**One answer, on one day.** This is a snapshot, not a lasting measure: AI answers change from one week
to the next, and between two calls. Run the test again to compare.
**Asynchronous, poll the result.** This call only starts the test and answers HTTP 202 with a
`checkId` and a `pollUrl`. Call `GET /api/v1/tools/citation-check?checkId=...` every 3 seconds
until `status` is `done` or `failed`; a test usually takes less than 2 minutes. MCP clients must
call the `get_citation_check` tool again until the status is terminal.
**Identical questions are reused for 24 hours.** The same question (case and spaces ignored) in
the same market, asked less than 24 hours ago, returns the engine answers already collected,
recomputed for your domain: HTTP 200 with `reused` true and `status` already `done`. Nothing is
paid for again, and your daily quota is given back.
**Domain.** Send a domain name or any URL of the site: it is reduced to its registrable domain
(`https://www.example.co.uk/blog/` becomes `example.co.uk`). IP addresses, local names and unknown
suffixes return 400 INVALID_DOMAIN.
**Tiers, per UTC day.**
- Without an API key, free anonymous tier: 1 test per day per IP address.
- Signed-in account, or API key of an account whose plan includes API access: 10 tests per day.
The API key of an account whose plan does NOT include API access does not authenticate, and the
call returns 401. Remove the `Authorization` header to use the free anonymous tier instead.
Quota headers: `X-RateLimit-Limit`, `X-RateLimit-Used`, `X-RateLimit-Remaining`,
`X-RateLimit-Reset` (Unix time of the next UTC midnight). `Retry-After` is set on 429 and 503.
A 502 or 503 answer gives the consumed quota back, and so does a 429 FREE_CAPACITY_REACHED
and a 200 reused answer; SERVICE_UNAVAILABLE consumes none.
**Request format.** Send the body as JSON with `Content-Type: application/json`: any other
content type returns 415. Without an `Authorization` header, a request sent by a web page of
another site (an `Origin` other than the SERPmantics app, or `Sec-Fetch-Site: cross-site`)
returns 403. Server-to-server calls send no `Origin` header and are not affected.
|
create_editorial_velocity | 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. Works with any CMS.
**What is counted.** Only pages typed as an article (JSON-LD Article, BlogPosting, NewsArticle and
similar types, or an `article:published_time` meta tag), dated by the publication date the site itself
shows (JSON-LD `datePublished`, then meta tags, then the first `<time>` element). Pages read without any
date are never counted, their number is returned as `method.undatedPages`. An article republished with a
new date counts as a publication.
**Asynchronous, poll the result.** This call only starts the analysis and answers HTTP 202 with an
`analysisId` and a `pollUrl`. Call `GET /api/v1/tools/editorial-velocity?analysisId=...` every 5 seconds
until `status` is `done` or `failed`; an analysis takes from 1 to 45 minutes depending on the size of the
site. MCP clients must call the `get_editorial_velocity` tool again until the status is terminal.
**Up to 1500 pages read.** Below that, every page of the sitemap modified in the window is read. Above it,
a random sample of 1500 pages is read, counts are extrapolated, `method.sampled` is true and
`publications.ci95` gives the 95 % confidence interval of the yearly total.
**Same domain, reused for 7 days.** An analysis of the same domain finished less than 7 days ago is
returned as is, and an analysis of the same domain still running is shared rather than started twice.
HTTP 200 with `reused` true when it is already done; nothing is read again, and your daily quota is given
back in both cases (`quotaReleased` true; false in the rare case where giving it back failed).
**Domain.** Send a host name or any URL of the site, it is reduced to its host (`https://www.example.com/blog/`
becomes `example.com`). Subdomains are kept, `blog.example.com` is not `example.com`. IP addresses, local
names and unknown suffixes return 400 INVALID_DOMAIN.
**Tiers, per UTC day.**
- Without an API key, free anonymous tier: 1 analysis per day per IP address.
- Signed-in account, or API key of an account whose plan includes API access: 3 analyses per day.
- Anti-loop ceiling, every tier: 50 analysis requests per day per account, or per IP address without one,
reused answers included, never given back except after SERVICE_BUSY. Beyond it, 429 RATE_LIMITED with
details.reason CREATE_ATTEMPTS_CEILING.
The API key of an account whose plan does NOT include API access does not authenticate, and the
call returns 401. Remove the `Authorization` header to use the free anonymous tier instead.
**Paid analysis beyond the free ones, 20 tokens, ONLY WITH THE USER'S EXPLICIT AGREEMENT.** When an
account has used its free analyses of the day, the call returns 429 RATE_LIMITED with
`details.paidOption` (`tokens`, the price, and `balance`, the token balance of the account, null when
unknown). So does the 429 FREE_CAPACITY_REACHED of an account: paid analyses do not count towards the
daily capacity shared by all accounts, and `paid` true on that refusal pays for the analysis instead. Never retry with `paid` true on your own: tell the user the price and their balance, and send
the same request again with `"paid": true` only after they agree. It then charges 20 tokens and starts
the analysis (`tokensCharged` in the answer). The tokens are given back when the analysis service
refuses the request, when the answer is reused (an analysis of the same domain less than 7 days old,
or already running: `tokensRefunded` true), and when the analysis fails (at the first read that sees
`failed`, or within the next hours if nobody reads it). With free analyses left, `paid` true uses a free
one and charges nothing. Without an account, `paid` true returns 401. A balance below the price returns
402 INSUFFICIENT_TOKENS and nothing is charged or started. A 500 TOKENS_NOT_CONSUMED means the outcome of
the debit could not be confirmed and nothing was started; if tokens were taken, they are given back
automatically within the next hours. Do not retry with `paid` true before telling the user.
Quota headers: `X-RateLimit-Limit`, `X-RateLimit-Used`, `X-RateLimit-Remaining`,
`X-RateLimit-Reset` (Unix time of the next UTC midnight). `Retry-After` is set on 429 and 503.
A 502 or 503 answer gives the consumed quota back, and so does a 429 FREE_CAPACITY_REACHED
and a reused answer; SERVICE_UNAVAILABLE consumes none.
**Request format.** Send the body as JSON with `Content-Type: application/json`: any other
content type returns 415. Without an `Authorization` header, a request sent by a web page of
another site (an `Origin` other than the SERPmantics app, or `Sec-Fetch-Site: cross-site`)
returns 403. Server-to-server calls send no `Origin` header and are not affected.
|
create_eeat | 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` (or `failed`).
**Note:** This endpoint uses tokens (check /api/v1/tokens-usage for the cost, might vary).
|
create_eeat_competitors | 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 endpoint charges `eeatCompetitorsTokensCostPerCompetitor`
(see /api/v1/tokens-usage) per competitor analyzed, up to 10 competitors.
Example: 10 competitors × 5 tokens = 50 tokens. 6 competitors × 5 tokens = 30 tokens.
The number of competitors corresponds to the deduplicated URLs in the guide's top-10 SERP
results (available via GET /api/v1/guide).
|
create_guides | 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 `source: "google"`.
Example payload: {"queries": ["best crm"], "lang": "en-us"}
1bis. Google AI Overview guide (1 credit per guide). Two modes, like AI engines:
`source: "google_ai_overview"` builds the guide from the TEXT of Google's AI answers
(AI Overview, completed with AI Mode answers) ; `source: "google_ai_overview_citations"`
builds it from the content of the web SOURCES those answers cite (recommended for GEO).
Same language/country parameters as a Google SERP guide, 1 credit per guide in both modes.
Example payload: {"queries": ["best crm"], "lang": "en-us", "source": "google_ai_overview_citations"}
2. LLM ANSWER guide (4 credits per guide): pass the engine name alone, e.g. `source: "chatgpt"`.
The guide is built from the answer text the AI generates for the query.
Example payload: {"queries": ["best crm"], "lang": "en-us", "source": "chatgpt"}
3. LLM CITATIONS guide (4 credits per guide) [RECOMMENDED AI mode]: pass the engine name with the `_citations` suffix, e.g. `source: "chatgpt_citations"`.
The guide is built from the content of the web pages the AI cites in its answer.
Example payload: {"queries": ["best crm"], "lang": "en-us", "source": "chatgpt_citations"}
Which AI mode to pick? For GEO (getting a page visible in AI answers), prefer `<engine>_citations`:
AI engines send traffic by CITING pages as sources, so the winning move is to look like the pages they cite.
The answer-text mode (`<engine>` alone) is mostly useful to analyze how the AI phrases its own answer.
When in doubt, pick `<engine>_citations`.
The same two modes exist for every AI engine (chatgpt, perplexity, claude, gemini, grok, mistral, deepseek).
To optimize the same page for several engines or modes (e.g. Google AND ChatGPT answers AND ChatGPT sources), create one guide per source value on the same query.
IMPORTANT, HOW TO READ THE RESPONSE OF THIS ENDPOINT, WHICH SPENDS CREDITS.
Queries listed in `guidesFailed` are PROVEN not to have produced a guide and their credit was
given back (unless the account has unlimited credits, where nothing was reserved): re-sending
them is free and correct. Queries listed in `guidesUnknown` have an UNDECIDABLE outcome and
their credit is deliberately KEPT, because the guide was most likely written: DO NOT re-send
them, you would pay for the same guide twice. Look them up in `GET /api/v1/guides` after a few
minutes instead, and contact support if nothing shows up.
Finally, a `200` is NOT a promise that every query produced a guide: compare `guides.length`
with the number of queries you sent, never read `success` alone, and never re-send a query
just because it is missing from `guides`. |
create_intent | 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).
|
create_internal_links | 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).
|
create_meta | 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).
|
create_outline | 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).
|
create_persona_brief | 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 metrics measured on the text, and a ready-to-paste writing
prompt for any AI writing tool (`brief.writingPrompt`, plus `brief.writingPromptCompact`
of at most 1500 characters).
**Asynchronous, poll the result.** This call only starts the job and answers HTTP 202 with a
`briefId` and a `pollUrl`. Call `GET /api/v1/tools/persona-brief?briefId=...` every 3 seconds
until `status` is `done` or `failed`. A brief takes about 80 seconds plus 5 seconds per page,
rounded up to the half minute: about 2 min for 3 pages, 2 min 30 s for 10 pages.
MCP clients must call the `get_persona_brief` tool again until the status is terminal.
**Identical requests are reused for 72 hours.** The same set of URLs, in any order, with the
same `outputLanguage` and the same `brandName`, returns the brief already computed instead of
computing it again: HTTP 200 with `reused` true, `status` already `done`, the original
`briefId` and `reusedCreatedAt`, the date of the brief it reuses. Nothing is created, and your
daily quota is given back, so a reused answer costs you nothing. The pages of a reused brief
are listed in the order of the original request, not in the order you just sent. Send
`force` true to skip the lookup and compute a new brief, which answers 202 and consumes quota.
**Addresses.** Duplicate URLs, compared once normalized, are read once. A private, local or
blocked address is not refused by this call: the brief is created, and that page ends with
`status` failed and `failureReason` BLOCKED_ADDRESS (the brief fails with NO_USABLE_PAGE when
no other page could be read).
**Tiers, per UTC day.** Every tier is capped at 10 URLs per brief since 21 September 2026.
- Without an API key, free anonymous tier: 3 briefs per day per IP address, 10 URLs per brief.
- Signed-in account on the web interface, plan without API access: 10 briefs per day, 10 URLs per brief.
- API key of an account whose plan includes API access, pro tier: 50 briefs per day, 10 URLs per brief.
The API key of an account whose plan does NOT include API access does not authenticate, and the
call returns 401. Remove the `Authorization` header to use the free anonymous tier instead.
Quota headers: `X-RateLimit-Limit`, `X-RateLimit-Used`, `X-RateLimit-Remaining`,
`X-RateLimit-Reset` (Unix time of the next UTC midnight). `Retry-After` is set on 429 and 503.
A 502 or 503 answer gives the consumed quota back, and so does a 429 FREE_CAPACITY_REACHED
and a 200 reused answer; SERVICE_UNAVAILABLE consumes none.
**Request format.** Send the body as JSON with `Content-Type: application/json`: any other
content type returns 415. Without an `Authorization` header, a request sent by a web page of
another site (an `Origin` other than the SERPmantics app, or `Sec-Fetch-Site: cross-site`)
returns 403. Server-to-server calls send no `Origin` header and are not affected.
|
create_score | 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 those parameters, which describes the REST API. What it changes in the response: with scoreProgressive=false, contentAnalysis.progressiveScores comes back empty ({}); with includeEmbedding=false, contentAnalysis.embeddingAnalysis is omitted from the response. Set a flag to true in your arguments to get its content back; any value you do pass is sent unchanged, including false. The whole response is handed to the model, and this is where most of its size goes, so it is opt-in on this channel: ask only for what you are going to read. |
delete_guide | 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. |
delete_guides | Delete multiple guides
Deletes multiple guides at once |
delete_intent | Delete generated intent analysis for a guide
Removes previously generated intent analysis for the given guide. |
delete_internal_links | Delete generated internal-links suggestions for a guide
Removes previously generated internal-links suggestions for the given guide. |
delete_meta | Delete generated meta for a guide
Removes previously generated meta titles/descriptions for the given guide. |
delete_outline | Delete generated outline for a guide
Removes previously generated outline data for the given guide. |
discover_persona_brief_pages | 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. The first URLs, as many as the URL limit of your tier, are flagged `suggested`:
send them in `urls` to `POST /api/v1/tools/persona-brief`.
Same tiers as the creation call, with their own daily counter per UTC day: 20 discoveries per
day per IP address without an API key, 50 for a signed-in account, 200 with the API key of an
account whose plan includes API access. A key whose plan does not include API access returns
401: remove the `Authorization` header to use the free anonymous tier.
Quota headers: `X-RateLimit-Limit`, `X-RateLimit-Used`, `X-RateLimit-Remaining`,
`X-RateLimit-Reset`. `Retry-After` is set on 429 and 503. A 400, 502 or 503 answer gives the
consumed quota back; SERVICE_UNAVAILABLE consumes none.
**Request format.** Send the body as JSON with `Content-Type: application/json`: any other
content type returns 415. Without an `Authorization` header, a request sent by a web page of
another site (an `Origin` other than the SERPmantics app, or `Sec-Fetch-Site: cross-site`)
returns 403. Server-to-server calls send no `Origin` header and are not affected.
|
get_aissistant_tokens | 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 for
historical reasons but the balance is shared across all AI features.
Do NOT confuse with guide-creation credits (see /api/v1/credits).
For a combined view (credits + tokens) prefer /api/v1/credits.
|
get_citation_check | 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.citedBy` engines cite your domain out
of `summary.enginesAnswered` engines that answered. When `status` is `failed`, `failureCode` says
why (NO_ENGINE_ANSWERED, TIMEOUT, INTERNAL).
Per engine: `cited` is true when a source of the answer is on your registrable domain or one of
its subdomains, and `citedUrls` lists those pages; `mentioned` is true when your brand name appears
in the answer text, which is NOT a citation. `status` no_answer means the engine showed no answer
for this question (Google often shows no AI Overview), which is not a failure.
No quota is consumed. The `checkId` is random: whoever holds it can read the test, which is what
makes share links work. Tests expire after 30 days. Reads that are not attributed to an account are
capped at 1000 per IP address and per UTC day, far above any legitimate polling: crossing it returns
429 READ_RATE_LIMITED with `Retry-After`.
|
get_credit_ledger | 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 arbitraire (paramètre `at`) et un contrôle de cohérence (solde == dernier balanceAfter == somme des deltas). Réservé aux administrateurs. Lecture seule.
|
get_credits | 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 guide creation (`hasUnlimitedCredits: true`).
- **AI tokens** (`tokens`): pool consumed by every AI feature (meta,
outline, intent, internal-links, EEAT, EEAT competitors…).
Each feature has its own cost — call `/api/v1/tokens-usage` to get
the per-feature pricing.
Do not confuse the two: running out of `credits` blocks new guides;
running out of `tokens` blocks AI features inside existing guides.
|
get_editorial_velocity | 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 `pagesTotal`. When `status` is `failed`, `failureCode` says why
(BLOCKED, the site refuses to be read; NO_SITEMAP; NO_DATES, pages read but none dated; UNREACHABLE;
TIMEOUT; INTERNAL) and `publications` is null. A failed analysis is never a zero.
When `status` is `done`, `publications.total` articles were published in `window` (12 full months, UTC),
`perMonth` is total / 12 and `perWeek` total / 52.14. `ci95` is only meaningful when the analysis was sampled
(`method.sampled`). A total of 0 is only returned when it is proven (the sitemap dates at least 90 % of
its URLs and none was modified in the window). `updates` counts the articles updated more than one day
after their publication, or says why this is not measurable (DYNAMIC_DATES, dates generated when the page
is shown; SOURCES_DISAGREE, page and sitemap dates contradict each other; TOO_FEW_DATES).
When a failed analysis had been paid with tokens, `billing` says what became of them (`tokens`, the amount
charged for it, `refunded`, true once they were given back to the account that paid). It names no account,
and is absent for a free analysis or while the analysis is not failed.
No quota is consumed. The `analysisId` is random, whoever holds it can read the analysis, which is what
makes share links work. Analyses expire after 30 days. Reads that are not attributed to an account are
capped at 1000 per IP address and per UTC day, far above any legitimate polling, and crossing it returns
429 READ_RATE_LIMITED with `Retry-After`.
|
get_eeat | 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 guide, omit it to fetch the latest one.
An `eeatId` that does not belong to `guideId` is answered with `404`, never with the
other account's data.
Poll this endpoint until `status` is `done` (results available) or `failed`.
|
get_eeat_competitors | 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`.
|
get_guide | 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), it returns 200 with success=false, status=failed, a human-readable French error message, creationFailed=true, refunded (whether the consumed credits were automatically given back) and guide.progressStatus (raw reason, message, terminal, kind, and failureFacts when the figures are known, which is only possible for sources whose web pages we read, that is a search engine or a `_CITATIONS` source, never a source in answer mode). Stop polling in that case. |
get_guides | 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 matches:
special characters in the value are interpreted as regex syntax, and an invalid
regex returns no result at all. (`status` is different: a known status is matched
exactly, any other value falls back to a regex.) Always compare the returned
`query` and `source` yourself, and fall back to an unfiltered paginated scan
before concluding that nothing exists;
- `totalCount` does NOT take `query` nor `group` into account (known limitation:
both are applied as application-level regexes that the count query does not
know, so it returns 0 as soon as either is used, alone or combined with
`status`). Filtering on `status` alone does give a correct `totalCount`, since
it is a real stored field. For an existence check, trust the `guides` actually
returned; `totalCount` is only reliable for paginating a listing filtered by
`status` alone, or not filtered at all.
An empty result is returned as a 404 with `success: false` and
`error: "No guides returned"`, not as an empty list. |
get_intent | Get search intent analysis for a guide
Retrieves existing intent analysis results for a guide |
get_internal_links | Get internal linking suggestions for a guide
Retrieves existing internal linking suggestions for a guide |
get_meta | Get generated meta titles and descriptions for a guide
Retrieves generated SEO meta titles and descriptions for a guide |
get_outline | Get generated page structure for a guide
Retrieves the generated page structure (flat heading list) for a guide. |
get_persona_brief | 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` is `done`, `brief` holds the structured brief,
`brief.writingPrompt` the ready-to-paste prompt and `markdown` the full document. When `status`
is `failed`, `failureReason` says why (NO_USABLE_PAGE, LLM_UNAVAILABLE, TIMEOUT, INTERNAL).
A page with a `failureReason` did not contribute to the brief. ANALYSIS_FAILED is the only one
on a page that was read: it keeps its `title` and `wordCount`, stays counted in
`progress.pagesFetched` and never enters `progress.pagesAnalyzed` nor `metrics`.
No quota is consumed. The `briefId` is random: whoever holds it can read the brief, which is
what makes share links work. Briefs expire after 90 days. Reads that are not attributed to an
account are subject to three anti-abuse counters, all per IP address and per UTC day:
the total number of requests, the reads of a single brief, and the number of different
briefs read. All three are far above any legitimate polling, including the busiest paid
account: crossing any of them returns 429 READ_RATE_LIMITED with `Retry-After`. Once the
cost ceiling is reached, further requests keep being refused until it resets, whether or
not they carry a valid briefId.
|
get_tokens_usage | 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 analyzed (deduplicated URLs in the guide's top-10 SERP, capped at 10).
|
get_usage | 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 subscription. Does not consume credits. `enforced` tells whether the quota is enforced on the current window: when `true`, a guide creation through the API or MCP that would exceed the limit is refused with HTTP 402 (see `POST /api/v1/guides`). When `false` (any plan other than Conqueror, a billing cycle that started before the refusal went live, or a Conqueror subscription in payment recovery, counted over the last 30 days with no reset date), the figures are informational only and nothing is refused on quota grounds. `upgrade_url` is the absolute link to the "Priority and API volume" add-on (the same as `details.upgrade_url` of the 402), absent when the add-on cannot raise the quota (already at its highest volume, or account without a subscription to add it to).
|
update_guide | Update a guide
Updates editable fields of a specific guide (group, status, share state, linked URL, meta, hidden expressions). Only owners may update. |
protogrid