Let your agent see
what changed.

Vizzly keeps the approved screenshots, diffs, comments, and review decisions with every build. Your agent finds all of it through the CLI's API schema.

Add Vizzly to a repo Read the API guide 
$ vizzly api schema --json
$ vizzly api schema sdk.getBuildContext --json
$ vizzly api /api/sdk/context/builds/abc123 \
  -H 'Vizzly-API-Version: 2026-09-12' -q limit=10 --json

Find the request, then read the result

Start with the schema. It lists every request Vizzly supports and what each one needs. The build response gives you comparison IDs, and each ID gets you the details and images.

Read the API guide
$ vizzly api schema sdk.getBuildContext --json

Find the build request

See its method, version header, and query options.

$ vizzly api /api/sdk/context/builds/<build-id> -H 'Vizzly-API-Version: 2026-09-12' -q limit=10 --json

Read the build

Get the changed screenshots, results, and review state.

$ vizzly api /api/sdk/context/comparisons/<id> -H 'Vizzly-API-Version: 2026-09-12' --json

Read one comparison

Check its review state and which images you can download.

Same review your team sees

The JSON your agent reads lines up with the review screen. result is the Result row in Details, and review_state is the Review row. When your team approves a change, your agent sees it too. 

{
  "name": "checkout",
  "result": "changed",
  "review_state": "pending"
}

checkout

1/3
Chromium 1440×900 Light Url/checkout

Checkout

Back up every paw print.

Family plan

Storage2 TB
PetsUnlimited
Total$9/mo
Start free trial

Checkout

Back up every paw print.

Family plan

Storage2 TB
PetsUnlimited
Billed yearlySave 20%
Total$7.20/mo
Start free trial
1 / 3

Grab the screenshots too

Use a comparison ID to save the current screenshot, the baseline, or the diff. The schema lists every image kind.

vizzly api /api/sdk/context/comparisons/<id>/images/diff -H 'Vizzly-API-Version: 2026-09-12' -o diff.png

Saves the diff so your agent can open it next to the baseline.

vizzly context build current --source local --json

Reads local TDD results from your checkout. No login needed.

Your team still decides what ships

Agents can dig into changes and explain what they find. Some requests change things in Vizzly, like approvals, so check the operation details before your agent runs one.

Want Vizzly instructions in your repo? Run vizzly init --agent-guidance.

Still using --agent on context build or context comparison? It goes away in CLI 0.38.0, so switch to vizzly api.