--navigator-data-json

CLI: --navigator-data-json
REST: navigator_data_json

ValueJSON

LicensePro

Gives the navigator a JSON object of the task’s data, as --navigator-data does one value. Repeatable.

Value	Read
Inline JSON	When the request is built
A file path	When the request is built
An `http(s)` URL	Before the page is navigated, through the same IP filter as the page, within 10 seconds and at most 1 MiB

Nested names join with dots, as address.city. A URL that fails causes an error. A server takes navigator_data_json as an array of objects and URLs, 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-json https://zshot-cli.com/example_assets/zrm/territory.json \
  --navigator-data-json '{"territory": {"stage": "Proposal"}}' \
  --navigate "Log in and filter the pipeline to my territory" \
  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 territory",
  "navigator_type": ["anthropic://YOUR_API_KEY@"],
  "navigator_credential": { "email": "success@zshot-app.com", "password": "password" },
  "navigator_data_json": ["https://zshot-cli.com/example_assets/zrm/territory.json", {"territory": {"stage": "Proposal"}}]
}

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 territory","navigator_type":["anthropic://YOUR_API_KEY@"],"navigator_credential":{"email":"success@zshot-app.com","password":"password"},"navigator_data_json":["https://zshot-cli.com/example_assets/zrm/territory.json",{"territory":{"stage":"Proposal"}}]}' \
  -o pipeline.png