List Files

GET

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.

templatebooleanOptionalDefaults to false

Filter to include only template files.

typeenumOptional

List of file types to filter for.

Allowed values: prompttooldatasetevaluatorflow

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: created_atupdated_atname

orderenumOptional

Direction to sort by.

Allowed values: ascdesc

Response

Successful Response

recordslist of objects

pageinteger

sizeinteger

totalinteger

Errors

GET

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

200Retrieved

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": "openai",
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       "commit_message": "commit_message",
44       "description": "description",
45       "tags": [
46         "tags"
47       ],
48       "readme": "readme",
49       "name": "name",
50       "version_id": "version_id",
51       "type": "prompt",
52       "environments": [
53         {
54           "id": "id",
55           "created_at": "2024-01-15T09:30:00Z",
56           "name": "name",
57           "tag": "default"
58         }
59       ],
60       "created_at": "2024-01-15T09:30:00Z",
61       "updated_at": "2024-01-15T09:30:00Z",
62       "created_by": {
63         "id": "id",
64         "email_address": "email_address"
65       },
66       "committed_by": {
67         "id": "id",
68         "email_address": "email_address"
69       },
70       "committed_at": "2024-01-15T09:30:00Z",
71       "status": "uncommitted",
72       "last_used_at": "2024-01-15T09:30:00Z",
73       "version_logs_count": 1,
74       "total_logs_count": 1,
75       "inputs": [
76         {
77           "name": "name"
78         }
79       ],
80       "evaluator_aggregates": [
81         {
82           "value": 1.1,
83           "evaluator_id": "evaluator_id",
84           "evaluator_version_id": "evaluator_version_id",
85           "created_at": "2024-01-15T09:30:00Z",
86           "updated_at": "2024-01-15T09:30:00Z"
87         }
88       ]
89     }
90   ],
91   "page": 1,
92   "size": 1,
93   "total": 1
94 }

Built with

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": "openai",
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	"commit_message": "commit_message",
44	"description": "description",
45	"tags": [
46	"tags"
47	],
48	"readme": "readme",
49	"name": "name",
50	"version_id": "version_id",
51	"type": "prompt",
52	"environments": [
53	{
54	"id": "id",
55	"created_at": "2024-01-15T09:30:00Z",
56	"name": "name",
57	"tag": "default"
58	}
59	],
60	"created_at": "2024-01-15T09:30:00Z",
61	"updated_at": "2024-01-15T09:30:00Z",
62	"created_by": {
63	"id": "id",
64	"email_address": "email_address"
65	},
66	"committed_by": {
67	"id": "id",
68	"email_address": "email_address"
69	},
70	"committed_at": "2024-01-15T09:30:00Z",
71	"status": "uncommitted",
72	"last_used_at": "2024-01-15T09:30:00Z",
73	"version_logs_count": 1,
74	"total_logs_count": 1,
75	"inputs": [
76	{
77	"name": "name"
78	}
79	],
80	"evaluator_aggregates": [
81	{
82	"value": 1.1,
83	"evaluator_id": "evaluator_id",
84	"evaluator_version_id": "evaluator_version_id",
85	"created_at": "2024-01-15T09:30:00Z",
86	"updated_at": "2024-01-15T09:30:00Z"
87	}
88	]
89	}
90	],
91	"page": 1,
92	"size": 1,
93	"total": 1
94	}