Pendium MCP Docs
REST API

Trigger an AI Visibility Report

Kick off a fast, shareable AI Visibility Report for a brand — perfect for outreach links and lead-gen workflows.

POST /api/visibility/ai-visibility-report

Authentication: Required

Trigger a lightweight AI Visibility Report — the single-shot megaprompt scan that powers the public /ai-visibility-report/{slug} brand-page report. Distinct from Trigger a Scan, which scans a Pendium-managed agent and produces a full report with raw LLM responses.

Use this endpoint when you want a fast, public, brand-page report. Typical use cases:

  • Cold-email outreach. Embed the returned reportUrl in an email — by the time the recipient clicks, the URL resolves to a polished /ai-visibility-report/{brand-slug} page.
  • Lead generation. Run a report on each new lead so the GTM team has scores + analysis ready in seconds.
  • In-app lead magnets. Power "scan your brand" flows that don't need to create a managed agent.

Reports complete in 30–90 seconds. Poll Get an AI Visibility Report for results.

Request body

{
  "url": "https://acme.com",
  "isPublic": true
}
FieldTypeRequiredDefaultDescription
urlstringYes—Website URL to scan. Must be a real, active business website.
isPublicbooleanNotrueIf true (recommended for outreach), the completed report is reachable at /ai-visibility-report/{slug} — slug-canonical and indexable. If false, the report stays at the per-UUID preview URL.

How it works

  1. The endpoint enqueues a single-shot megaprompt LLM call against ChatGPT, Claude, Gemini, and AI Overviews to estimate visibility.
  2. It returns immediately with a uuid and reportUrl pointing at the per-UUID preview URL.
  3. Once the scan completes (and isPublic=true), that preview URL automatically 308-redirects to the canonical brand-slug URL — so you can embed the preview URL in outreach drafts immediately and it'll resolve to the slug page by the time the recipient clicks.

Free-plan users are blocked at this endpoint with a PLAN_UPGRADE_REQUIRED error. No credits are deducted — onboarding scans are inexpensive.

Example

curl -X POST https://pendium.ai/api/visibility/ai-visibility-report \
  -H "Content-Type: application/json" \
  -H "x-api-key: pendium_xxxxxxxxxxxx" \
  -d '{"url": "https://acme.com"}'

Response

{
  "success": true,
  "uuid": "775ba0fc-c67a-4ff2-aa0a-e1c15a638d4a",
  "status": "pending",
  "isPublic": true,
  "reportUrl": "https://pendium.ai/ai-visibility-report/preview/775ba0fc-c67a-4ff2-aa0a-e1c15a638d4a",
  "previewUrl": "https://pendium.ai/ai-visibility-report/preview/775ba0fc-c67a-4ff2-aa0a-e1c15a638d4a",
  "message": "AI Visibility Report triggered. Poll GET /api/visibility/ai-visibility-report?uuid=… every 5-15 seconds until status='complete'."
}

If you're on the free plan:

{
  "error": "API-triggered AI Visibility Reports require a Starter or Pro plan",
  "code": "PLAN_UPGRADE_REQUIRED",
  "currentPlan": "free",
  "upgradeUrl": "https://pendium.ai/pricing"
}

For email/SMS outreach where you don't want to pre-pay for compute on people who never click, you can skip this endpoint entirely and link recipients to:

https://pendium.ai/?report=https://acme.com

The homepage reads the ?report= param and triggers the AI Visibility Report on click — anonymous recipients sign in via Privy first, then land at the live in-progress report. Already-authenticated recipients are routed straight through.

Previous

Get Report

Next

Get an AI Visibility Report

On this page