Optimly Developer Documentation

Optimly MCP

Simulate Agent Preview

In short

Run a controlled, read-only fetch of one configured public path using a declared AI agent identity. Returns status, outcome, redirects, bounded representation diagnostics, and a content fingerprint. This is simulated evidence, not observed live traffic or proof of a private agent's behavior.

simulate_agent_preview · Free · Authentication required

Run a controlled, read-only fetch of one configured public path using a declared AI agent identity. Returns status, outcome, redirects, bounded representation diagnostics, and a content fingerprint. This is simulated evidence, not observed live traffic or proof of a private agent's behavior.

When to use

Use to preview how a page responds to a specific declared agent identity before or after a fix.

Access

All plans with a connected Site Insights site

Parameters

ParameterTypeRequiredDescription
pathstringYesPublic pathname without query string or fragment.
agentstringYesDeclared agent identity for this controlled preview. Allowed values: openai_gptbot, openai_search, chatgpt_user, anthropic_claudebot, anthropic_user, perplexity_bot, perplexity_user, google_extended, common_crawl, applebot.
site_idstringYesConnected Site Insights site ID.
brand_iduuidYesAuthorized brand ID.

Example prompt

Fetch /docs as GPTBot and show me what it gets back.

Example request

{
  "path": "/docs",
  "agent": "openai_gptbot",
  "site_id": "site_123",
  "brand_id": "00000000-0000-4000-8000-000000000001"
}

Side effects and safety

Performs a read-only fetch against the configured site. Never publishes or changes the site.