v1
Free tools

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/api/v1/tools/citation-check

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/tools/citation-check
  • Auth: one of:
    • none
    • HTTP bearer

Query parameters

checkIdstring required

The checkId returned by the creation call (22 characters).

Response

The test, in progress or finished.

successboolean

Example response

{
  "success": true
}

Changes

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