APIDatasets

Deploy Dataset

Deploy Dataset to Environment. Set the deployed version for the specified Environment.

Path parameters

idstringRequired
Unique identifier for Dataset.
environment_idstringRequired
Unique identifier for the Environment to deploy the Version to.

Headers

X-API-KEYstringRequired

Query parameters

version_idstringRequired
Unique identifier for the specific version of the Dataset.

Response

Successful Response
pathstring
Path of the Dataset, including the name, which is used as a unique identifier.
idstring

Unique identifier for the Dataset. Starts with ds_.

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

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

created_atdatetime
updated_atdatetime
last_used_atdatetime
datapoints_countinteger
The number of Datapoints in this Dataset version.
directory_idstringOptional
ID of the directory that the file is in on Humanloop.
descriptionstringOptional
Description of the Dataset.
schemamap from strings to anyOptional
The JSON schema for the File.
readmestringOptional
Long description of the file.
tagslist of stringsOptional
List of tags associated with the file.
type"dataset"OptionalDefaults to dataset
environmentslist of objectsOptional
The list of environments the Dataset Version is deployed to.
created_byanyOptional
The user who created the Dataset.
version_namestringOptional
Unique name for the Dataset version. Version names must be unique for a given Dataset.
version_descriptionstringOptional
Description of the version, e.g., the changes made in this version.
datapointslist of objectsOptional
The list of Datapoints in this Dataset version. Only provided if explicitly requested.
attributesmap from strings to anyOptional
Additional fields to describe the Dataset. Helpful to separate Dataset versions from each other with details on how they were created or used.

Errors