Move Dataset | Humanloop Docs

Move the Dataset to a different path or change the name.

Authentication

X-API-KEYstring

API Key authentication via header

Path parameters

idstringRequired

Unique identifier for Dataset.

Request

This endpoint expects an object.

pathstringOptional

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

namestringOptional

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

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_idstring

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

descriptionstring

Description of the Dataset.

schemamap from strings to any

The JSON schema for the File.

readmestring

Long description of the file.

tagslist of strings

List of tags associated with the file.

type"dataset"

environmentslist of objects

The list of environments the Dataset Version is deployed to.

created_byany

The user who created the Dataset.

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.

datapointslist of objects

The list of Datapoints in this Dataset version. Only provided if explicitly requested.

attributesmap from strings to any

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

Errors

422

Move Datasets ID Patch Request Unprocessable Entity Error

1	curl -X PATCH https://api.humanloop.com/v5/datasets/id \
2	-H "X-API-KEY: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"path": "path",
3	"id": "id",
4	"name": "name",
5	"version_id": "version_id",
6	"created_at": "2024-01-15T09:30:00Z",
7	"updated_at": "2024-01-15T09:30:00Z",
8	"last_used_at": "2024-01-15T09:30:00Z",
9	"datapoints_count": 1,
10	"directory_id": "directory_id",
11	"description": "description",
12	"schema": {
13	"key": "value"
14	},
15	"readme": "readme",
16	"tags": [
17	"tags"
18	],
19	"type": "dataset",
20	"environments": [
21	{
22	"id": "id",
23	"created_at": "2024-01-15T09:30:00Z",
24	"name": "name",
25	"tag": "default"
26	}
27	],
28	"created_by": {
29	"id": "id",
30	"email_address": "email_address",
31	"full_name": "full_name"
32	},
33	"version_name": "version_name",
34	"version_description": "version_description",
35	"datapoints": [
36	{
37	"id": "id",
38	"inputs": {
39	"key": "value"
40	},
41	"messages": [
42	{
43	"role": "user"
44	}
45	],
46	"target": {
47	"key": "value"
48	}
49	}
50	],
51	"attributes": {
52	"key": "value"
53	}
54	}