trigger_visibility_scan_preview
Run a lightweight, shareable brand-page preview report for any website URL.
Trigger a lightweight Visibility Scan Preview for a website URL. It produces a single shareable brand-page report with two scores (overall AI visibility 0–100 and direct-brand knowledge 0–100), a summary, observations, recommendations, persona archetypes, and category prompts. Reports typically complete in 30–90 seconds — poll with get_visibility_scan_preview.
This is distinct from scan_visibility, which creates a Pendium-managed agent and runs a full scan with raw LLM responses. Use the preview when you want a fast, public, shareable report — for example, for outreach — without managing an agent.
Authentication: Required — Starter or Pro plan.
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
url | string (URL) | Yes | — | Website URL to scan, e.g. https://acme.com. |
isPublic | boolean | No | true | true: the report is slug-addressable at /brand/preview/{slug} (best for outreach links). false: kept at the per-UUID preview URL only. Partner accounts: scans are always private and shared via the white-labeled partner URL — isPublic is ignored (no public slug is assigned), so leave it out. The partner-only REST endpoint POST /api/visibility/scan-preview accepts isPublic: true for backward compatibility but coerces it to false and returns a deprecation warning. |
Returns
uuid, status (pending), reportUrl, and isPublic. Poll get_visibility_scan_preview with the uuid every 5–15 seconds until status is complete.