Get Snapshot
get_snapshotRetrieve a preprod snapshot comparison by ID to inspect metadata, image counts, and changed images with pixel-difference percentages for failed visual regression or screenshot tests.
Instructions
Get a preprod snapshot comparison by ID, such as a failed visual regression or screenshot test from CI: its metadata, image counts, and changed images with the percent of pixels that differ. For an app's latest baseline screenshots, use get_latest_base_snapshot. For a snapshot URL, use get_sentry_resource.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"snapshotId": "<snapshotId>"
},
"name": "get_snapshot"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fresh | No | Bypass cached reads. | |
| regionUrl | No | ||
| snapshotId | Yes | Numeric snapshot artifact ID. | |
| showUnmodified | No | Also list unchanged and skipped images. Can make large snapshots much bigger. | |
| organizationSlug | No | The organization slug, from `find_organizations`. In `org/project` notation, the part before the slash. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | ||
| vcs | Yes | ||
| added | Yes | ||
| state | Yes | ||
| counts | Yes | ||
| images | No | Snapshot image inventory, present only when nothing changed. | |
| changed | Yes | ||
| errored | Yes | ||
| removed | Yes | ||
| renamed | Yes | ||
| skipped | No | Present only when showUnmodified=true. | |
| approval | Yes | ||
| projectId | Yes | ||
| unchanged | No | Present only when showUnmodified=true. | |
| snapshotId | Yes | ||
| responseNotes | Yes | ||
| comparisonType | Yes | ||
| organizationSlug | Yes |