GeoScore Docs
OpenAPI

GeoScore 2.4.5

From audit to a verifiable repair

Use the factual audit first, then add dated search or API observations when you need them. Evidence Map, monitoring, and custom-model output never change the factual score.

First audit

Site mode samples up to five representative HTML pages. URL mode checks one target page and may read the homepage for context. Start with site mode, confirm the site profile, and repair critical or major failures before low-impact items.

  1. Enter a public domain or complete page URL
  2. Choose site or URL mode
  3. Review the site archetype, evidence coverage, confidence, and top three actions
  4. Open detailed checks only when you need the raw evidence
Scoring ruleOnly known and applicable pass/fail checks enter the weighted score. Unknown, error, and not-applicable states do not become zero.

Evidence Map and API answers

Evidence Map creates a dated query plan, records observed sources, and can request one answer snapshot from a hosted or custom API. The latest answer appears at the top with its query, model, status, time, latency, answer text, and citations.

These snapshots describe an API response at a point in time. They are not proof that ChatGPT, Perplexity, Gemini, or Google AI Overview cited the site in a consumer interface.

Monitoring project and management token

Creating a project returns a project ID and a management token. The token authorizes project reads, query changes, runs, history, rotation, and deletion. GeoScore stores only a peppered hash and cannot recover the original token.

  • Copy it immediately after project creation
  • Saving it on this device is explicit and optional
  • Use “Connect existing project” with the project ID and token on another device
  • Rotate it if it was exposed; the old token stops working immediately
Load a project
curl https://geo-api.vimalinx.com/api/monitor-projects/PROJECT_ID \
  -H "X-Project-Token: MANAGEMENT_TOKEN"

Custom API and automatic /v1

Paste the provider root such as https://api.example.com. GeoScore automatically adds /v1. If you paste /models or /chat/completions, it returns to the matching API root before sending the request.

Use “Fetch models” to load a bounded model list or type a model ID manually. The API key and Base URL are cleared after the request and are not stored, placed in the URL, or included in exports. The selected model ID, answer, and citations may be retained as evidence.

Run monitoring once with your API
curl -X POST https://geo-api.vimalinx.com/api/monitor-projects/PROJECT_ID/byok-runs \
  -H "Content-Type: application/json" \
  -H "X-Project-Token: MANAGEMENT_TOKEN" \
  -H "X-API-Key: REQUEST_SCOPED_API_KEY" \
  -d '{"api_base_url":"https://api.example.com","api_model":"model-id"}'

Email verification and historical snapshots

An optional email address receives a verification link. Alerts begin only after verification and only for comparable weekly score changes. A new score version, a first baseline, or insufficient evidence suppresses change alerts.

The completed run is stored before delivery is attempted. A mail-provider failure cannot erase the audit snapshot, and eligible failed alerts can be retried with the same run-scoped identity.

Markdown repair report

The one-click Markdown download is deterministic and does not require an AI call. It includes the site profile, sampled pages, score caps, every failed check, unknown and error evidence, repair groups, Evidence Map, API answer snapshots, monitoring history, limitations, and verification steps.

The same file ends with two provider-neutral briefs. The content AI brief contains only applicable failed content checks and requests evidence-bound candidate edits. The developer AI brief contains metadata, schema, crawling, performance, and other code or configuration work. GeoScore does not generate a full replacement article or publish changes.

Content responsibility is checked only on article pages. A personal blog may use a trusted site-level Person, while an editorial or news article may identify a truthful author or responsible publisher. Non-article pages are not told to add an author merely for scoring.

Keys and Base URLs are excluded from the report. GeoScore never modifies or publishes the audited website.

Error codes, free limits, and privacy

Code or stateMeaningAction
CUSTOM_API_CONFIG_INCOMPLETEKey, Base URL, or model is missingFill all three fields
401 / 403Project or upstream API authentication failedCheck or rotate the relevant token
429GeoScore or an upstream provider reached a limitWait for the retry window
502 / 503Optional provider or service unavailableRetry when marked retryable; factual checks remain separate
partialSome evidence completed and some failedUse the available evidence and inspect the failed source

Runtime limits are published by /api/meta. GeoScore accepts public targets only. Request-scoped keys are sent in headers, never in query strings.

Search Gateway and MCP

GeoScore uses Search Gateway as an optional evidence source for query fan-out, search snapshots, and bounded answer snapshots. Search results are evidence, not simulated consumer citations.

For exact GeoScore requests and response schemas, use the OpenAPI document.