{"info":{"version":"1.0.0","description":"Run a free AI-search visibility scan on any website and read back a depth-gated teaser: an AI-visibility score, its confidence interval, the single biggest gap, and a branded report URL. **Depth-gating contract:** the public API returns the score + top gap + report URL only — never the full report. Share of voice across each AI engine and every recommendation unlock with a free account on the web. Public + no-auth, with built-in budget caps and rate limits.","title":"Collimer Free-Scan API","contact":{"name":"Collimer","url":"https://app.collimer.com"},"license":{"name":"Proprietary"}},"components":{"schemas":{"Error":{"type":"object","properties":{"error":{"type":"string"},"detail":{"type":"string"},"retry_after":{"type":"integer","description":"Seconds (on 429)."}}},"ScanRequest":{"type":"object","required":["url"],"properties":{"source":{"type":"string","enum":["web","api","mcp","agent"],"description":"Acquisition channel. Agents should send \"mcp\" or \"agent\"."},"category":{"type":"string","description":"Optional business-category hint."},"email":{"type":"string","description":"Optional — receive the report + speed account claim."},"url":{"type":"string","description":"The site to scan, e.g. https://example.com."}}},"ScanStart":{"type":"object","properties":{"status":{"type":"string","enum":["queued","running","complete"]},"cached":{"type":"boolean"},"scan_token":{"type":"string"},"report_url":{"type":"string"},"poll_url":{"type":"string"}}},"ScanTeaser":{"type":"object","description":"The depth-gated teaser. The full report (share of voice + all recommendations) is NOT included — it unlocks via cta_url with a free account.","properties":{"status":{"type":"string","enum":["complete"]},"url":{"type":"string"},"scan_token":{"type":"string"},"brand":{"type":"string"},"score":{"type":"number","description":"AI-search visibility score, 0–100."},"cta_url":{"type":"string","description":"Sign-up link that unlocks the full report."},"confidence_interval":{"type":["object","null"],"description":"Nullable (absent for CRO/flat-score results).","properties":{"upper":{"type":"integer"},"lower":{"type":"integer"},"plus_minus":{"type":"integer"}}},"full_report":{"type":"object","properties":{"locked":{"type":"boolean"},"recommendations_total":{"type":"integer"},"unlock_url":{"type":"string"}}},"report_url":{"type":"string","description":"Branded shareable scorecard."},"top_gap":{"type":["object","null"],"properties":{"title":{"type":"string"},"impact":{"description":"Structured impact (affects/estimate/timeframe)."}}}}}}},"paths":{"/api/v1/scan":{"post":{"description":"Kicks off a scan for a URL (or returns a recent cached result for the same domain). Poll the returned scan_token until complete.","summary":"Start a free AI-visibility scan","operationId":"createScan","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanRequest"}}}},"responses":{"201":{"description":"Scan started (or cached).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanStart"}}}},"422":{"description":"Invalid url or email.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited — see Retry-After header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Free scans temporarily paused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/v1/scan/{token}":{"get":{"parameters":[{"in":"path","name":"token","description":"The scan_token from createScan.","required":true,"schema":{"type":"string"}}],"summary":"Poll a scan / fetch the teaser","operationId":"getScan","responses":{"200":{"description":"Complete — depth-gated teaser.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanTeaser"}}}},"202":{"description":"Queued or running — poll again.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScanStart"}}}},"404":{"description":"Unknown scan token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"openapi":"3.1.0","servers":[{"url":"https://app.collimer.com"}]}