Skip to content
sgp
API Reference
Dataset Items

Delete a dataset item

dataset_items.archive(strdataset_item_id) -> DatasetItemArchiveResponse
DELETE/v5/dataset-items/{dataset_item_id}

Soft-delete a dataset item by marking it as removed in the current dataset version.

The database row is not removed; instead the item’s end version is set to the current dataset version so it no longer appears at the latest version while remaining retrievable at earlier versions, and a new dataset version snapshot is created to record the removal. An item that is already archived or already deleted cannot be deleted again. The response echoes the item id with deleted set to true.

ParametersExpand Collapse
dataset_item_id: str
ReturnsExpand Collapse
class DatasetItemArchiveResponse: …
id: str
deleted: bool
object: Optional[Literal["dataset.item"]]

Delete a dataset item

import os
from scale_gp_beta import SGPClient

client = SGPClient(
    api_key=os.environ.get("SGP_API_KEY"),  # This is the default and can be omitted
)
response = client.dataset_items.archive(
    "dataset_item_id",
)
print(response.id)
{
  "id": "id",
  "deleted": true,
  "object": "dataset.item"
}
Returns Examples
{
  "id": "id",
  "deleted": true,
  "object": "dataset.item"
}