AI Visibility runs
AI Visibility runs test how AI platforms answer prompts about a target entity.
One probe means one prompt sent to one platform for one target entity.
| Tool | Purpose | Scope |
|---|---|---|
create_sleepwalker_visibility_run | Queue a persisted AI Visibility run. | visibility:runs:create |
list_sleepwalker_visibility_runs | List direct AI Visibility runs. | runs:read |
get_sleepwalker_visibility_run_status | Poll one run and optionally include results. | runs:read |
create_sleepwalker_visibility_run
Section titled “create_sleepwalker_visibility_run”Use this when the user wants reportable probe results, not just prompt ideas.
Inputs
Section titled “Inputs”| Input | Type | Required | Notes |
|---|---|---|---|
url | string | Yes | Target URL. |
target_entity | string | Yes | Brand, product, or entity to detect. |
prompts | string[] | Conditional | Prompt list for matrix mode. |
platforms | string[] | Conditional | Platform list for matrix mode. |
probes | object[] | Conditional | Explicit probe rows. |
competitors | string[] | No | Competitor names to detect. |
language | string | No | Defaults to en. |
country | string | No | Defaults to US. |
idempotency_key | string | No | Retry-safe key. |
Send either:
promptsandplatforms, orprobes.
Matrix Mode
Section titled “Matrix Mode”Use matrix mode when the same target entity and locale apply to every prompt/platform combination.
Example user request:
Run these 10 AI Visibility prompts for Sleepwalker across the supported platforms.The agent should call create_sleepwalker_visibility_run once with a prompt list and platform list. It should not submit dozens or hundreds of independent one-off tool calls.
Explicit Probes
Section titled “Explicit Probes”Use explicit probes when each row needs different metadata.
Each probe can include:
| Field | Required | Notes |
|---|---|---|
prompt | Yes | Prompt text. |
platform | Yes | Supported platform value. |
language | No | Probe language. |
country | No | Probe market. |
target_entity | No | Overrides top-level target entity. |
Response Shape
Section titled “Response Shape”{ "run_id": "6a75b22b-...", "status": "queued", "estimated_credits": "20.00", "reserved_credits": "20.00", "probe_count": 20, "queued_probe_count": 20, "skipped_probe_count": 0}Partial Queueing
Section titled “Partial Queueing”If the account has enough credits for only part of a requested run, Sleepwalker can queue the funded probes and mark the rest as skipped.
The user can still inspect the probes that ran.
Example:
{ "status": "partially_queued", "probe_count": 100, "queued_probe_count": 37, "skipped_probe_count": 63, "skipped_reason": "insufficient_credits"}Polling
Section titled “Polling”After queueing a run, use:
get_sleepwalker_visibility_run_statusInputs:
| Input | Type | Required | Notes |
|---|---|---|---|
run_id | string | Yes | Run returned by create. |
include_probes | boolean | No | Defaults to true. |
include_results | boolean | No | Defaults to false. |
Poll every 10 to 30 seconds. For large runs, read compact status first and only request full results when needed.
Credits
Section titled “Credits”AI Visibility runs cost 1 credit per queued probe.
Examples:
| Request | Probes | Credits |
|---|---|---|
| 5 prompts x 4 platforms | 20 | 20 |
| 30 prompts x 1 platform | 30 | 30 |
| 100 prompts x 4 platforms | 400 | 400 |
Example Prompts
Section titled “Example Prompts”Create an AI Visibility run for Sleepwalker with these prompts across the supported platforms, then poll until complete.Check whether Sleepwalker is mentioned for "best AI visibility tools for SEO teams" on one platform.