Skip to content

list_snapshots

List available data snapshots for a project with their creation dates and sizes. Snapshots are grouped by upload batch. A snapshot is marked ‘referenced’ if it is used by a model run and cannot be deleted. Use ‘delete_snapshot’ to remove unreferenced snapshots. Returns: project_name (str) — project name; snapshots (list[{timestamp, prefix, file_count, total_size_bytes, referenced}]) — one entry per batch; total_count (int) — number of snapshot batches.

read-only · idempotent

NameTypeRequiredDefaultDescription
project_namestrYes

Returns a structured object. Top-level fields:

  • project_name (string)
  • snapshots (array<object>)
  • total_count (integer)

See the response example below for the full payload shape.

{
"name": "list_snapshots",
"arguments": {
"project_name": "forecasts"
}
}
{
"project_name": "forecasts",
"snapshots": [
{
"timestamp": "2026-04-28T10:00:00+00:00",
"prefix": "actuals/2026-04-28T10-00-00Z",
"file_count": 3,
"total_size_bytes": 2048,
"referenced": true
}
],
"total_count": 1
}
  • Module: Snapshots
  • Requires authentication via API token or Auth0 JWT.