Let your agent see
what changed.

Vizzly keeps the approved screenshots, diffs, comments, and review decisions with every build. Your agent can read what changed and what your team decided.

Examples
Add Vizzly to a repo Read the CLI guide
Create an account Read the MCP guide

Hosted MCP is in development.

$ 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
            
list_projects({})
list_builds({ "projectId": "<project-id>" })
inspect_build({ "buildId": "<build-id>" })

Find the request, then read the result

Start with the API schema. It lists supported requests and what each one needs. The build response gives you comparison IDs, and each ID gets you the details and images.

Read the CLI API guide

Find the build, then inspect the changes

Connect from your agent client and sign in through your browser. Choose organizations and permissions, then use the tools to find a build and read its results.

Read the MCP 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.

list_projects({})

Find a project

Find projects in the organizations you connected.

list_builds({ "projectId": "<project-id>" })

Find the build

Pick a build from the project. You can filter by branch too.

inspect_build({ "buildId": "<build-id>" })

Read the build

Read the summary, changed screenshots, and review state.

inspect_comparison({ "comparisonId": "<comparison-id>" })

Read one comparison

Look at what changed and how your team reviewed it.

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.

The comparison details line up with the review screen. comparison.result shows what changed, and comparison.review.state shows its review status. 

{
  "name": "checkout",
  "result": "changed",
  "review_state": "pending"
}
{
  "comparison": {
    "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.

Look at the images and history

View the current screenshot, baseline, or diff with a comparison ID. Read earlier captures to see how the screen has changed.

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.

view_comparison_image({ "comparisonId": "<comparison-id>", "kind": "diff" })

Open the diff to see what changed.

screenshot_history({ "projectId": "<project-id>", "screenshotName": "checkout" })

Read earlier captures of this screen. Local TDD results stay with the CLI.

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.

Use vizzly api schema for cloud requests and vizzly context ... --json for local TDD results.

You choose which organizations the app can access. Comments and review decisions need separate permissions. You can disconnect the app in Connected apps at any time.