Docs menu

ReportsGET$0.30

/v1/citability-report

On-page audit + AI visibility across all engines + top cited pages, in one call. $0.30 instead of $0.43 separately.

One request answers three questions: can AI read this site, who cites it today for the prompt you give, and which pages already work. The three sections are the exact payloads of /v1/onpage-audit (run on the homepage), /v1/ai-visibility and /v1/top-cited-pages, so anything that parses those parses this.

The prompt is required. Citable never auto-writes the question — it is the one decision that should be yours.

Parameters#

NameDescription
domainrequiredhostname to report on, e.g. example.com
promptrequiredthe buyer question to ask the engines (3–400 chars)
limitoptionaltop cited pages to include, 1–25 (default 10)

Request#

Plain GET. Without a payment header the response is a 402 carrying the price; an x402 client pays and retries on its own — see the quickstart.

request
GET https://citable.run/v1/citability-report?domain=citable.run&prompt=best+pay-per-call+seo+api

Response#

200 with the JSON below (trimmed) and the settlement signature in the PAYMENT-RESPONSE header. Every paid response also carries price and cluster.

200 · application/json
{
  "domain": "citable.run",
  "prompt": "best pay-per-call seo api",
  "onpage": { "url": "https://citable.run/", "score": 92, "summary": { "pass": 15, "warn": 5, "fail": 0 }, "checks": [ "…" ], "topFixes": [ "…" ] },
  "visibility": { "mentioned": false, "engines": [ "…" ], "summary": { "engines_run": 4, "engines_ok": 4, "engines_citing": 0 } },
  "topCitedPages": { "pages": [ "…" ], "totalCitedPages": 0, "domainTotals": { "mentions": 0, "aiSearchVolume": 0 } },
  "price": "$0.30",
  "cluster": "mainnet"
}

Errors#

Any non-200 cancels the payment — errors are free.

StatusCodeWhen
400invalid_domaindomain is not a hostname
400invalid_promptprompt missing, under 3 or over 400 chars
502unreachablethe homepage could not be fetched — nothing is charged
502upstream_failedthe data source did not answer — nothing is charged
503not_configuredthis deployment has no credentials for the source — nothing is charged

MCP tool#

The same call from Claude, Codex or Cursor once citable-mcp is installed. Arguments mirror the parameters above.

mcp
citable_citability_report(domain, prompt, limit?)   $0.30

Source & latency#

Data sourceTypical latency
The three endpoints above, run together~15–20 s

Note

Any component failing is a 5xx for the whole bundle — a partial report is never charged.

Pairs with#