Run a shareable brand preview
Generate a lightweight, public, shareable brand-page visibility report for any website URL.
Produce a fast, shareable brand-page report for any website URL — great for outreach — without creating or managing a Pendium agent. Trigger the preview, then poll for the finished report.
When to use
- Reach for this when you want a quick, public, shareable report for a URL (for example, an outreach link) rather than a full managed scan. Requires a Starter or Pro plan (LLM spend).
- This is distinct from a full visibility scan, which creates a Pendium-managed agent and returns raw LLM responses, query-level analysis, and history. Use that when you own the brand and want depth; use the preview when you want speed and a public link.
- For any brand's already-computed public score with no API key at all, use the brand score lookup.
Typical sequence
trigger_visibility_scan_preview— kick off the preview for a URL. Returns auuid.get_visibility_scan_preview— poll every 5–15s (byuuidor publicslug) untilstatus: "complete".
Tools
trigger_visibility_scan_preview
Trigger a lightweight Visibility Scan Preview for a website URL. 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.
Authentication: Paid (Starter or Pro). An account in read-only mode can't run a preview scan (LLM spend) — the tool errors with a read-only message.
| 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.
get_visibility_scan_preview
Read a structured Visibility Scan Preview by uuid (returned from trigger_visibility_scan_preview) or by public slug. Poll every 5–15s after triggering until status is complete.
Authentication: Required
| Parameter | Type | Required | Description |
|---|---|---|---|
uuid | string | One of uuid or slug | UUID returned from trigger_visibility_scan_preview. |
slug | string | One of uuid or slug | Public brand slug, e.g. acme. Only resolves public, completed reports. |
Status enum: pending → analyzing → complete (or failed). Once complete, returns the full report: brand identity, the two scores (overallScore, knowledgeScore) with levels, the LLM analysis (summary, observations, recommendations), persona archetypes, category prompts with per-platform mention estimates, post ideas, and the reportUrl.