Sleepwalker

AI Visibility and Content Intelligence for agents, products, and teams.
Run AI-search checks, inspect citations, score content, and save every result in one workspace.

Website · App · Docs · MCP · API · CLI · Cookbook

---

Sleepwalker helps teams understand how AI systems talk about a brand and what content needs to change. It combines two connected workflows:

• AI Visibility: run prompts across ChatGPT, Perplexity, Grok, and Gemini; capture full answers, citations, competitors, and mention types.
• Content Intelligence: serialize public pages, discover demand, score content depth and freshness, and return practical recommendations.

You can run the same work from the hosted app, the public API, MCP clients, or the CLI. Results stay connected, so a run started by an agent can be reviewed later in the app or queried from code.

This repository is the public developer surface for Sleepwalker: CLI package, API examples, MCP setup notes, and short guides. The hosted engine, app source, database schema, provider integrations, and billing systems are private.

Quickstart

Try the CLI without an account first. okf export is free and open source. It runs on your machine, fetches a page, and writes an agent-ready markdown bundle to a local folder. No API key, no credits:

npx -y @sleepwalkerai/cli okf export https://www.sleepwalker.ai

For everything else, install the CLI:

npm install -g @sleepwalkerai/cli
sleepwalker init

Create an API key in the Sleepwalker app, then run your first visibility check:

sleepwalker auth key set sw_api_live_...
sleepwalker doctor
sleepwalker visibility run https://yourbrand.com \
  --brand YourBrand \
  --prompt "best ai visibility platform 2026" \
  --platform perplexity,openai,grok,gemini \
  --watch

Want to see the shape of the data first? Open docs/responses.md for full example outputs from serialization, prompt suggestions, AI Visibility, Content Intelligence, and report lookup.

What you can build

• AI search (GEO) monitoring: set up prompt tracking for specific URLs across ChatGPT, Perplexity, Grok, and Gemini.
• Agent workflows: give MCP clients such as Claude access to LLM answers, cited domains, competitor performance, and content trends.
• Product integrations: use the API from internal tools, client portals, reporting pipelines, or automated QA checks.
• Content review: inspect what a page says, which trends it misses, and what to fix first.
• Free page export: turn any public page into agent-ready markdown with okf export. Open source, runs locally, no account needed.
• Custom workflows: combine Sleepwalker with other MCP servers to build your own skills and automations.

Access paths

Surface	Best for	Entry point
App	Human review, credits, keys, and full result views	app.sleepwalker.ai
API	Scripts, products, scheduled jobs, and reporting workflows	API docs
MCP	Claude and other MCP-capable agents	MCP setup
CLI	Terminal workflows and automation	CLI docs

Run Sleepwalker from anywhere

CLI

sleepwalker visibility run https://yourbrand.com \
  --brand YourBrand \
  --prompt "best ai visibility platform 2026" \
  --platform perplexity,openai,grok,gemini \
  --watch

API

curl -s https://api.sleepwalker.ai/v1/visibility/runs \
  -H "Authorization: Bearer $SLEEPWALKER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://yourbrand.com",
    "target_entity": "YourBrand",
    "prompts": ["best ai visibility platform 2026"],
    "platforms": ["perplexity","openai","grok","gemini"]
  }'

MCP

https://mcp.sleepwalker.ai/mcp

Ask an MCP-capable client: Check how YourBrand appears across AI search this week.

App

Open app.sleepwalker.ai for the visual workflow, saved results, credits, and keys.

Developer resources

Path	What it shows
docs/agents.md	MCP tool catalog and agent workflow walkthrough
docs/concepts.md	Runs, probes, serialization, scoring, credits
docs/cli.md	CLI usage, including the free local okf export
docs/cookbook.md	Runnable workflows, including CI checks
docs/responses.md	Full example outputs for the main Sleepwalker actions
mcp/server.json	Remote MCP server manifest
mcp/tools.json	Public MCP tool catalog, scopes, and credit behavior
examples/api/curl	One-call examples for public API actions
examples/api/javascript	Raw fetch plus a zero-dependency client helper
examples/api/python	urllib examples plus a small client class
examples/mcp	OAuth and bearer-token setup notes

Credits

Sleepwalker is pay as you go. Reads, lists, and status polling are normally unmetered. Actions that run work, such as visibility checks, content scoring, and serialization, use prepaid credits. okf export is the exception: it runs locally and is always free. Details live in docs/credits.md and the hosted billing docs.

Repository boundary

This repository is intentionally small.

Public here	Private in Sleepwalker
CLI, examples, setup notes, short docs	Hosted engine and app source
Public API request shapes	MCP server implementation
MCP client connection examples	Database schema and billing internals
Product-level credit behavior	Provider integrations and routing

Do not commit real keys. Use environment variables or the CLI key store:

export SLEEPWALKER_API_KEY=sw_api_live_...

Links

• Website: sleepwalker.ai
• App: app.sleepwalker.ai
• Docs: sleepwalker.ai/docs
• npm: @sleepwalkerai/cli
• Security policy: SECURITY.md
• Contributing: CONTRIBUTING.md
• License: MIT