delete_snapshot

Delete an unreferenced snapshot batch from S3. The snapshot prefix must match exactly the ‘prefix’ field returned by ‘list_snapshots’. Snapshots referenced by a model run cannot be deleted and will return an error. This operation is irreversible. Requires at least Editor role. Pass workspace_id to delete a snapshot in a workspace other than your current one (requires an active membership and an Editor/Owner grant on the model there; OAuth/JWT sessions only).

destructive

Parameters

Name	Type	Required	Default	Description
model_name	Annotated[str, Field(description='Name of the Bridge Town model.')]	Yes	—
snapshot_prefix	Annotated[str, Field(description='Prefix of the snapshot to delete (returned by list_snapshots as the snapshot identifier).')]	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)
• snapshot_prefix (string)
• deleted_count (integer)

See the response example below for the full payload shape.

Example

Tool Call

{
  "name": "delete_snapshot",
  "arguments": {
    "model_name": "forecasts",
    "snapshot_prefix": "actuals/2026-04-28T10-00-00Z"
  }
}

Response

{
  "model_name": "forecasts",
  "snapshot_prefix": "actuals/2026-04-28T10-00-00Z",
  "deleted_count": 3
}

Notes

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