GET /v1/jobs/{jobId}/snapshots/list
List a job's snapshots
ivy_ API key (Authorization: Bearer ivy_… or X-Ivy-Api-Key), a Clerk session JWT (Authorization: Bearer …) or the Clerk __session cookie (browser sessions). See Authentication.Lists the snapshot images stored for a job you can read, newest first. Each item pairs a PNG with the JSON file stored beside it, when there is one, and gives their storage locations as spaces://<bucket>/<key> URIs. These are storage locations, not download links.
Pass manifestChecksum to list only the snapshots stored under that manifest checksum. With includeContext=1, each item that has a JSON file also carries that file's parsed contents in context, and its checksum_sha256 when the file records one; a JSON file that cannot be read or parsed is skipped without an error. Results are paged: when truncated is true, pass nextCursor as cursor to continue.
Request
Path parameters
Job UUID.
Query parameters
Only list snapshots stored under this manifest checksum.
Set to 1 to include each snapshot's JSON contents as context. Any other value leaves it out.
Maximum number of snapshots to return, from 1 to 200. Defaults to 60.
The nextCursor value from a previous response.
Responses
200 OK
Response shape:
Snapshots, newest first
Pass as cursor to get the next page; null when there is no more
True when more snapshots remain beyond this page
400 Bad Request
Response shape: object
401 Unauthorized
Response shape: object
404 Not Found
Response shape: object
429 Too Many Requests
Response shape: object
500 Internal Server Error
Response shape: object
Was this page helpful?