API · v1

Embed AI visibility scoring in your platform.

REST. JSON. One header. $0.50 per audit. 90-day integration, no setup fee.

Who this is for.

Trade PM software (ServiceTitan, HousecallPro, Jobber, FieldEdge, Workiz). Multi-location franchisors. Insurance carriers underwriting trades. Manufacturers running dealer networks. If your users would benefit from an AI visibility score next to a customer record, this is the API.

1. Get a key.

Email partnerships@mentionedinai.com with your use case. Demo key for testing typically issued within 24h.

2. Authenticate.

X-API-Key: mtnd_live_xxxxxxxxxxxx

3. Run an audit.

POST /api/v1/oem/audit — $0.50, returns score + competitors + 7-step fix.

curl -X POST https://mentionedinai.com/api/v1/oem/audit \
  -H "X-API-Key: mtnd_live_xxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"business":"Apex HVAC","city":"Providence","state":"RI","trade":"hvac"}'

Response (200):

{
  "business_id": "abc123XYZ",
  "score": 68,
  "bracket": "Visible",
  "citation_rate_pct": 50,
  "per_engine": {
    "openai":     {"queries": 3, "citations": 1, "competitor_wins": 2},
    "perplexity": {"queries": 3, "citations": 2, "competitor_wins": 1}
  },
  "top_competitors": [{"name":"Coastal Air Co","mentions":2}],
  "playbook": [{"n":1,"title":"Add HVACBusiness schema","why":"...","action":"..."}],
  "share_url": "https://mentionedinai.com/r/abc123XYZ",
  "billing": {"usage_units": 1, "usage_type": "audit"}
}

4. Cache lookups are free.

GET /api/v1/oem/score/<token> — pulls the cached report. No charge. Use this to refresh your UI without re-running.

Insurance / enterprise endpoints.

POST /api/v1/risk-signal/lookup — normalized 0–1 risk signal. $0.10 per call. Tier insurance or enterprise required.

Health.

GET /api/v1/health — no auth, returns 200 if alive. Use it for uptime monitoring.

The boring stuff.

CodeMeans
401Key missing or wrong
403Your tier can’t hit this endpoint
400Missing fields. Check business/city/state/trade
502Upstream engine down. Retry with jitter
500Our problem. Email us

Rate limit: 60 req/min default. Higher on enterprise.

Versioned via URL prefix. v2 will be announced 90+ days before any breaking change.

Status: /api/v1/health · Partnerships: partnerships@mentionedinai.com · Run an audit yourself