API reference

Public REST API for LLM SEO + AI bot analytics. Used by our WordPress plugin, Shopify app, CLI (aivisible), and MCP server. All endpoints require an API key as Authorization: Bearer llmstxt_sk_….

Get an API key WordPress plugin Shopify app

Quickstart

# Look up your site by domain
curl https://usellmstxt.com/api/v1/sites?domain=example.com \
  -H "Authorization: Bearer \$USELLMSTXT_API_KEY"

# Pull last 30 days of bot analytics
curl https://usellmstxt.com/api/v1/sites/\$SITE_ID/analytics?range=30d \
  -H "Authorization: Bearer \$USELLMSTXT_API_KEY"

# Add a tracked prompt
curl -X POST https://usellmstxt.com/api/v1/sites/\$SITE_ID/prompts \
  -H "Authorization: Bearer \$USELLMSTXT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text": "best LLM SEO tools for SaaS"}'

Free tier has no API access. Starter and above unlock read scope; Pro and above unlock full.

Endpoints

Sites

GET/api/v1/sites
List sites. ?domain=<host> for single-site lookup.
read
GET/api/v1/sites/:siteId
Get a site by id.
read

Bot analytics

GET/api/v1/sites/:siteId/analytics
Bot traffic — KPI, time-series, breakdown. ?range=7d|30d|90d.
read
GET/api/v1/sites/:siteId/diagnostics
Per-request bot diagnostic feed.
read
GET/api/v1/sites/:siteId/diagnostics/summary
Aggregate diagnostics summary.
read
POST/api/v1/sites/:siteId/diagnostics/replay
Re-run a diagnostic against the live URL.
full

Prompts

GET/api/v1/sites/:siteId/prompts
List tracked prompts (paginated).
read
POST/api/v1/sites/:siteId/prompts
Create a prompt.
full
PUT/api/v1/sites/:siteId/prompts/:promptId
Update prompt fields.
full
DELETE/api/v1/sites/:siteId/prompts/:promptId
Soft-delete (set isActive=false).
full
POST/api/v1/sites/:siteId/prompts/suggestions
Haiku auto-seed: generate prompt suggestions from your site.
full

Competitors

GET/api/v1/sites/:siteId/competitors
List tracked competitor domains.
read
POST/api/v1/sites/:siteId/competitors
Add a competitor domain.
full
DELETE/api/v1/sites/:siteId/competitors/:id
Stop tracking a competitor.
full
GET/api/v1/sites/:siteId/competitors/discover
Auto-discover competitors from citation data.
read

Citations

GET/api/v1/sites/:siteId/citations
Citation event feed. Filter by provider, brand, competitor, hallucinated.
read
GET/api/v1/sites/:siteId/citations/share-of-voice
Brand vs competitor share over time.
read
POST/api/v1/sites/:siteId/citations/probe
Trigger an on-demand probe run.
full
GET/api/v1/sites/:siteId/citations/gaps
Prompts where competitors are cited but you aren't.
read
GET/api/v1/sites/:siteId/citations/gaps/:gapId/brief
Generate a Haiku content brief to close a gap.
full

Surfaceability

GET/api/v1/sites/:siteId/pages
List crawled pages with surfaceability scores.
read
GET/api/v1/sites/:siteId/pages/:pageId
Page detail + 12 factors + schema markup.
read
POST/api/v1/sites/:siteId/pages/:pageId/audit
Trigger on-demand re-audit of a page.
full
GET/api/v1/sites/:siteId/recommendations
Filterable recommendation queue.
read
POST/api/v1/sites/:siteId/recommendations/:id/fix
Generate diff preview for an auto-fixable recommendation.
full
PUT/api/v1/sites/:siteId/recommendations/:id/fix
Apply the auto-fix.
full
GET/api/v1/sites/:siteId/recommendations/:id/patch.patch
Download unified diff.
full

AI referrer beacon

POST/api/v1/beacon/ai-referrer
Beacon endpoint — call from the bundled beacon.js.
read
POST/api/v1/beacon/conversion
Tie a conversion to the most recent referrer session.
read
GET/api/v1/sites/:siteId/referrers
Referrer feed (paginated, filterable).
read
GET/api/v1/sites/:siteId/referrers/funnel
Revenue per source × prompt.
read