Skip to content

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.

ToolPurposeScope
create_sleepwalker_visibility_runQueue a persisted AI Visibility run.visibility:runs:create
list_sleepwalker_visibility_runsList direct AI Visibility runs.runs:read
get_sleepwalker_visibility_run_statusPoll one run and optionally include results.runs:read

Use this when the user wants reportable probe results, not just prompt ideas.

InputTypeRequiredNotes
urlstringYesTarget URL.
target_entitystringYesBrand, product, or entity to detect.
promptsstring[]ConditionalPrompt list for matrix mode.
platformsstring[]ConditionalPlatform list for matrix mode.
probesobject[]ConditionalExplicit probe rows.
competitorsstring[]NoCompetitor names to detect.
languagestringNoDefaults to en.
countrystringNoDefaults to US.
idempotency_keystringNoRetry-safe key.

Send either:

  • prompts and platforms, or
  • probes.

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.

Use explicit probes when each row needs different metadata.

Each probe can include:

FieldRequiredNotes
promptYesPrompt text.
platformYesSupported platform value.
languageNoProbe language.
countryNoProbe market.
target_entityNoOverrides top-level target entity.
{
"run_id": "6a75b22b-...",
"status": "queued",
"estimated_credits": "20.00",
"reserved_credits": "20.00",
"probe_count": 20,
"queued_probe_count": 20,
"skipped_probe_count": 0
}

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"
}

After queueing a run, use:

get_sleepwalker_visibility_run_status

Inputs:

InputTypeRequiredNotes
run_idstringYesRun returned by create.
include_probesbooleanNoDefaults to true.
include_resultsbooleanNoDefaults to false.

Poll every 10 to 30 seconds. For large runs, read compact status first and only request full results when needed.

AI Visibility runs cost 1 credit per queued probe.

Examples:

RequestProbesCredits
5 prompts x 4 platforms2020
30 prompts x 1 platform3030
100 prompts x 4 platforms400400
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.