Humanloop Documentation and API Reference

Fetches a directory by ID.

Path parameters

idstringRequired

String ID of directory. Starts with dir_.

Response

Successful Response

idstring

String ID of directory. Starts with dir_.

namestring

Name of the directory.

pathstring

Path to the directory, relative to the root directory. Includes name, e.g. path/to/directory.

created_atdatetime

updated_atdatetime

subdirectorieslist of objects

List of subdirectories in the directory.

fileslist of objects

List of files in the directory.

parentslist of objects

List of parent directories of the directory.

parent_idstringOptional

ID of the parent directory. Will be None if the directory is the root directory. Starts with dir_.

Errors

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

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

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

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