68 endpoints across 11 resource groups. Bearer API key auth, JSON request and response bodies, one stable base URL. Every plan including Free ships with API access.
Every request carries your API key as a bearer token. Keys are scoped to your organization and can be revoked at any time.
Authorization: Bearer fba_your_key_hereCreate and revoke keys in API keys. A missing or invalid key returns 401.
Quota is metered per organization per billing month. Every response returns X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset. Exceeding quota returns 429 with code RATE_LIMIT_EXCEEDED.
| Plan | Calls / month |
|---|---|
| Free | 100 |
| Starter | 500 |
| Pro | 2,500 |
| Business | 15,000 |
| Agency | 50,000 |
Failures use a single envelope. Tier-gated errors also include upgrade_url.
{
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid input",
"details": { }
}
}400 validation or brand resolution401 missing or invalid API key403 plan does not allow this action429 rate limit exceededMost endpoints accept an optional brand_id query parameter. On a workspace with exactly one active brand you can omit it and the server resolves the brand for you. On a multi-brand workspace, omitting it returns 400 BRAND_REQUIRED with the full brand list in error.details.brands, so a client can recover without a second lookup.
Current visibility scores, competitor rankings, share of voice
/visibilityCurrent visibility scorePer-platform visibility score across ChatGPT, Google AIO, Perplexity, Claude, Gemini, Copilot.
/competitorsCompetitor comparisonRanked comparison versus tracked competitors with score deltas.
/share-of-voiceShare of AI VoiceAI mention rate plus competitive share of voice for the selected time period.
/content-gapsContent gaps (deprecated)DEPRECATED. Use GET /prompts/gaps (Competitor Gaps) instead. This endpoint still responds but is no longer maintained. Queries where competitors appear in AI results but your brand does not.
/prompts/gapsCompetitor gapsPer-prompt competitor gap analysis ranked by an opportunity score (0-100, from absence weighted 0.65 + competitor dominance 0.35). Returns a deterministic hero insight (no LLM), a stat summary (prompts you are absent on, weak-source count, top rival, untracked rivals), and per-row competitor leaderboards with a "why you're losing" explanation on the top rows. Materialized at scan completion. Requires a paid plan (Starter and up; Free is locked).
/trendsHistorical visibility trendScore points over time for charting.
/topic-authorityTopic authority mapKeyword clusters with authority scores. Requires Pro tier or higher.
/coveragePlatform coverageWhich AI platforms currently have data for the selected brand.
/competitor-scoresCompetitor scoresPer-competitor visibility scores for the selected brand.
/quadrantCompetitive quadrantPositions the brand and its competitors on a visibility-versus-sentiment quadrant.
Domains and URLs cited in AI responses
/citationsRanked citationsDomains cited in AI responses for your brand.
/citations/domainsDomain leaderboardStack-ranked domains cited in AI responses, with category labels and trend data.
/citations/domains/categoriesCitation categoriesDistribution of citation source categories (News, Education, Brand, etc.).
/citations/domains/{domain}Per-domain citation detailDetailed citation analysis for a specific domain: cited URLs, brand vs competitor presence, freshness, trend. Tier-gated response shape (Free: summary only; Starter: + URLs; Pro+: + competitor co-mentions). PRD-2026-049: pass prompt_id to scope the view to one prompt's citations on this domain (time range is ignored, fanout sources excluded). Mirrors the portal's per-prompt leaderboard drilldown.
Tracked queries that AI Sightline monitors
/promptsList tracked prompts/promptsCreate a tracked promptRequires Pro tier or higher for MCP write access.
/prompts/{id}Delete a promptRequires Pro tier or higher.
/prompts/{id}/citationsPer-prompt competitor citation leaderboardPRD-2026-049. Returns every domain cited on this prompt grouped by tracked competitor / untracked brand / reference / community / video / other, with per-platform pills and total URL count. The YOU row is always at index 0 (even when zero citations). Fanout sources (URLs the model searched but did not cite) are excluded. For just the per-prompt cited URLs from a single domain, use /citations/domains/{domain}?prompt_id={id} instead.
data.leaderboard is an array of rows, data.totals contains distinct_domains and your_platforms_cited, data.brand_domain + data.brand_name carry the brand identity./prompts/generateAuto-generate prompts from brand contextUses your brand's keywords, description, and industry. Requires Pro tier or higher.
/prompt-resultsPer-prompt per-platform scan results/prompts/url-discoverDiscover prompts from a URLSuggest tracked prompts derived from the content of a supplied URL.
Accepts a JSON object. Individual fields for this endpoint are not enumerated in the spec yet.
Prioritized actions to improve visibility
/recommendationsPrioritized recommendationsActions to improve visibility. Response shape is tier-gated: Free tier sees only titles, Pro+ sees full action plans.
/recommendations/impactImpact reportPoints gained, actions completed, per-recommendation score deltas. Requires Pro tier or higher.
/recommendations/{id}/acceptAccept a recommendationRequires Starter tier or higher.
/recommendations/{id}/dismissDismiss a recommendation/recommendations/{id}/completeMark a recommendation completeSnapshots the current visibility score so impact can be measured. Requires Starter tier or higher.
Brand Sentiment Index (BSI) over time and across competitors
/sentiment/brandBrand Sentiment Index (BSI)-100 to +100 score with directional trend. How positively AI platforms talk about the brand.
/sentiment/competitorsBSI versus competitors/sentiment/trendBSI trend over timeBrand management for multi-brand workspaces
/brandsList brands/brandsCreate a brandRequires Pro tier or higher for MCP write access. Creating a brand consumes a brand slot against your tier limit.
/brands/{brandId}Get a brand/brands/{brandId}/archiveArchive a brandRemoves the brand from active scanning and frees quota. Reversible via /brands/{brandId}/reactivate.
/brands/{brandId}/reactivateReactivate an archived brand/brandCreate a brandRegister a new brand in the workspace (subject to the tier brand limit).
Accepts a JSON object. Individual fields for this endpoint are not enumerated in the spec yet.
Brands mentioned alongside yours that you do not track yet
/discoveriesDiscovered brandsBrands AI platforms mention alongside yours that you have not added as competitors.
/discoveries/{id}/acceptAccept a discoveryPromote a discovered brand into a tracked competitor.
/discoveries/{id}/dismissDismiss a discoveryDismiss a discovered brand so it is no longer surfaced.
Usage, quota, and organization-level data
/usageCurrent usageMonthly API call count, rate limit remaining, billing period window.
/org/quotaOrganization quotaPrompts used vs limit, brand count, per-brand keyword and competitor limits.
/statusPlatform statusLive circuit-breaker state for each AI platform, so you can surface a degradation banner. Reflects breaker state only: operational means the breaker is closed, not a guarantee of live data (a platform may be skipped by a separate rate-limit guardrail, or serve cached results).
/summaryExecutive summaryAI-generated executive summary of the brand's current visibility.
/refreshRefresh statusCurrent on-demand refresh availability for the workspace.
/refreshTrigger a refreshRequest an on-demand data refresh for the selected brand.
Accepts a JSON object. Individual fields for this endpoint are not enumerated in the spec yet.
/digest/preferencesGet digest preferencesCurrent email digest cadence and channel preferences.
/digest/preferencesUpdate digest preferencesUpdate the email digest cadence and channel preferences.
Accepts a JSON object. Individual fields for this endpoint are not enumerated in the spec yet.
/prospect-reportsGenerate a prospect reportGenerate a shareable prospect visibility report for a target domain.
Accepts a JSON object. Individual fields for this endpoint are not enumerated in the spec yet.
/share/createCreate a share linkCreate a public, read-only share link for a brand report.
Accepts a JSON object. Individual fields for this endpoint are not enumerated in the spec yet.
AI-readability auditing and content generation
/content-auditStart AI-readability auditScores structured data, FAQ sections, freshness, and heading structure. Requires Pro tier or higher.
/content/generateGenerate AI-optimized contentProduces briefs, articles, or FAQs. Requires Business tier or higher.
/schema-suggestionsSchema markup recommendationsJSON-LD suggestions and detected schemas. Requires Starter tier or higher.
/content/{id}Get generated contentRetrieve a previously generated content item by id.
/content-audit/{id}Get content auditRetrieve an AI-readability content audit by id.
/content-gaps/{id}/briefGenerate a content briefGenerate a content brief for a specific competitor content gap.
AI crawler and referral traffic captured by the AI Traffic pixel
/traffic/summaryAI traffic summaryAggregate AI crawler and referral traffic for the selected brand.
/traffic/timelineAI traffic timelineTime-series of AI crawler and referral traffic for the selected brand.
/traffic/botsAI bot crawlsCursor-paginated list of AI crawler visits for the selected brand.
/traffic/referralsAI referralsCursor-paginated list of AI-platform referral visits for the selected brand.
/traffic/discoveryAI discovery-file eventsRequests for llms.txt and other AI discovery files for the selected brand.
/traffic/install/verifyVerify pixel installVerify that the AI Traffic pixel is installed and reporting for a website.
Accepts a JSON object. Individual fields for this endpoint are not enumerated in the spec yet.
/traffic/website-keysList website keysList the AI Traffic pixel website keys for the workspace.
/traffic/website-keysCreate a website keyCreate a new AI Traffic pixel website key.
Accepts a JSON object. Individual fields for this endpoint are not enumerated in the spec yet.
/traffic/website-keys/{id}Delete a website keyRevoke an AI Traffic pixel website key.
Outbound event subscriptions (score changes, competitors, scan completion)
/webhooksList webhooksList the workspace's outbound webhook subscriptions.
/webhooksCreate a webhookSubscribe an HTTPS endpoint to events (score.changed, score.threshold, competitor.new, scan.completed). Deliveries are HMAC-SHA256 signed.
Accepts a JSON object. Individual fields for this endpoint are not enumerated in the spec yet.
/webhooks/{id}Delete a webhookRemove an outbound webhook subscription.
/webhooks/{id}/deliveriesList webhook deliveriesRecent delivery attempts (status, response code, timestamps) for a webhook.
/webhooks/{id}/testSend a test deliverySend a signed test payload to the webhook's endpoint.
Pull the machine readable spec into your codegen pipeline, or email the founder directly with integration questions. Response time is 24 hours.