BrandCrux REST API & MCP
Everything you need to wire AI visibility into your code. REST from any language, MCP for AI agents.
https://apis.brandcrux.aihttps://mcps.brandcrux.aiAuthentication
All API requests require an API key passed in the X-API-Key header.
- Sign in to your BrandCrux dashboard
- Go to Settings → API Keys
- Click "+ Create Key", name it, and select a business
- Copy the key. It is shown only once.
curl https://apis.brandcrux.ai/api/v1/visibility-score \ -H "X-API-Key: bcx_abc123..."
Use Cases
Track how ChatGPT, Claude, Gemini, Perplexity, and Google AIO mention, recommend, and cite your business.
Schedule scans, pull data via API, and build custom dashboards in your existing BI tools.
Monitor when AI engines recommend competitors instead of you and understand their positioning.
Integrate BrandCrux data with your existing SEO tools, CRMs, or analytics platforms via API.
Trigger webhooks or custom notifications when your visibility score changes across any engine.
REST API Endpoints
/api/v1/competitorsAdd a competitor to your business profile▼/api/v1/source-recommendationsEarn-coverage publisher targets, gap-aware▼/api/v1/visibility-scoreLatest visibility score with confidence block▼/api/v1/businessGet business info▼/api/v1/queriesList tracked prompts▼/api/v1/queriesAdd a prompt▼/api/v1/scansList scans▼/api/v1/scans/{scan_id}Get scan details + per-cell results with confidence▼/api/v1/scans/{scan_id}/attemptsPer-pull attempt log for diagnostics▼/api/v1/scansRun a new scan▼/api/v1/competitorsList competitors▼/api/v1/analyticsFull analytics dashboard▼/api/v1/scan-diffCompare two scans▼/api/v1/trendsVisibility trends over time▼/api/v1/content/briefsList content briefs▼/api/v1/content/briefs/{brief_id}Get content brief▼/api/v1/content/advisoryGenerate content briefs (5 credits)▼/api/v1/content/artifactsList content artifacts▼/api/v1/content/artifacts/{artifact_id}Get content artifact▼/api/v1/content/generateGenerate content (5-30 credits)▼/api/v1/content/artifacts/{id}/exportExport content▼/api/v1/content/artifacts/{id}/versionsContent version history▼/api/v1/analytics/externalSynced GSC/GA4 data▼/api/v1/analytics/correlationAI x Organic correlation▼/api/v1/geo-auditStart GEO audit (1 credit/page)▼/api/v1/geo-audit/{audit_id}Get audit status & results▼/api/v1/geo-audit/{audit_id}/pagesPage-level audit results▼/api/v1/geo-auditsList audit history▼/api/v1/geo-audit/compareCompare vs competitors▼/api/v1/prompt-notificationsList notification configs▼/api/v1/prompt-notifications/{query_id}Set notification▼/api/v1/prompt-notifications/{query_id}Remove notification▼MCP Server
Connect BrandCrux to AI agents via the Model Context Protocol. The MCP server exposes all API functionality as tools that Claude, Cursor, Windsurf, and other MCP-compatible AI assistants can call directly.
Use this connector URL to add BrandCrux to any MCP-compatible client. Your API key is embedded in the URL for automatic authentication.
Add to claude_desktop_config.json (Claude Desktop), .cursor/mcp.json (Cursor), or equivalent.
{
"mcpServers": {
"brandcrux": {
"url": "https://mcps.brandcrux.ai/sse",
"headers": {
"X-API-Key": "bcx_your_key_here"
}
}
}
}Some clients support adding MCP servers via URL. Paste this connector URL directly, which includes your API key for auth.
https://mcps.brandcrux.ai/sse?api_key=bcx_your_key_hereReplace bcx_your_key_here with your API key from Settings → API Keys.
bcx_your_key_here with your actual key)get_visibility_scoreGet the latest AI visibility score and per-source breakdown.
get_businessGet business profile: name, domain, categories, products, competitors.
list_queriesList all tracked search prompts with categories and active status.
add_queryAdd a new prompt to track across AI sources.
list_scansList recent visibility scans with status and summary scores.
get_scan_resultsGet detailed results for a scan: per-prompt scores, AI answers, citations.
run_scanRun a new visibility scan. Returns results when complete (20-60s).
list_competitorsList competitors detected in AI answers, ranked by mentions.
get_analyticsFull analytics: citations, entity leaderboard, cross-source matrix, sentiment.
get_trendsVisibility metrics trended over time across recent scans.
get_scan_diffCompare two scans: improvements, declines, new/lost mentions.
list_content_briefsList AI-generated content recommendations.
get_content_briefGet content brief details: target queries, keywords, outline.
run_content_advisoryGenerate content briefs from scan results and analytics (5 credits).
list_content_artifactsList generated content: drafts, published, archived.
get_content_artifactGet content artifact with full body and SEO metadata.
generate_contentGenerate content from a brief using Claude, GPT-4, or Gemini.
export_contentExport content in markdown, HTML, or JSON.
list_artifact_versionsVersion history for a content artifact.
get_external_analyticsGet synced Google Search Console or Analytics data.
get_visibility_correlationCorrelate AI visibility with organic search metrics.
run_geo_auditStart a GEO audit: crawl and score pages for AI citation readiness.
get_geo_audit_statusGet audit status and results. Poll until completed.
get_geo_audit_pagesPage-level results with scores, issues, and recommendations.
list_geo_auditsList all GEO audit history with scores.
compare_geo_auditsCompare your audit scores against competitors.
list_prompt_notificationsList prompt notification configs.
set_prompt_notificationSet alerts for citation, mention, or lost mention changes.
delete_prompt_notificationRemove a prompt notification.
Rate Limits
Requests exceeding the limit receive a 429 Too Many Requests response with a Retry-After header.
Error Codes
All errors return a JSON body with a detail field describing the issue.