Get Dataset
Retrieve the Dataset with the given ID.
Unless include_datapoints
is set to true
, the response will not include
the Datapoints.
Use the List Datapoints endpoint (GET /{id}/datapoints
) to efficiently
retrieve Datapoints for a large Dataset.
By default, the deployed version of the Dataset is returned. Use the query parameters
version_id
or environment
to target a specific version of the Dataset.
Path parameters
id
Unique identifier for Dataset.
Headers
X-API-KEY
Query parameters
version_id
A specific Version ID of the Dataset to retrieve.
environment
Name of the Environment to retrieve a deployed Version from.
include_datapoints
If set to true
, include all Datapoints in the response. Defaults to false
. Consider using the paginated List Datapoints endpoint instead.
Response
Successful Response
path
Path of the Dataset, including the name, which is used as a unique identifier.
id
Unique identifier for the Dataset. Starts with ds_
.
name
Name of the Dataset, which is used as a unique identifier.
version_id
Unique identifier for the specific Dataset Version. If no query params provided, the default deployed Dataset Version is returned. Starts with dsv_
.
created_at
updated_at
last_used_at
datapoints_count
The number of Datapoints in this Dataset version.
directory_id
ID of the directory that the file is in on Humanloop.
description
Description of the Dataset.
schema
The JSON schema for the File.
readme
Long description of the file.
type
environments
The list of environments the Dataset Version is deployed to.
created_by
The user who created the Dataset.
version_name
Unique name for the Dataset version. Version names must be unique for a given Dataset.
version_description
Description of the version, e.g., the changes made in this version.
datapoints
The list of Datapoints in this Dataset version. Only provided if explicitly requested.
attributes
Additional fields to describe the Dataset. Helpful to separate Dataset versions from each other with details on how they were created or used.