list_snapshots

List available data snapshots for a model 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. Pass workspace_id to list snapshots in a workspace other than your current one (requires an active membership and a grant on the model there; OAuth/JWT sessions only).

read-only · idempotent

Parameters

Name	Type	Required	Default	Description
model_name	Annotated[str, Field(description='Name of the Bridge Town model.')]	Yes	—
workspace_id	`Annotated[str	None, Field(description=WORKSPACE_ID_FIELD_DESCRIPTION)]`	No	None

Returns

Returns a structured object. Top-level fields:

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

See the response example below for the full payload shape.

Example

Tool Call

{
  "name": "list_snapshots",
  "arguments": {
    "model_name": "forecasts"
  }
}

Response

{
  "model_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
}

Notes

• Module: Snapshots
• Requires authentication via API token or Auth0 JWT.