List Environments

GET

List all Environments and their deployed versions for the Dataset.

Path parameters

idstringRequired

Unique identifier for Dataset.

Response

This endpoint returns a list of objects.

idstring

created_atdatetime

namestring

tag"default" or "other"

Allowed values: defaultother

An enumeration.

fileobject or anyOptional

The version of the File that is deployed to the Environment, if one is deployed.

Errors

GET

1 curl https://api.humanloop.com/v5/datasets/id/environments \
2      -H "X-API-KEY: <apiKey>"

1 [
2   {
3     "id": "id",
4     "created_at": "2024-01-15T09:30:00Z",
5     "name": "name",
6     "tag": "default",
7     "file": {
8       "path": "path",
9       "id": "id",
10       "directory_id": "directory_id",
11       "model": "model",
12       "endpoint": "complete",
13       "template": "template",
14       "provider": "openai",
15       "max_tokens": 1,
16       "temperature": 1.1,
17       "top_p": 1.1,
18       "stop": "stop",
19       "presence_penalty": 1.1,
20       "frequency_penalty": 1.1,
21       "other": {
22         "key": "value"
23       },
24       "seed": 1,
25       "response_format": {
26         "type": "json_object"
27       },
28       "tools": [
29         {
30           "name": "name",
31           "description": "description"
32         }
33       ],
34       "linked_tools": [
35         {
36           "name": "name",
37           "description": "description",
38           "id": "id",
39           "version_id": "version_id"
40         }
41       ],
42       "attributes": {
43         "key": "value"
44       },
45       "commit_message": "commit_message",
46       "name": "name",
47       "version_id": "version_id",
48       "type": "prompt",
49       "environments": [
50         {
51           "id": "id",
52           "created_at": "2024-01-15T09:30:00Z",
53           "name": "name",
54           "tag": "default"
55         }
56       ],
57       "created_at": "2024-01-15T09:30:00Z",
58       "updated_at": "2024-01-15T09:30:00Z",
59       "created_by": {
60         "id": "id",
61         "email_address": "email_address"
62       },
63       "status": "uncommitted",
64       "last_used_at": "2024-01-15T09:30:00Z",
65       "version_logs_count": 1,
66       "total_logs_count": 1,
67       "inputs": [
68         {
69           "name": "name"
70         }
71       ],
72       "evaluator_aggregates": [
73         {
74           "value": 1.1,
75           "evaluator_id": "evaluator_id",
76           "evaluator_version_id": "evaluator_version_id",
77           "created_at": "2024-01-15T09:30:00Z",
78           "updated_at": "2024-01-15T09:30:00Z"
79         }
80       ]
81     }
82   }
83 ]

Built with

1	curl https://api.humanloop.com/v5/datasets/id/environments \
2	-H "X-API-KEY: <apiKey>"

1	[
2	{
3	"id": "id",
4	"created_at": "2024-01-15T09:30:00Z",
5	"name": "name",
6	"tag": "default",
7	"file": {
8	"path": "path",
9	"id": "id",
10	"directory_id": "directory_id",
11	"model": "model",
12	"endpoint": "complete",
13	"template": "template",
14	"provider": "openai",
15	"max_tokens": 1,
16	"temperature": 1.1,
17	"top_p": 1.1,
18	"stop": "stop",
19	"presence_penalty": 1.1,
20	"frequency_penalty": 1.1,
21	"other": {
22	"key": "value"
23	},
24	"seed": 1,
25	"response_format": {
26	"type": "json_object"
27	},
28	"tools": [
29	{
30	"name": "name",
31	"description": "description"
32	}
33	],
34	"linked_tools": [
35	{
36	"name": "name",
37	"description": "description",
38	"id": "id",
39	"version_id": "version_id"
40	}
41	],
42	"attributes": {
43	"key": "value"
44	},
45	"commit_message": "commit_message",
46	"name": "name",
47	"version_id": "version_id",
48	"type": "prompt",
49	"environments": [
50	{
51	"id": "id",
52	"created_at": "2024-01-15T09:30:00Z",
53	"name": "name",
54	"tag": "default"
55	}
56	],
57	"created_at": "2024-01-15T09:30:00Z",
58	"updated_at": "2024-01-15T09:30:00Z",
59	"created_by": {
60	"id": "id",
61	"email_address": "email_address"
62	},
63	"status": "uncommitted",
64	"last_used_at": "2024-01-15T09:30:00Z",
65	"version_logs_count": 1,
66	"total_logs_count": 1,
67	"inputs": [
68	{
69	"name": "name"
70	}
71	],
72	"evaluator_aggregates": [
73	{
74	"value": 1.1,
75	"evaluator_id": "evaluator_id",
76	"evaluator_version_id": "evaluator_version_id",
77	"created_at": "2024-01-15T09:30:00Z",
78	"updated_at": "2024-01-15T09:30:00Z"
79	}
80	]
81	}
82	}
83	]