Let your agent see
what changed.

Vizzly keeps approved screenshots, diffs, comments, and review decisions with each build. The CLI schema shows agents how to find that information.

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

How it works

Find the request, then inspect the result.

Start with the schema. It lists the requests Vizzly supports and explains what each one needs. Build context gives you comparison IDs; use one to inspect its images.

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

Find the build request

Read 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 build evidence

Get changed comparisons, results, and review state.

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

Read comparison details

Check review state and which images are available.

Inspect the screenshots too.

Use a comparison ID from the build response to save its current screenshot, baseline, or diff. The schema lists the accepted image kinds.

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

The CLI saves the diff so an agent can open it and compare it with the baseline.

vizzly context build current --source local --json

Read local TDD results from the current checkout. Local results do not need cloud authentication.

Review stays with your team.

Agents can inspect changes and explain what they find. Review requests can change Vizzly, so check the operation details and use them when the task calls for it.

The context build --agent and context comparison --agent options are deprecated in CLI 0.37.x and will be removed in 0.38.0. Use the API schema for cloud requests. Local TDD context still works with --json.

vizzly init --agent-guidance remains available for adding Vizzly instructions to a repository.