io.github.AmauryDvl/serpmantics

Tools

• 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).

  shallow
• 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).

  shallow
• 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.

  shallow
• 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).

  shallow
• 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).

  shallow
• 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).

  shallow
• 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).

  shallow
• create_score

  Analyze content optimization score Analyzes the optimization score of the provided content for a specific guide

  shallow
• delete_guide

  Delete a guide Deletes a specific guide

  shallow
• delete_guides

  Delete multiple guides Deletes multiple guides at once

  shallow
• delete_intent

  Delete generated intent analysis for a guide Removes previously generated intent analysis for the given guide.

  shallow
• delete_internal_links

  Delete generated internal-links suggestions for a guide Removes previously generated internal-links suggestions for the given guide.

  shallow
• delete_meta

  Delete generated meta for a guide Removes previously generated meta titles/descriptions for the given guide.

  shallow
• delete_outline

  Delete generated outline for a guide Removes previously generated outline data for the given guide.

  shallow
• 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.

  shallow
• 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.

  shallow
• 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.

  shallow
• get_eeat

  Get E-E-A-T analysis results Retrieves the result of an E-E-A-T analysis. Either pass `eeatId` (returned by POST /api/v1/eeat) to fetch a specific analysis, or pass `guideId` to fetch the latest analysis for that guide. Poll this endpoint until `status` is `done` (results available) or `failed`.

  shallow
• 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`.

  shallow
• 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). Stop polling in that case.

  shallow
• get_guides

  List user's guides Returns a list of guides for the authenticated user

  shallow
• get_intent

  Get search intent analysis for a guide Retrieves existing intent analysis results for a guide

  shallow
• get_internal_links

  Get internal linking suggestions for a guide Retrieves existing internal linking suggestions for a guide

  shallow
• get_meta

  Get generated meta titles and descriptions for a guide Retrieves generated SEO meta titles and descriptions for a guide

  shallow
• get_outline

  Get generated page structure for a guide Retrieves the generated page structure (flat heading list) for a guide.

  shallow
• 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).

  shallow
• get_usage

  Get current API usage and quota status Returns the current period's API guide usage, quota limit, remaining count and the renewal date. Aligned on the Stripe subscription billing cycle. Does not consume credits.

  shallow
• 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.

  shallow

Embed this server’s score

Tool count and median score across every tool in this server’s corpus — honest in a way a single cherry-picked tool’s badge wouldn’t be.

[![Vouch score](https://vouch.tools/api/servers/e5d85ba0-e544-4742-b08a-941548b79a16/badge.svg)](https://vouch.tools/servers/e5d85ba0-e544-4742-b08a-941548b79a16)