v1
Usage

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/api/v1/credits

Request

  • Base URL: https://app.serpmantics.com (the document declares no server; this is the origin it was published from)
  • URL: https://app.serpmantics.com/api/v1/credits
  • Auth: HTTP bearer

Response

Successful response with user balance

successboolean
hasUnlimitedCreditsboolean

True if the user's plan grants unlimited guide creation

tokensnumber

Remaining AI tokens (used by meta, outline, intent, internal-links, EEAT)

Example response

{
  "success": true,
  "tokens": 1234
}

Changes

No recorded changes to this operation across all 2 revisions of this API.