Retrieve by path

1 curl -X POST https://api.humanloop.com/v5/files/retrieve-by-path \ 2 -H "X-API-KEY: <apiKey>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "path": "path" 6 }'

1 { 2 "path": "path", 3 "id": "id", 4 "directory_id": "directory_id", 5 "model": "model", 6 "endpoint": "complete", 7 "template": "template", 8 "template_language": "default", 9 "provider": "anthropic", 10 "max_tokens": 1, 11 "temperature": 1.1, 12 "top_p": 1.1, 13 "stop": "stop", 14 "presence_penalty": 1.1, 15 "frequency_penalty": 1.1, 16 "other": { 17 "key": "value" 18 }, 19 "seed": 1, 20 "response_format": { 21 "type": "json_object", 22 "json_schema": { 23 "key": "value" 24 } 25 }, 26 "reasoning_effort": "high", 27 "tools": [ 28 { 29 "name": "name", 30 "description": "description", 31 "strict": true, 32 "parameters": { 33 "key": "value" 34 } 35 } 36 ], 37 "linked_tools": [ 38 { 39 "name": "name", 40 "description": "description", 41 "strict": true, 42 "parameters": { 43 "key": "value" 44 }, 45 "id": "id", 46 "version_id": "version_id" 47 } 48 ], 49 "attributes": { 50 "key": "value" 51 }, 52 "version_name": "version_name", 53 "version_description": "version_description", 54 "description": "description", 55 "tags": [ 56 "tags" 57 ], 58 "readme": "readme", 59 "name": "name", 60 "schema": { 61 "key": "value" 62 }, 63 "version_id": "version_id", 64 "type": "prompt", 65 "environments": [ 66 { 67 "id": "id", 68 "created_at": "2024-01-15T09:30:00Z", 69 "name": "name", 70 "tag": "default" 71 } 72 ], 73 "created_at": "2024-01-15T09:30:00Z", 74 "updated_at": "2024-01-15T09:30:00Z", 75 "created_by": { 76 "id": "id", 77 "email_address": "email_address", 78 "full_name": "full_name" 79 }, 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 "raw_file_content": "raw_file_content" 98 }

Retrieve a File by path.

Query parameters

environmentstringOptional

Name of the Environment to retrieve a deployed Version from.

include_raw_file_contentbooleanOptionalDefaults to false

Whether to include the raw file content in the response. Currently only supported for Agents and Prompts.

Request

This endpoint expects an object.

pathstringRequired

Path of the File to retrieve.

Response

Successful Response

object

Headers

Query parameters

Request

Response

Errors