Get

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

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.

tagslist of strings

List of tags associated with the 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_.

descriptionstringOptional

Description of the directory.

readmestringOptional

Long description of the directory.

Path parameters

Headers

Response

Errors