Skip to content
sgp
API Reference

Dataset Items

Add items to an existing dataset
client.datasetItems.batchCreate(DatasetItemBatchCreateParams { data, dataset_id, files } body, RequestOptionsoptions?): DatasetItemBatchCreateResponse { items, object }
POST/v5/dataset-items/batch
Get a dataset item
client.datasetItems.retrieve(stringdatasetItemID, DatasetItemRetrieveParams { version } query?, RequestOptionsoptions?): DatasetItem { id, content_hash, created_at, 7 more }
GET/v5/dataset-items/{dataset_item_id}
Delete a dataset item
client.datasetItems.archive(stringdatasetItemID, RequestOptionsoptions?): DatasetItemArchiveResponse { id, deleted, object }
DELETE/v5/dataset-items/{dataset_item_id}
Update a dataset item
client.datasetItems.update(stringdatasetItemID, DatasetItemUpdateParams { data, files } body, RequestOptionsoptions?): DatasetItem { id, content_hash, created_at, 7 more }
PATCH/v5/dataset-items/{dataset_item_id}
List dataset items
client.datasetItems.list(DatasetItemListParams { dataset_id, ending_before, include_archived, 5 more } query?, RequestOptionsoptions?): CursorPage<DatasetItem { id, content_hash, created_at, 7 more } >
GET/v5/dataset-items
ModelsExpand Collapse
DatasetItem { id, content_hash, created_at, 7 more }
id: string

The unique identifier of the entity.

content_hash: string
created_at: string

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

formatdate-time
created_by: Identity { id, type, object }

The identity that created the entity.

id: string
type: "user" | "service_account"
One of the following:
"user"
"service_account"
object?: "identity"
data: Record<string, unknown>
updated_at: string

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

formatdate-time
archived_at?: string

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

formatdate-time
dataset_id?: string
files?: Record<string, string>
object?: "dataset.item"
DatasetItemBatchCreateResponse { items, object }
items: Array<DatasetItem { id, content_hash, created_at, 7 more } >
id: string

The unique identifier of the entity.

content_hash: string
created_at: string

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

formatdate-time
created_by: Identity { id, type, object }

The identity that created the entity.

id: string
type: "user" | "service_account"
One of the following:
"user"
"service_account"
object?: "identity"
data: Record<string, unknown>
updated_at: string

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

formatdate-time
archived_at?: string

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

formatdate-time
dataset_id?: string
files?: Record<string, string>
object?: "dataset.item"
object?: "list"
DatasetItemArchiveResponse { id, deleted, object }
id: string
deleted: boolean
object?: "dataset.item"