Getting Started

OverviewQuick StartInstant PreviewTry on Other SitesWorkspace

Integration

ConfigurationSecurity & PoliciesAI DiscoveryAgent-to-Web (A2W)

Reference

API ReferenceInstant Preview APIExamplesRoadmap

Try on Other Sites

This is the Workspace-config testing path for Rover. Start in Workspace, copy the test config JSON, paste it into the website tool, then generate the exact Helper, Console, or Bookmarklet artifact you need. The Preview Helper extension is public at rtrvr-ai/rover-preview-helper.

The exact order

  1. Open Workspace.
  2. Create a Rover site key. Workspace keeps the full owner-readable pk_site_* install material available whenever you reopen Install or Scripts.
  3. Open Install, then use Copy test config JSON.
  4. Open Live Test and stay on the Use Workspace config path.
  5. Paste the JSON, enter the website URL you want to test, then choose Helper, Console, or Bookmarklet.

Install the Preview Helper extension

  1. Open or clone rtrvr-ai/rover-preview-helper.
  2. From the repo root, run pnpm install.
  3. Run pnpm build.
  4. Open chrome://extensions, enable Developer mode, choose Load unpacked, and select the generated dist folder.
  5. Generate or copy Rover test config JSON from Workspace or Live Test.
  6. Paste that JSON into the helper popup, or use Open target with helper from Live Test to hand off config automatically.
git clone https://github.com/rtrvr-ai/rover-preview-helper.git
cd rover-preview-helper
pnpm install
pnpm build

Choose the right Rover path

PathWhat you needBest for
Hosted PreviewJust sign in, URL, and prompt.Rover-managed demos with no site config.
Preview HelperWorkspace test config JSON.Best multi-page desktop path.
ConsoleWorkspace test config JSON, then the generated snippet.Fast DevTools demos on the current page.
BookmarkletWorkspace test config JSON, then the generated bookmarklet.Drag-to-bookmarks demos on the current page.
Production installWorkspace install snippet.Your real live site, not arbitrary testing.

What the JSON is for

Test config JSON: portable Rover boot config for Helper, Console, Bookmarklet, and SDK testing on other sites.
Production install snippet: the snippet you put on your real website.
Hosted preview token: short-lived demo state created by Rover Hosted Preview, not a replacement for site config.

Expected config shape

Reusable wildcard config (recommended for testing)

{
  "siteId": "rover-live-test-config-...",
  "publicKey": "pk_site_...",
  "siteKeyId": "...",
  "apiBase": "https://agent.rtrvr.ai",
  "allowedDomains": ["*"],
  "domainScopeMode": "registrable_domain",
  "sessionScope": "shared_site",
  "openOnInit": true,
  "mode": "full",
  "allowActions": true,
  "capabilities": {
    "roverEmbed": true,
    "cloudAgent": true,
    "cloudScrape": true,
    "externalWebContextScrape": true
  },
  "ui": {
    "voice": {
      "enabled": true
    },
    "experience": {
      "audio": {
        "narration": {
          "enabled": true,
          "defaultMode": "guided",
          "rate": 1,
          "language": "en-US"
        }
      },
      "motion": {
        "actionSpotlight": true,
        "actionSpotlightColor": "#FF4C00"
      }
    }
  }
}

Exact site-scoped config

{
  "siteId": "site_123",
  "publicKey": "pk_site_123",
  "siteKeyId": "key_123",
  "apiBase": "https://agent.rtrvr.ai",
  "allowedDomains": ["example.com"],
  "domainScopeMode": "registrable_domain",
  "openOnInit": true,
  "mode": "full",
  "allowActions": true,
  "capabilities": { "roverEmbed": true },
  "ui": { "voice": { "enabled": true } }
}

The website tool validates this before generating anything, so you catch missing fields or bad domain scope early. Workspace and Live Test rely on Rover's built-in tab behavior: external pages open in a new tab with notice, and allowed-host hops use smart tab selection.

Choose the right method

Preview Helper

Best for multi-page desktop demos. The website tool can now open the target page with a helper handoff fragment, and the helper popup still accepts the same JSON as a fallback.

The helper now remembers your last-used config. After the first handoff via “Open target with helper” or a manual paste, subsequent sessions reuse the saved config automatically.

Console snippet

Best when DevTools is already open. Paste the generated code into the Console on the current page.

Bookmarklet

Best for the drag-to-bookmarks moment. It is still current-page only, so reloads will need another click.

When to use Hosted Preview instead

Hosted Preview is the Rover-managed demo path. Use it when you do not want to think about site config yet, when you need a temporary demo token, or when mobile / CSP / reload behavior makes live injection unreliable.

See Instant Preview for the hosted path.

Troubleshooting

`This API key is missing capability: roverEmbed`: your selected Workspace key is not embed-ready. Rotate or create a new key with Rover embed enabled, then copy the fresh JSON again.
The target host is outside `allowedDomains`: if using the reusable wildcard config, ensure allowedDomains contains ["*"]. If using exact site-scoped config, test on a host that matches your allowed domains, or switch to the reusable wildcard config for unrestricted testing.
Console or Bookmarklet stopped after navigation: that is expected on full reloads. Use the Preview Helper for multi-page testing.
The page still blocks Rover: some sites use CSP or reload patterns that fight injection. Switch to Hosted Preview.

Related links

Preview Helper repo to build and load the extension locally.
Workspace to create or replace the site key and copy the test config JSON.
Live Test to paste config and generate Helper, Console, or Bookmarklet output.
Live Test docs for hosted preview, helper handoff, console snippets, and bookmarklets.