List Files

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

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

Get a paginated list of files.

Query parameters

pageintegerOptional>=1Defaults to 1

Page offset for pagination.

sizeintegerOptional>=0Defaults to 10

Page size for pagination. Number of files to fetch.

namestringOptional

Case-insensitive filter for file name.

pathstringOptional

Path of the directory to filter for. Returns files in this directory and all its subdirectories.

templatebooleanOptionalDefaults to false

Filter to include only template files.

typeenumOptional

List of file types to filter for.

environmentstringOptional

Case-sensitive filter for files with a deployment in the specified environment. Requires the environment name.

sort_byenumOptional

Field to sort files by

Allowed values:

orderenumOptional

Direction to sort by.

Allowed values:

include_raw_file_contentbooleanOptionalDefaults to false

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

Response

Successful Response

recordslist of objects

pageinteger

sizeinteger

totalinteger

Headers

Query parameters

Response

Errors