Sign in
datasets > dataset

Get Dataset By Id

Get a dataset by its unique identifier

get/api/v1/datasets/{dataset_id}

Path parameters

dataset_idstring uuid required

Query parameters

include_deletedboolean

Headers

Authorizationstring required

Bearer authentication

Response

Successful Response

created_dtstring date-time required

The created datetime of the resource in ISO 8601 format.

updated_dtstring date-time nullable

The datetime the resource was last updated in ISO 8601 format.

created_bystring required

ID of the user who added the asset to the dataset.

updated_bystring nullable

ID of the user who last updated the asset.

deleted_dtstring date-time nullable

Timestamp if the resource was deleted.

deleted_bystring nullable

ID of the user who deleted the resource.

idstring uuid required

The unique identifier for the dataset.

namestring required

Name of the dataset, must be unique per organization and must only contain alphanumeric and underscore characters.

descriptionstring nullable required

A short summary of what the dataset includes or is intended for.

allowed_asset_typesDatasetsAssetTypeEnum[] required

Types of assets allowed in this dataset.

status'active' | 'inactive' | 'deleting' | 'deleted' required

Indicates the operational status of a dataset

keyframe_sampling_method'intelligent' | 'uniform' required

Indicates the method used to sample keyframes from a video

keyframe_uniform_fps_sampling_ratenumber double nullable

FPS rate used for uniform sampling.

store_originalboolean required

Whether the original file is stored.

store_previewboolean required

Whether preview files are stored.

metadata_fields_to_indexstring[] nullable

The metadata fields to index for the dataset.

metadata_fields_to_embedstring[] nullable

The metadata fields to embed for the dataset.

Changes