Skip to content
sgp
API Reference

Dataset Items

Add items to an existing dataset
dataset_items.batch_create(DatasetItemBatchCreateParams**kwargs) -> DatasetItemBatchCreateResponse
POST/v5/dataset-items/batch
Get a dataset item
dataset_items.retrieve(strdataset_item_id, DatasetItemRetrieveParams**kwargs) -> DatasetItem
GET/v5/dataset-items/{dataset_item_id}
Delete a dataset item
dataset_items.archive(strdataset_item_id) -> DatasetItemArchiveResponse
DELETE/v5/dataset-items/{dataset_item_id}
Update a dataset item
dataset_items.update(strdataset_item_id, DatasetItemUpdateParams**kwargs) -> DatasetItem
PATCH/v5/dataset-items/{dataset_item_id}
List dataset items
dataset_items.list(DatasetItemListParams**kwargs) -> SyncCursorPage[DatasetItem]
GET/v5/dataset-items
ModelsExpand Collapse
class DatasetItem: …
id: str

The unique identifier of the entity.

content_hash: str
created_at: datetime

The date and time when the entity was created in ISO format.

formatdate-time
created_by: Identity

The identity that created the entity.

id: str
type: Literal["user", "service_account"]
One of the following:
"user"
"service_account"
object: Optional[Literal["identity"]]
data: Dict[str, object]
updated_at: datetime

The date and time when the entity was last updated in ISO format.

formatdate-time
archived_at: Optional[datetime]

The date and time when the entity was archived in ISO format.

formatdate-time
dataset_id: Optional[str]
files: Optional[Dict[str, str]]
object: Optional[Literal["dataset.item"]]
class DatasetItemBatchCreateResponse: …
items: List[DatasetItem]
id: str

The unique identifier of the entity.

content_hash: str
created_at: datetime

The date and time when the entity was created in ISO format.

formatdate-time
created_by: Identity

The identity that created the entity.

id: str
type: Literal["user", "service_account"]
One of the following:
"user"
"service_account"
object: Optional[Literal["identity"]]
data: Dict[str, object]
updated_at: datetime

The date and time when the entity was last updated in ISO format.

formatdate-time
archived_at: Optional[datetime]

The date and time when the entity was archived in ISO format.

formatdate-time
dataset_id: Optional[str]
files: Optional[Dict[str, str]]
object: Optional[Literal["dataset.item"]]
object: Optional[Literal["list"]]
class DatasetItemArchiveResponse: …
id: str
deleted: bool
object: Optional[Literal["dataset.item"]]