Skip to content

followanton/sleepwalker

Repository files navigation

Sleepwalker

CI MIT CLI npm version Zero dependencies MCP ready

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

npm install -g @sleepwalkerai/cli
sleepwalker init

Or run one command without installing:

npx -y @sleepwalkerai/cli doctor

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

Sleepwalker CLI running an AI Visibility check

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

Sample AI Visibility result across platforms

  • AI Search (GEO) monitoring: Setup prompt tracking against specific URLs across ChatGPT, Perplexity, Grok and Gemini.
  • Agent workflows: let MCP-capable clients (such as Claude) get access to vast Sleepwalker data, featuring LLM answers, cited domains, competitor performance, content trends and much more.
  • Product integrations: use the API from internal tools, client portals, reporting pipelines, or automated QA checks.
  • In-depth content review: inspect what a page says, which trends it misses, and what should be fixed first.
  • Mix and match Sleepwalker capabilities: Create custom skills and workflows involving other MCPs to match your business requirements.

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

Sleepwalker action flow across app, API, MCP, and CLI

Run It 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/cookbook.md Runnable workflows, including CI checks
docs/responses.md Full example outputs for the main Sleepwalker actions
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. 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

About

Use Sleepwalker to access AI visibility data (prompts, answers, citations) and Content Intelligence insights (trends, opportunities). Available via MCP, API, CLI and Sleepwalker App..

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors