Skip to content

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. Returns: project_name (str) — project name; snapshot_prefix (str) — prefix of the deleted batch; deleted_count (int) — number of S3 objects removed.

destructive

NameTypeRequiredDefaultDescription
project_namestrYes
snapshot_prefixstrYes

Returns a structured object. Top-level fields:

  • project_name (string)
  • snapshot_prefix (string)
  • deleted_count (integer)

See the response example below for the full payload shape.

{
"name": "delete_snapshot",
"arguments": {
"project_name": "forecasts",
"snapshot_prefix": "actuals/2026-04-28T10-00-00Z"
}
}
{
"project_name": "forecasts",
"snapshot_prefix": "actuals/2026-04-28T10-00-00Z",
"deleted_count": 3
}
  • Module: Snapshots
  • Requires authentication via API token or Auth0 JWT.