Datasets

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.

get/datasets/{id}

Request

  • Base URL: https://api.humanloop.com/v5
  • URL: https://api.humanloop.com/v5/datasets/{id}
  • Auth: API key in header X-API-KEY

Path parameters

idstring required

Unique identifier for Dataset.

Query parameters

version_idstring

A specific Version ID of the Dataset to retrieve.

environmentstring

Name of the Environment to retrieve a deployed Version from.

include_datapointsboolean

If set to true, include all Datapoints in the response. Defaults to false. Consider using the paginated List Datapoints endpoint instead.

Response

Successful Response

pathstring required

Path of the Dataset, including the name, which is used as a unique identifier.

idstring required

Unique identifier for the Dataset. Starts with ds_.

directory_idstring

ID of the directory that the file is in on Humanloop.

namestring required

Name of the Dataset, which is used as a unique identifier.

descriptionstring

Description of the Dataset.

schemaobject

The JSON schema for the File.

readmestring

Long description of the file.

tagsstring[]

List of tags associated with the file.

version_idstring required

Unique identifier for the specific Dataset Version. If no query params provided, the default deployed Dataset Version is returned. Starts with dsv_.

type'dataset'
created_atstring date-time required
updated_atstring date-time required
created_byunknown
last_used_atstring date-time required
version_namestring

Unique name for the Dataset version. Version names must be unique for a given Dataset.

version_descriptionstring

Description of the version, e.g., the changes made in this version.

datapoints_countinteger required

The number of Datapoints in this Dataset version.

attributesobject

Additional fields to describe the Dataset. Helpful to separate Dataset versions from each other with details on how they were created or used.

Changes

No recorded changes to this operation across all 1 revision of this API.