List Files

GET

Get a paginated list of files.

Query parameters

pageintegerOptional

Page offset for pagination.

sizeintegerOptional

Page size for pagination. Number of files to fetch.

namestringOptional

Case-insensitive filter for file name.

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

order"asc" or "desc"Optional

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>"

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       "provider": "openai",
11       "max_tokens": 1,
12       "temperature": 1.1,
13       "top_p": 1.1,
14       "stop": "stop",
15       "presence_penalty": 1.1,
16       "frequency_penalty": 1.1,
17       "other": {
18         "key": "value"
19       },
20       "seed": 1,
21       "response_format": {
22         "type": "json_object"
23       },
24       "tools": [
25         {
26           "name": "name",
27           "description": "description"
28         }
29       ],
30       "linked_tools": [
31         {
32           "name": "name",
33           "description": "description",
34           "id": "id",
35           "version_id": "version_id"
36         }
37       ],
38       "attributes": {
39         "key": "value"
40       },
41       "commit_message": "commit_message",
42       "name": "name",
43       "version_id": "version_id",
44       "type": "prompt",
45       "environments": [
46         {
47           "id": "id",
48           "created_at": "2024-01-15T09:30:00Z",
49           "name": "name",
50           "tag": "default"
51         }
52       ],
53       "created_at": "2024-01-15T09:30:00Z",
54       "updated_at": "2024-01-15T09:30:00Z",
55       "created_by": {
56         "id": "id",
57         "email_address": "email_address"
58       },
59       "status": "uncommitted",
60       "last_used_at": "2024-01-15T09:30:00Z",
61       "version_logs_count": 1,
62       "total_logs_count": 1,
63       "inputs": [
64         {
65           "name": "name"
66         }
67       ],
68       "evaluator_aggregates": [
69         {
70           "value": 1.1,
71           "evaluator_id": "evaluator_id",
72           "evaluator_version_id": "evaluator_version_id",
73           "created_at": "2024-01-15T09:30:00Z",
74           "updated_at": "2024-01-15T09:30:00Z"
75         }
76       ]
77     }
78   ],
79   "page": 1,
80   "size": 1,
81   "total": 1
82 }

List Evaluations for a File

Up Next

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	"provider": "openai",
11	"max_tokens": 1,
12	"temperature": 1.1,
13	"top_p": 1.1,
14	"stop": "stop",
15	"presence_penalty": 1.1,
16	"frequency_penalty": 1.1,
17	"other": {
18	"key": "value"
19	},
20	"seed": 1,
21	"response_format": {
22	"type": "json_object"
23	},
24	"tools": [
25	{
26	"name": "name",
27	"description": "description"
28	}
29	],
30	"linked_tools": [
31	{
32	"name": "name",
33	"description": "description",
34	"id": "id",
35	"version_id": "version_id"
36	}
37	],
38	"attributes": {
39	"key": "value"
40	},
41	"commit_message": "commit_message",
42	"name": "name",
43	"version_id": "version_id",
44	"type": "prompt",
45	"environments": [
46	{
47	"id": "id",
48	"created_at": "2024-01-15T09:30:00Z",
49	"name": "name",
50	"tag": "default"
51	}
52	],
53	"created_at": "2024-01-15T09:30:00Z",
54	"updated_at": "2024-01-15T09:30:00Z",
55	"created_by": {
56	"id": "id",
57	"email_address": "email_address"
58	},
59	"status": "uncommitted",
60	"last_used_at": "2024-01-15T09:30:00Z",
61	"version_logs_count": 1,
62	"total_logs_count": 1,
63	"inputs": [
64	{
65	"name": "name"
66	}
67	],
68	"evaluator_aggregates": [
69	{
70	"value": 1.1,
71	"evaluator_id": "evaluator_id",
72	"evaluator_version_id": "evaluator_version_id",
73	"created_at": "2024-01-15T09:30:00Z",
74	"updated_at": "2024-01-15T09:30:00Z"
75	}
76	]
77	}
78	],
79	"page": 1,
80	"size": 1,
81	"total": 1
82	}