Skip to content
SleepwalkerSleepwalkerSleepwalker Docs

Enums

Use these values when creating runs or filtering results.

Supported Platforms

Section titled “Supported Platforms”

Send these values in the platform field and the platforms array when creating an AI Visibility run.

Platform platform value
Perplexity perplexity
ChatGPT openai
Grok grok
Gemini gemini

Canonical values are recommended. Sleepwalker also accepts common labels such as ChatGPT, Perplexity AI, and Google Gemini, then stores the canonical value. A single run can target up to 4 platforms. See Limits.

Content Intelligence Depth

Section titled “Content Intelligence Depth”
Value Meaning
score Compact saved Content Intelligence analysis.
full Complete saved Content Intelligence analysis.

AI Visibility Run Statuses

Section titled “AI Visibility Run Statuses”
Status Meaning
queued Accepted and waiting to start.
running Work has started.
completed Work completed successfully.
partially_completed Some probes completed and some did not.
cancelled Work was cancelled or skipped before execution.
failed Work failed.

Create responses can also return partially_queued when only part of a requested AI Visibility run could be queued.

Content Intelligence Run Statuses

Section titled “Content Intelligence Run Statuses”
Status Meaning
queued Accepted and waiting to start.
running Work has started.
completed Work completed successfully.
cancelled Work was cancelled before execution.
failed Work failed.

Probe Statuses

Section titled “Probe Statuses”
Status Meaning
queued Probe is waiting to run.
running Probe is currently running.
succeeded Probe completed successfully.
errored Probe failed.
timed_out Probe exceeded its execution window.
cancelled Probe was not run.

Usage Event Statuses

Section titled “Usage Event Statuses”
Status Meaning
estimated Usage was estimated without reserving credits.
reserved Credits were reserved for queued work.
settled Credits were consumed for completed billable work.
released Reserved credits were released.
failed The usage event failed without a settled charge.

Credit Ledger Statuses

Section titled “Credit Ledger Statuses”
Status Meaning
posted Ledger row is posted.
pending Reservation is open.
settled Reservation was settled.
released Reservation was released.
void Ledger row was voided.

Language and Country

Section titled “Language and Country”

Use ISO-style codes:

Field Format Example
language ISO 639-1 language code, lower-case preferred en, nl, de, et
country ISO 3166-1 alpha-2 country code, upper-case preferred US, NL, DE, EE

AI Visibility and persisted Content Intelligence run creation normalize these values. One-off endpoints can echo the supplied value, so integrations should send canonical casing instead of relying on normalization. Use et with EE for Estonian-language checks focused on the Estonian market.