Humanloop Documentation and API Reference

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

idstringRequired

Unique identifier for Dataset.

Query parameters

version_idstringOptional

A specific Version ID of the Dataset to retrieve.

environmentstringOptional

Name of the Environment to retrieve a deployed Version from.

include_datapointsbooleanOptional

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

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

statusenum

Allowed values: uncommittedcommitteddeleted

The status of the Dataset Version.

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.

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.

committed_byanyOptional

The user who committed the Dataset Version.

committed_atdatetimeOptional

The date and time the Dataset Version was committed.

commit_messagestringOptional

Message describing the changes made. If provided, a committed version of the Dataset is created. Otherwise, an uncommitted version is created.

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.

1	curl -G https://api.humanloop.com/v5/datasets/ds_b0baF1ca7652 \
2	-H "X-API-KEY: <apiKey>" \
3	-d version_id=dsv_6L78pqrdFi2xa \
4	-d include_datapoints=true

1	{
2	"path": "test-questions",
3	"id": "ds_345mno",
4	"name": "test-questions",
5	"version_id": "dsv_678pqr",
6	"created_at": "2024-05-01T12:00:00Z",
7	"updated_at": "2024-05-01T12:00:00Z",
8	"status": "committed",
9	"last_used_at": "2024-05-01T12:00:00Z",
10	"datapoints_count": 2,
11	"type": "dataset",
12	"datapoints": [
13	{
14	"id": "dp_123456",
15	"inputs": {
16	"question": "What is the capital of France?"
17	},
18	"target": {
19	"answer": "Paris"
20	}
21	},
22	{
23	"id": "dp_789012",
24	"inputs": {
25	"question": "Who wrote Hamlet?"
26	},
27	"target": {
28	"answer": "William Shakespeare"
29	}
30	}
31	]
32	}

Get Dataset

Path parameters

Query parameters

Response

Errors