Retrieve by path

1 import { HumanloopClient } from "humanloop"; 2 3 const client = new HumanloopClient({ apiKey: "YOUR_API_KEY" }); 4 await client.files.retrieveByPath({ 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": "openai", 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 "commit_message": "commit_message", 53 "description": "description", 54 "tags": [ 55 "tags" 56 ], 57 "readme": "readme", 58 "name": "name", 59 "version_id": "version_id", 60 "type": "prompt", 61 "environments": [ 62 { 63 "id": "id", 64 "created_at": "2024-01-15T09:30:00Z", 65 "name": "name", 66 "tag": "default" 67 } 68 ], 69 "created_at": "2024-01-15T09:30:00Z", 70 "updated_at": "2024-01-15T09:30:00Z", 71 "created_by": { 72 "id": "id", 73 "email_address": "email_address", 74 "full_name": "full_name" 75 }, 76 "committed_by": { 77 "id": "id", 78 "email_address": "email_address", 79 "full_name": "full_name" 80 }, 81 "committed_at": "2024-01-15T09:30:00Z", 82 "status": "uncommitted", 83 "last_used_at": "2024-01-15T09:30:00Z", 84 "version_logs_count": 1, 85 "total_logs_count": 1, 86 "inputs": [ 87 { 88 "name": "name" 89 } 90 ], 91 "evaluator_aggregates": [ 92 { 93 "value": 1.1, 94 "evaluator_id": "evaluator_id", 95 "evaluator_version_id": "evaluator_version_id", 96 "created_at": "2024-01-15T09:30:00Z", 97 "updated_at": "2024-01-15T09:30:00Z" 98 } 99 ] 100 }

Retrieve a File by path.

Query parameters

environmentstringOptional

Name of the Environment to retrieve a deployed Version from.

Request

This endpoint expects an object.

pathstringRequired

Path of the File to retrieve.

Response

Successful Response

Prompt Responseobject

Tool Responseobject

Dataset Responseobject

Evaluator Responseobject

Flow Responseobject

Headers

Query parameters

Request

Response

Errors