--navigator-data

CLI: --navigator-data
REST: navigator_data

ValueNAME=VALUE

LicensePro

Gives the navigator a value of the task’s data, which it sees by name and value in every prompt and picks from to fill the page. Repeatable; the value may be empty.

The data reaches the model’s provider and appears in reproductions; use --navigator-credential for anything the model must not see. A --navigator-data value overrides the same name from every --navigator-data-json, and a later one overrides an earlier one. All names and values together hold at most 16,000 characters. A server takes navigator_data from each request, and refuses the flag at startup.

Example

Run locally

zshot -f pipeline.png \
  --navigator-type "anthropic://YOUR_API_KEY@" \
  --navigator-credential email=success@zshot-app.com \
  --navigator-credential password=password \
  --navigator-data region=EMEA \
  --navigate "Log in and filter the pipeline to my region" \
  https://zshot-cli.com/example_assets/zrm/

{
  "url": "https://zshot-cli.com/example_assets/zrm/",
  "output_type": "png",
  "navigate": "Log in and filter the pipeline to my region",
  "navigator_type": ["anthropic://YOUR_API_KEY@"],
  "navigator_credential": { "email": "success@zshot-app.com", "password": "password" },
  "navigator_data": { "region": "EMEA" }
}

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