Skip to content

This page explains each backend API area in plain words and marks where to focus first.

Legend

  • <span class="doc-badge important">High Focus</span>: key product endpoints.
  • <span class="doc-badge secondary">Medium Focus</span>: useful but secondary.
  • <span class="doc-badge muted">Low Focus</span>: internal/specialized.
  • <span class="doc-badge ok">Used</span>: detected in frontend flows.
  • <span class="doc-badge warn">Not Used</span>: not directly detected in frontend flows.
  • <span class="doc-badge ok">Documented</span>: endpoint summary exists.
  • <span class="doc-badge warn">Not Documented</span>: missing clear summary.

settings

What this group does: Workspace settings, keys, webhooks, formulas, and administrative controls.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
GET /api/api-keysHigh FocusUsed System / Cost ManagementDocumentedList API keys
POST /api/api-keysHigh FocusUsed /brand/settings, /settings/account/api-keys (+7)DocumentedCreate API key
DELETE /api/api-keys/{key_id}Medium FocusNot UsedDocumentedRevoke API key
GET /api/audit-logsMedium FocusIndirect frontend/src/hooks/useApi.tsDocumentedList audit logs
GET /api/integrationsHigh FocusUsed /brand/settings, /settings/account/api-keys (+8)DocumentedList integration connections
POST /api/integrationsHigh FocusUsed /brand/settings, /settings/account/api-keys (+8)DocumentedCreate integration connection
GET /api/integrations/catalogHigh FocusUsed /brand/settings, /settings/account/api-keys (+8)DocumentedList supported integration providers
DELETE /api/integrations/{integration_id}Medium FocusNot UsedDocumentedDelete integration connection
POST /api/integrations/{integration_id}/testHigh FocusUsed /brand/settings, /settings/account/api-keys (+7)DocumentedTest integration connectivity
GET /api/settingsMedium FocusNot UsedDocumentedGet workspace settings
PUT /api/settingsHigh FocusUsed /brand/settings, /settings/account/api-keys (+7)DocumentedUpdate workspace settings
GET /api/settings/exportHigh FocusUsed /brand/settings, /settings/account/api-keys (+7)DocumentedExport workspace data snapshot
GET /api/settings/metric-formulasHigh FocusUsed System / Metric FormulasDocumentedList all metric formulas and explanations
PUT /api/settings/metric-formulas/{metric_key}High FocusUsed System / Metric FormulasDocumentedUpdate or reset a metric formula override
POST /api/settings/request-account-deletionMedium FocusNot UsedDocumentedCreate account deletion request
GET /api/settings/support-ticket-instructionsMedium FocusNot UsedDocumentedGet support ticket instructions
GET /api/settings/support-ticketsMedium FocusNot UsedDocumentedList support tickets
POST /api/settings/support-ticketsMedium FocusNot UsedDocumentedCreate support ticket
GET /api/support/ticket-instructionsHigh FocusUsed System / SupportDocumentedGet support ticket instructions
GET /api/support/ticketsHigh FocusUsed System / SupportDocumentedList support tickets
POST /api/support/ticketsHigh FocusUsed System / SupportDocumentedCreate support ticket
GET /api/webhooksMedium FocusNot UsedDocumentedList webhook endpoints
POST /api/webhooksHigh FocusUsed /brand/settings, /settings/account/api-keys (+7)DocumentedCreate webhook endpoint
DELETE /api/webhooks/{webhook_id}Medium FocusNot UsedDocumentedDelete webhook endpoint
PATCH /api/webhooks/{webhook_id}/toggleMedium FocusNot UsedDocumentedToggle webhook active state

analytics-insights

What this group does: Specialized or uncategorized endpoints with limited surface area.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
GET /api/analytics/citations/categoriesMedium FocusNot UsedDocumentedCitation Categories
GET /api/analytics/citations/graphMedium FocusIndirect frontend/src/components/insights/CitationsTab.tsxDocumentedCitation Graph
GET /api/analytics/citations/watched-pagesMedium FocusNot UsedDocumentedList Watched Pages
POST /api/analytics/citations/watched-pagesMedium FocusNot UsedDocumentedAdd Watched Page
DELETE /api/analytics/citations/watched-pages/{page_id}Medium FocusNot UsedDocumentedRemove Watched Page
GET /api/analytics/extraction-quality/latestHigh FocusUsed System / Cost ManagementDocumentedExtraction Quality Latest
GET /api/analytics/network/distributionHigh FocusUsed System / Cost ManagementDocumentedNetwork Distribution
GET /api/analytics/network/latencyMedium FocusIndirect frontend/src/hooks/useApi.tsDocumentedNetwork Latency
GET /api/analytics/platformsMedium FocusIndirect frontend/src/components/insights/PlatformsTab.tsx, frontend/src/components/insights/VisibilityTab.tsxDocumentedPlatform Breakdown
GET /api/analytics/platforms/analysisMedium FocusIndirect frontend/src/hooks/useApi.tsDocumentedPlatform Analysis
GET /api/analytics/query-fanoutsMedium FocusNot UsedDocumentedQuery Fanouts
GET /api/analytics/query-fanouts/analyzeMedium FocusIndirect frontend/src/hooks/useApi.tsDocumentedQuery Fanout Analyze
GET /api/analytics/regionsMedium FocusNot UsedDocumentedRegion Breakdown
GET /api/analytics/scrape-quality/latestMedium FocusNot UsedDocumentedLatest Scrape Quality
GET /api/analytics/sentimentMedium FocusNot UsedDocumentedSentiment Analysis
POST /api/analytics/sentiment/generateMedium FocusNot UsedDocumentedGenerate Sentiment
GET /api/analytics/sentiment/statusMedium FocusNot UsedDocumentedSentiment Status
GET /api/analytics/share-of-voiceMedium FocusNot UsedDocumentedShare Of Voice
GET /api/analytics/topic-performanceMedium FocusIndirect frontend/src/hooks/useApi.tsDocumentedTopic Performance
GET /api/analytics/visibility-settingsMedium FocusNot UsedDocumentedGet Visibility Settings
PUT /api/analytics/visibility-settingsMedium FocusNot UsedDocumentedUpdate Visibility Settings
GET /api/analytics/visibility/drilldownMedium FocusIndirect frontend/src/components/insights/VisibilityTab.tsxDocumentedVisibility Drilldown

agent-analytics

What this group does: Crawler, referral, and worker telemetry for agent traffic intelligence.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
GET /api/agent-analytics/botsHigh FocusUsed /agent-analytics, /website/:domain (+7)DocumentedList Bot Visits
POST /api/agent-analytics/cloudflare/enrollHigh FocusUsed /agent-analytics, /website/:domain (+7)DocumentedEnroll Cloudflare Worker
POST /api/agent-analytics/cloudflare/logsMedium FocusNot UsedDocumentedIngest Cloudflare Worker Logs
POST /api/agent-analytics/cloudflare/network/configureMedium FocusNot UsedDocumentedConfigure Cloudflare Network
POST /api/agent-analytics/cloudflare/network/profile/selectMedium FocusNot UsedDocumentedSelect Cloudflare Network Profile
GET /api/agent-analytics/cloudflare/network/profilesMedium FocusNot UsedDocumentedCloudflare Network Profiles
GET /api/agent-analytics/cloudflare/network/statusHigh FocusUsed /agent-analytics, /website/:domain (+7)DocumentedCloudflare Network Status
GET /api/agent-analytics/cloudflare/statusHigh FocusUsed /agent-analytics, /website/:domain (+7)DocumentedCloudflare Worker Status
GET /api/agent-analytics/heatmapMedium FocusIndirect frontend/src/hooks/useApi.tsDocumentedHeatmap Report
POST /api/agent-analytics/ingestMedium FocusNot UsedDocumentedIngest Logs
GET /api/agent-analytics/overviewMedium FocusNot UsedDocumentedOverview
GET /api/agent-analytics/pagesMedium FocusIndirect frontend/src/hooks/useApi.tsDocumentedPages Report
GET /api/agent-analytics/pages/detailMedium FocusIndirect frontend/src/hooks/useApi.tsDocumentedPages Detail Report
GET /api/agent-analytics/pages/indexMedium FocusIndirect frontend/src/hooks/useApi.tsDocumentedPages Index Report
GET /api/agent-analytics/referralsHigh FocusUsed /agent-analytics, /website/:domain (+7)DocumentedList Referral Visits
GET /api/agent-analytics/reports/botsMedium FocusNot UsedDocumentedReport Bots Daily
GET /api/agent-analytics/reports/referralsMedium FocusNot UsedDocumentedReport Referrals Daily
GET /api/agent-analytics/xyops/statusHigh FocusUsed System / Cost ManagementDocumentedXyops Status

prompt-management

What this group does: Specialized or uncategorized endpoints with limited surface area.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
GET /api/prompt-templatesLow FocusIndirect frontend/src/hooks/useApi.tsDocumentedList prompt templates
POST /api/prompt-templatesHigh FocusUsed /brand/topics, /prompt-managementDocumentedCreate prompt template
DELETE /api/prompt-templates/{template_id}High FocusUsed /brand/topics, /prompt-managementDocumentedDelete prompt template
PUT /api/prompt-templates/{template_id}High FocusUsed /brand/topics, /prompt-managementDocumentedUpdate prompt template
POST /api/prompt-templates/{template_id}/acceptHigh FocusUsed /brand/topics, /prompt-managementDocumentedAccept suggested template
POST /api/prompt-templates/{template_id}/rejectHigh FocusUsed /brand/topics, /prompt-managementDocumentedReject and delete suggested template
POST /api/prompts/batchLow FocusNot UsedDocumentedBatch action on templates
POST /api/prompts/estimate-volumeLow FocusNot UsedDocumentedEstimate search volume
POST /api/prompts/suggestLow FocusNot UsedDocumentedAI-powered prompt suggestions
POST /api/prompts/upload-csvLow FocusNot UsedDocumentedUpload CSV of prompts
GET /api/tagsLow FocusIndirect frontend/src/components/filters/DashboardFilters.tsxDocumentedList tags for org
POST /api/tagsHigh FocusUsed /brand/topics, /prompt-managementDocumentedCreate tag
DELETE /api/tags/{tag_id}High FocusUsed /brand/topics, /prompt-managementDocumentedDelete tag
PUT /api/tags/{tag_id}High FocusUsed /brand/topics, /prompt-managementDocumentedUpdate tag name
GET /api/topicsLow FocusIndirect frontend/src/components/filters/DashboardFilters.tsxDocumentedList topics for org
POST /api/topicsHigh FocusUsed /brand/topics, /prompt-managementDocumentedCreate topic
DELETE /api/topics/{topic_id}High FocusUsed /brand/topics, /prompt-managementDocumentedDelete topic
PUT /api/topics/{topic_id}High FocusUsed /brand/topics, /prompt-managementDocumentedUpdate topic name

analytics

What this group does: Visibility, sentiment, platform, and citation analytics powering dashboard insights.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
GET /api/active-sessionsMedium FocusNot UsedDocumentedGet active scraping sessions
GET /api/citationsMedium FocusNot UsedDocumentedGet citation statistics
GET /api/citations/mismatchesMedium FocusIndirect frontend/src/hooks/useApi.tsDocumentedGet mismatch alerts
GET /api/compareMedium FocusIndirect frontend/src/hooks/useApi.tsDocumentedCompare two periods
GET /api/cost-estimateMedium FocusNot UsedDocumentedEstimate daily costs
PUT /api/daily-quotaMedium FocusNot UsedDocumentedUpdate daily quota
GET /api/daily-statsHigh FocusUsed /brand/settings, /settings/account/api-keys (+8)DocumentedGet daily statistics
GET /api/export/citations.csvMedium FocusIndirect frontend/src/components/insights/CitationsTab.tsxDocumentedExport citations domain breakdown as CSV
GET /api/export/{section}.csvMedium FocusNot UsedDocumentedExport analytics section as CSV
GET /api/job-historyMedium FocusNot UsedDocumentedGet job execution history
GET /api/metricsMedium FocusIndirect frontend/src/hooks/useApi.tsDocumentedGet dashboard metrics
GET /api/suggestionsMedium FocusNot UsedDocumentedGet SEO suggestions
GET /api/visibilityMedium FocusIndirect frontend/src/hooks/useApi.tsDocumentedGet visibility data

onboarding

What this group does: First-run workspace setup and setup-assist automation.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
POST /api/onboarding/account-typeLow FocusNot UsedDocumentedSave Account Type
POST /api/onboarding/admin/account-statusLow FocusNot UsedDocumentedAdmin Onboarding Account Status
POST /api/onboarding/admin/sync-accountLow FocusNot UsedDocumentedAdmin Onboarding Sync Account
POST /api/onboarding/admin/unlock-accountLow FocusNot UsedDocumentedAdmin Onboarding Unlock Account
POST /api/onboarding/agency-waitlistLow FocusNot UsedDocumentedJoin Agency Waitlist
POST /api/onboarding/completeLow FocusNot UsedDocumentedComplete Onboarding
POST /api/onboarding/discover-competitorsLow FocusNot UsedDocumentedDiscover Competitors
POST /api/onboarding/generate-promptsHigh FocusUsed /onboarding, Onboarding / Getting StartedDocumentedGenerate Ai Prompts
GET /api/onboarding/promptsHigh FocusUsed /onboarding, Onboarding / Getting StartedDocumentedGet Prompts For Review
POST /api/onboarding/promptsLow FocusNot UsedDocumentedSave Prompts
GET /api/onboarding/statusHigh FocusUsed /onboarding, Onboarding / Getting StartedDocumentedGet Onboarding Status
GET /api/onboarding/topicsHigh FocusUsed /onboarding, Onboarding / Getting StartedDocumentedGet Available Topics
POST /api/onboarding/topicsLow FocusNot UsedDocumentedSave Topics

content-cms

What this group does: Specialized or uncategorized endpoints with limited surface area.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
GET /api/content-cms/articlesLow FocusNot UsedDocumentedList Articles
POST /api/content-cms/articlesLow FocusNot UsedDocumentedCreate Article
DELETE /api/content-cms/articles/{article_id}Low FocusNot UsedDocumentedDelete Article
GET /api/content-cms/articles/{article_id}Low FocusNot UsedDocumentedGet Article
PUT /api/content-cms/articles/{article_id}Low FocusNot UsedDocumentedUpdate Article
POST /api/content-cms/articles/{article_id}/generate-draftLow FocusNot UsedDocumentedGenerate Draft
GET /api/content-cms/articles/{article_id}/workflow-statusLow FocusNot UsedDocumentedGet Workflow Status
GET /api/content-cms/connectors/statusLow FocusNot UsedDocumentedConnectors Status
POST /api/content-cms/generate-briefLow FocusNot UsedDocumentedGenerate Brief
POST /api/content-cms/publishLow FocusNot UsedDocumentedPublish Article
GET /api/content-cms/publish/targetsLow FocusNot UsedDocumentedList Publish Targets
GET /api/content-cms/templatesLow FocusNot UsedDocumentedList Templates

actions

What this group does: Action lifecycle management, recommendation execution, and planning workflows.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
GET /api/actionsLow FocusIndirect frontend/src/hooks/useApi.tsDocumentedList Actions
POST /api/actionsHigh FocusUsed Actions / ActionsDocumentedCreate Action
POST /api/actions/generateLow FocusNot UsedDocumentedGenerate Actions
GET /api/actions/timelineLow FocusNot UsedDocumentedGet Timeline
DELETE /api/actions/{action_id}High FocusUsed Actions / ActionsDocumentedDelete Action
PUT /api/actions/{action_id}Low FocusNot UsedDocumentedUpdate Action
POST /api/actions/{action_id}/completeLow FocusNot UsedDocumentedComplete Action
POST /api/actions/{action_id}/planLow FocusNot UsedDocumentedAdd To Plan
POST /api/actions/{action_id}/postponeLow FocusNot UsedDocumentedPostpone Action
POST /api/actions/{action_id}/startLow FocusNot UsedDocumentedStart Action
POST /api/actions/{action_id}/verifyLow FocusNot UsedDocumentedVerify Action

brands

What this group does: Brand entities, destinations, and brand-level visibility configuration.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
GET /api/brandsHigh FocusUsed Actions / SuggestionsDocumentedList all brands
POST /api/brandsHigh FocusUsed /brand/competitors, /brand/domains (+3)DocumentedCreate a new brand
GET /api/brands/detailsMedium FocusNot UsedDocumentedGet detailed brand analytics
GET /api/brands/suggestedMedium FocusNot UsedDocumentedGet suggested brands from recent chats
DELETE /api/brands/{brand_id}Medium FocusNot UsedDocumentedDelete a brand
PATCH /api/brands/{brand_id}High FocusUsed /brand/competitors, /brand/domains (+3)DocumentedUpdate brand advanced settings
GET /api/brands/{brand_id}/domainsMedium FocusNot UsedDocumentedGet domains for a brand
POST /api/brands/{brand_id}/domainsMedium FocusNot UsedDocumentedAdd domain to a brand
DELETE /api/brands/{brand_id}/domains/{domain_id}Medium FocusNot UsedDocumentedRemove domain from a brand
GET /api/brands/{brand_id}/link-destinationsMedium FocusIndirect frontend/src/hooks/useApi.tsDocumentedGet link destinations for a brand
PUT /api/brands/{brand_id}/set-primaryMedium FocusNot UsedDocumentedSet a brand as primary

knowledge-bases

What this group does: Knowledge source management for retrieval and AI grounding.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
GET /api/knowledge-basesLow FocusNot UsedDocumentedList Knowledge Bases
POST /api/knowledge-basesHigh FocusUsed Context / Knowledge BasesDocumentedCreate Knowledge Base
GET /api/knowledge-bases/statusLow FocusNot UsedDocumentedKnowledge Base Status
DELETE /api/knowledge-bases/{kb_id}Low FocusNot UsedDocumentedDelete Knowledge Base
PATCH /api/knowledge-bases/{kb_id}Low FocusNot UsedDocumentedUpdate Knowledge Base
GET /api/knowledge-bases/{kb_id}/documentsLow FocusNot UsedDocumentedList Documents
DELETE /api/knowledge-bases/{kb_id}/documents/{document_id}Low FocusNot UsedDocumentedDelete Document
POST /api/knowledge-bases/{kb_id}/documents/{document_id}/reindexLow FocusNot UsedDocumentedReindex Document
POST /api/knowledge-bases/{kb_id}/import-urlLow FocusNot UsedDocumentedImport Url
POST /api/knowledge-bases/{kb_id}/searchLow FocusNot UsedDocumentedSearch Knowledge Base
POST /api/knowledge-bases/{kb_id}/uploadLow FocusNot UsedDocumentedUpload Document

jobs

What this group does: Scrape and processing job scheduling, status, and execution details.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
GET /api/jobsHigh FocusUsed /brand/settings, /settings/account/api-keys (+8)DocumentedList scraping jobs
POST /api/jobs/scrapeMedium FocusNot UsedDocumentedCreate scraping job
GET /api/jobs/{job_id}Medium FocusNot UsedDocumentedGet job details
GET /api/jobs/{job_id}/detailsHigh FocusUsed System / Cost ManagementDocumentedGet detailed job information
GET /api/jobs/{job_id}/htmlMedium FocusNot UsedDocumentedGet job HTML snapshot
GET /api/scheduled-jobsHigh FocusUsed /brand/settings, /settings/account/api-keys (+7)DocumentedList scheduled/recurring jobs
DELETE /api/scheduled-jobs/{job_id}Medium FocusNot UsedDocumentedDelete a scheduled job
GET /api/scheduled-jobs/{job_id}Medium FocusNot UsedDocumentedGet scheduled job details
PUT /api/scheduled-jobs/{job_id}/pauseMedium FocusNot UsedDocumentedPause a scheduled job
PUT /api/scheduled-jobs/{job_id}/resumeMedium FocusNot UsedDocumentedResume a paused job

system

What this group does: Platform health, admin tooling, and system-level operations.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
GET /api/admin/docsLow FocusNot UsedDocumentedAdmin Dashboard Documentation
GET /api/configLow FocusNot UsedDocumentedGet system configuration
GET /api/docker/containersLow FocusNot UsedDocumentedList Docker containers
GET /api/docker/logs/{container}Low FocusNot UsedDocumentedGet Docker container logs
GET /api/proxy-providersLow FocusNot UsedDocumentedList all proxy providers and their status
GET /api/scheduler-statusHigh FocusUsed /brand/settings, /settings/account/api-keys (+7)DocumentedGet scheduler status
GET /api/screenshotsLow FocusNot UsedDocumentedList all screenshots
GET /api/screenshots/{filename}Low FocusNot UsedDocumentedGet screenshot image
GET /api/stats/databaseHigh FocusUsed /brand/settings, /settings/account/api-keys (+7)DocumentedGet database statistics
GET /api/vpn/serversLow FocusNot UsedDocumentedGet VPN servers

customer-api

What this group does: Specialized or uncategorized endpoints with limited surface area.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
GET /v1/brandsLow FocusNot UsedDocumentedList Brands
GET /v1/chatsLow FocusNot UsedDocumentedList Chats
GET /v1/chats/{chat_id}Low FocusNot UsedDocumentedGet Chat Detail
GET /v1/modelsLow FocusNot UsedDocumentedList Models
GET /v1/promptsLow FocusNot UsedDocumentedList Prompts
POST /v1/reports/brandsLow FocusNot UsedDocumentedReport Brands
POST /v1/reports/domainsLow FocusNot UsedDocumentedReport Domains
GET /v1/tagsLow FocusNot UsedDocumentedList Tags
GET /v1/topicsLow FocusNot UsedDocumentedList Topics

google-analytics

What this group does: Specialized or uncategorized endpoints with limited surface area.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
POST /api/settings/ga/connectLow FocusNot UsedDocumentedConnect Ga
POST /api/settings/ga/deep-analysisLow FocusNot UsedDocumentedTrigger Deep Analysis
POST /api/settings/ga/disconnectLow FocusNot UsedDocumentedDisconnect Ga
GET /api/settings/ga/oauth/callbackLow FocusNot UsedDocumentedOauth Callback
POST /api/settings/ga/oauth/connectLow FocusNot UsedDocumentedOauth Connect
GET /api/settings/ga/oauth/propertiesLow FocusNot UsedDocumentedOauth Properties
POST /api/settings/ga/oauth/startLow FocusNot UsedDocumentedOauth Start
GET /api/settings/ga/statusHigh FocusUsed /agent-analytics, /brand/settings (+16)DocumentedGa Status
GET /api/settings/ga/summaryLow FocusNot UsedDocumentedGa Summary

billing

What this group does: Plan, subscription, and account monetization management workflows.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
POST /api/billing/admin/account-statusMedium FocusNot UsedDocumentedAdmin Billing Account Status
POST /api/billing/admin/unlock-accountMedium FocusNot UsedDocumentedAdmin Unlock Account Billing
POST /api/billing/change-planHigh FocusUsed System / Cost ManagementDocumentedChange Plan
POST /api/billing/create-checkout-sessionHigh FocusUsed System / Cost ManagementDocumentedCreate Checkout Session
POST /api/billing/create-portal-sessionMedium FocusNot UsedDocumentedCreate Portal Session
GET /api/billing/plansMedium FocusNot UsedDocumentedList Plans
GET /api/billing/statusHigh FocusUsed /brand/settings, /settings/account/api-keys (+8)DocumentedGet Billing Status

dashboard-filters

What this group does: Dashboard-level filters, dimensions, and default saved views.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
GET /api/countriesLow FocusNot UsedDocumentedList Countries
GET /api/modelsLow FocusNot UsedDocumentedList Ai Models
GET /api/personasHigh FocusUsed /brand/settings, /settings/account/api-keys (+7)DocumentedList Personas
POST /api/personasHigh FocusUsed /brand/settings, /settings/account/api-keys (+7)DocumentedCreate Persona
DELETE /api/personas/{persona_id}High FocusUsed /brand/settings, /settings/account/api-keys (+7)DocumentedDelete Persona
GET /api/personas/{persona_id}Low FocusNot UsedDocumentedGet Persona
PUT /api/personas/{persona_id}Low FocusIndirect frontend/src/components/insights/PersonasTab.tsxDocumentedUpdate Persona

geo

What this group does: Specialized or uncategorized endpoints with limited surface area.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
POST /api/geo/competitor-gapsLow FocusNot UsedDocumentedGenerate Competitor Gaps
POST /api/geo/content-opportunitiesLow FocusNot UsedDocumentedGenerate Content Opportunities
POST /api/geo/outreach-targetsLow FocusNot UsedDocumentedGenerate Outreach Targets
POST /api/geo/quick-winsLow FocusNot UsedDocumentedGenerate Quick Wins
POST /api/geo/strategic-summaryLow FocusNot UsedDocumentedGenerate Strategic Summary
POST /api/geo/technical-checklistLow FocusNot UsedDocumentedGenerate Technical Checklist

scheduling

What this group does: Specialized or uncategorized endpoints with limited surface area.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
POST /api/schedule-batchMedium FocusNot UsedDocumentedSchedule batch of prompts
GET /api/templatesMedium FocusNot UsedDocumentedList prompt templates
POST /api/templatesMedium FocusNot UsedDocumentedCreate prompt template
DELETE /api/templates/{template_id}Medium FocusNot UsedDocumentedDelete template
GET /api/templates/{template_id}Medium FocusNot UsedDocumentedGet template by ID
PUT /api/templates/{template_id}Medium FocusNot UsedDocumentedUpdate template

agents

What this group does: Specialized or uncategorized endpoints with limited surface area.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
GET /api/agents/providers/statusLow FocusNot UsedDocumentedGet Agent Provider Status
GET /api/agents/runsLow FocusIndirect frontend/src/hooks/useApi.tsDocumentedList Agent Runs
POST /api/agents/runsHigh FocusUsed /agents/new, /agents/scheduled (+2)DocumentedCreate Agent Run
GET /api/agents/runs/{run_id}Low FocusNot UsedDocumentedGet Agent Run
GET /api/agents/templatesLow FocusNot UsedDocumentedList Agent Templates

annotations

What this group does: Specialized or uncategorized endpoints with limited surface area.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
GET /api/annotationsLow FocusNot UsedDocumentedList Annotations
POST /api/annotationsLow FocusNot UsedDocumentedCreate Annotation
DELETE /api/annotations/{annotation_id}Low FocusNot UsedDocumentedDelete Annotation
GET /api/annotations/{annotation_id}Low FocusNot UsedDocumentedGet Annotation
PUT /api/annotations/{annotation_id}Low FocusNot UsedDocumentedUpdate Annotation

benchmark

What this group does: Specialized or uncategorized endpoints with limited surface area.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
GET /api/benchmark/leaderboardLow FocusNot UsedDocumentedProvider leaderboard
POST /api/benchmark/runLow FocusNot UsedDocumentedStart a benchmark run
GET /api/benchmark/runsLow FocusNot UsedDocumentedList benchmark runs
GET /api/benchmark/runs/{run_id}Low FocusNot UsedDocumentedGet benchmark run details

content-optimization

What this group does: Specialized or uncategorized endpoints with limited surface area.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
POST /api/content/analyzeHigh FocusUsed /content-library/tools/url-slug-optimizer, /content-optimizationDocumentedAnalyze Content
GET /api/content/optimizationsLow FocusIndirect frontend/src/hooks/useApi.tsDocumentedList Optimizations
DELETE /api/content/optimizations/{optimization_id}High FocusUsed /content-library/tools/url-slug-optimizer, /content-optimizationDocumentedDelete Optimization
GET /api/content/optimizations/{optimization_id}Low FocusIndirect frontend/src/hooks/useApi.tsDocumentedGet Optimization Detail

prompts

What this group does: Prompt catalog, analytics, history, and prompt-level result drilldowns.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
GET /api/promptsMedium FocusIndirect frontend/src/hooks/useApi.tsDocumentedList all prompts
GET /api/prompts/{query_id}Medium FocusIndirect frontend/src/hooks/useApi.ts, frontend/src/hooks/useApi.tsDocumentedGet prompt details
GET /api/prompts/{query_id}/analysisMedium FocusIndirect frontend/src/hooks/useApi.tsDocumentedGet full prompt analysis
GET /api/prompts/{query_id}/historyHigh FocusUsed /brand/prompts, /prompt-editor (+2)DocumentedGet prompt history (audit trail)

source-analysis

What this group does: Specialized or uncategorized endpoints with limited surface area.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
POST /api/sources/classifyLow FocusNot UsedDocumentedClassify Sources
GET /api/sources/domainsLow FocusIndirect frontend/src/hooks/useApi.tsDocumentedGet Domain Analytics
GET /api/sources/gap-analysisLow FocusIndirect frontend/src/hooks/useApi.tsDocumentedGet Gap Analysis
GET /api/sources/urlsHigh FocusUsed Analytics / SourcesDocumentedGet Url Analytics

xyops

What this group does: Automation control-plane orchestration and scheduled background workflows.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
POST /api/xyops/control/dispatch-dueLow FocusNot UsedDocumentedDispatch due recurring jobs (xyOps controlled)
POST /api/xyops/control/run-job/{job_id}Low FocusNot UsedDocumentedRun a specific job/template (xyOps controlled)
GET /api/xyops/control/statusLow FocusNot UsedDocumentedGet xyOps control-plane status
GET /api/xyops/control/templatesLow FocusNot UsedDocumentedGet production xyOps event templates

admin

What this group does: Specialized or uncategorized endpoints with limited surface area.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
POST /api/admin/assign-brands-to-orgLow FocusNot UsedDocumentedAssign brands to an organization by clerk org ID
POST /api/admin/assign-templates-to-orgLow FocusNot UsedDocumentedAssign templates to an organization by clerk org ID
POST /api/admin/importLow FocusNot UsedDocumentedBulk import scraped results

auth

What this group does: Authentication provider status, identity context, and access control endpoints.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
GET /api/auth/meLow FocusNot UsedDocumentedGet current user info
GET /api/auth/provider/statusLow FocusNot UsedDocumentedGet auth provider readiness
POST /api/auth/provider/switchLow FocusNot UsedDocumentedSwitch active auth provider at runtime

recommendations

What this group does: Specialized or uncategorized endpoints with limited surface area.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
POST /api/geo/recommendationsLow FocusIndirect frontend/src/components/geo/KanbanBoard.tsxDocumentedGenerate Recommendations Endpoint
GET /api/geo/recommendations/{brand_id}Low FocusIndirect frontend/src/components/geo/KanbanBoard.tsxDocumentedGet Recommendations Endpoint
PATCH /api/geo/recommendations/{recommendation_id}/statusLow FocusNot UsedDocumentedUpdate Recommendation Status

suggestions

What this group does: Specialized or uncategorized endpoints with limited surface area.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
POST /api/suggestions/generateLow FocusNot UsedDocumentedGenerate Ai Suggestions
POST /api/suggestions/generate/v2Low FocusNot UsedDocumentedGenerate Ai Suggestions V2
GET /api/suggestions/statusLow FocusNot UsedDocumentedGet Suggestions Status

vpn

What this group does: Specialized or uncategorized endpoints with limited surface area.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
GET /api/vpn/ip/{country}Low FocusNot UsedDocumentedGet VPN container IP
POST /api/vpn/rotate/{country}Low FocusNot UsedDocumentedRotate VPN IP
GET /api/vpn/statusLow FocusNot UsedDocumentedGet all VPN status

chats

What this group does: Specialized or uncategorized endpoints with limited surface area.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
GET /api/chatsLow FocusIndirect frontend/src/hooks/useApi.tsDocumentedList Chats
GET /api/chats/{chat_id}Low FocusIndirect frontend/src/hooks/useApi.tsDocumentedGet Chat Detail

sources

What this group does: Source URLs, domains, gaps, and citation evidence inventories.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
GET /api/sourcesMedium FocusNot UsedDocumentedList all sources
GET /api/sources/analyticsMedium FocusNot UsedDocumentedGet source analytics

webhooks

What this group does: Specialized or uncategorized endpoints with limited surface area.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
POST /api/webhooks/clerkLow FocusNot UsedDocumentedHandle Clerk Webhook
POST /api/webhooks/stripeLow FocusNot UsedDocumentedHandle Stripe Webhook

documentation

What this group does: Specialized or uncategorized endpoints with limited surface area.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
GET /api/referenceLow FocusNot UsedDocumentedAPI Reference

embeddings

What this group does: Specialized or uncategorized endpoints with limited surface area.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
POST /api/embeddings/syncLow FocusNot UsedDocumentedSync Embeddings

health

What this group does: Specialized or uncategorized endpoints with limited surface area.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
GET /api/healthLow FocusNot UsedDocumentedHealth check

prompt-volumes

What this group does: Specialized or uncategorized endpoints with limited surface area.

EndpointFocusUsageDocumentationWhat It Does (Plain Words)
GET /api/prompt-volumesHigh FocusUsed /brand, Analytics / Answer Engine InsightsDocumentedGet Prompt Volumes

Unified product and engineering documentation.