--navigator-captures-video

CLI: --navigator-captures-video
REST: with_navigator_video

ValuePATH

LicensePro

Records the navigation session as a video alongside the primary output. On the server, the video is returned as a Link response header. The video leaves out the time the navigator spends deciding; due to this, it may appear that some frames “skip” as the underlying model thinks. A still longer than 1 s is cut to 1 s, except while a caption is held to be read or the navigator waits. An .mp4 path is periodically written as fragmented MP4 so the file may be played while the session is still running.

Overlays

The video shows the page as the navigator drives it. --navigator-video-shows-captions adds the navigator’s captions, and --navigator-video-shows-pointer draws the pointer.

Example

Run locally

zshot -f pipeline.png \
  --navigator-type "anthropic://YOUR_API_KEY@" \
  --navigator-credential email=success@zshot-app.com \
  --navigator-credential password=password \
  --navigate "Log in and open the pipeline" \
  --navigator-captures-video session.webm \
  https://zshot-cli.com/example_assets/zrm/

{
  "url": "https://zshot-cli.com/example_assets/zrm/",
  "output_type": "png",
  "navigate": "Log in and open the pipeline",
  "with_navigator_video": true,
  "navigator_type": ["anthropic://YOUR_API_KEY@"],
  "navigator_credential": { "email": "success@zshot-app.com", "password": "password" }
}

curl -X POST http://127.0.0.1:3000/ \
  -H "Content-Type: application/json" \
  -d '{"url":"https://zshot-cli.com/example_assets/zrm/","output_type":"png","navigate":"Log in and open the pipeline","with_navigator_video":true,"navigator_type":["anthropic://YOUR_API_KEY@"],"navigator_credential":{"email":"success@zshot-app.com","password":"password"}}' \
  -D - -o pipeline.png