Read tools

Read tools let agents inspect existing Sleepwalker data owned by the authenticated account.

They do not create runs and do not consume credits.

Required scopes:

tests:read
runs:read

Tool Summary

Tool	Use it for	Scope
list_sleepwalker_tests	List saved Content Intelligence and AI Visibility tests.	tests:read
get_sleepwalker_summaries	Scan compact recent run summaries.	runs:read
get_sleepwalker_test_results	Fetch latest run history for one saved test.	runs:read
get_sleepwalker_reports_by_url	Find owned reports matching a URL.	runs:read
get_sleepwalker_run_result	Fetch one structured run result.	runs:read
get_sleepwalker_prompt_response	Fetch one capped AI Visibility prompt response.	runs:read
get_sleepwalker_consistent_recommendations	Find recurring Content Intelligence recommendations.	runs:read

list_sleepwalker_tests

Lists saved tests for the authenticated account.

Input	Type	Required	Notes
limit	integer	No	Maximum 50.
test_type	string	No	content_intelligence or ai_citations.
brand_name	string	No	Filters by brand name.

Use this first when the agent needs a test_id.

get_sleepwalker_summaries

Returns compact run summaries before drilling into specific results.

Input	Type	Required	Notes
days	integer	No	1 to 30.
limit	integer	No	Maximum 100.
test_id	string	No	Filter to one saved test.
test_type	string	No	content_intelligence or ai_citations.
brand_name	string	No	Filter by brand name.

Use this when the user asks for a recent account overview.

get_sleepwalker_test_results

Fetches compact latest run history for one saved test.

Input	Type	Required	Notes
test_id	string	Yes	Owned saved test ID.
limit	integer	No	Maximum 5.

Use get_sleepwalker_run_result after this when the user chooses a specific run.

get_sleepwalker_reports_by_url

Finds saved tests and recent reports that match a URL.

Input	Type	Required	Notes
url	string	Yes	URL to search for.
test_type	string	No	content_intelligence or ai_citations.
days	integer	No	1 to 365.
limit	integer	No	Maximum 20.

Use this when the user starts with a URL instead of a test name.

get_sleepwalker_run_result

Fetches one structured run result.

Input	Type	Required	Notes
run_id	string	Yes	Owned run ID.

For AI Visibility runs, raw prompt response bodies are intentionally not returned as one large payload. Use get_sleepwalker_prompt_response.

get_sleepwalker_prompt_response

Fetches one AI Visibility prompt response chunk.

Input	Type	Required	Notes
run_id	string	Yes	Owned AI Visibility run ID.
result_index	integer	No	Flattened result index.
platform	string	No	Platform filter.
prompt_index	integer	No	Prompt index, defaults to 0.
include_citations	boolean	No	Defaults to true.
max_chars	integer	No	1 to 25,000.
offset	integer	No	Use for long responses.

Use this when the user wants the actual answer text, citations, or a specific prompt/platform response.

get_sleepwalker_consistent_recommendations

Finds recommendations that recur across recent Content Intelligence runs.

Input	Type	Required	Notes
test_id	string	Yes	Owned Content Intelligence test ID.
runs	integer	No	1 to 10.
min_frequency	integer	No	Minimum number of runs where a recommendation must appear.

Use this when the user asks what keeps coming up across repeated checks.

Example Prompts

List my Sleepwalker tests and show the latest AI Visibility runs.

Find reports for https://www.example.com and summarize the latest result.

Open the latest visibility run and fetch the first Perplexity prompt response.