--navigate

CLI: --navigate
REST: navigate

ValueINSTRUCTIONS

LicensePro

Hands the page to a navigator agent that carries out these instructions before the capture. A run with no output type, from -t or a -f extension, writes goal: what the navigator said when it finished, printed to stdout without -f.

A navigator requires an external LLM in order to accomplish its tasks.

Example

Ask about a page and print the answer:

Run locally

zshot --navigator-type "anthropic://YOUR_API_KEY@" \
  --navigate "In which chapter does Piglet meet a Heffalump?" \
  https://zshot-cli.com/example_assets/winnie-the-pooh/

{
  "url": "https://zshot-cli.com/example_assets/winnie-the-pooh/",
  "output_type": "goal",
  "navigate": "In which chapter does Piglet meet a Heffalump?",
  "navigator_type": ["anthropic://YOUR_API_KEY@"]
}

curl -X POST http://127.0.0.1:3000/ \
  -H "Content-Type: application/json" \
  -d '{"url":"https://zshot-cli.com/example_assets/winnie-the-pooh/","output_type":"goal","navigate":"In which chapter does Piglet meet a Heffalump?","navigator_type":["anthropic://YOUR_API_KEY@"]}'

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" \
  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",
  "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","navigator_type":["anthropic://YOUR_API_KEY@"],"navigator_credential":{"email":"success@zshot-app.com","password":"password"}}' \
  -o pipeline.png