List

GET

Get a paginated list of files.

Query parameters

pageintegerOptionalDefaults to 0

Page offset for pagination.

sizeintegerOptionalDefaults to 10

Page size for pagination. Number of projects to fetch.

filterstringOptional

Case-insensitive filter for project name.

user_filterstringOptional

Case-insensitive filter for users in the project. This filter matches against both email address and name of users.

sort_byenumOptional

Field to sort projects 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/v4/projects \
2      -H "X-API-KEY: <apiKey>"

200Retrieved

1 {
2   "records": [
3     {
4       "id": "id",
5       "name": "name",
6       "users": [
7         {
8           "id": "id",
9           "email_address": "email_address"
10         }
11       ],
12       "data_count": 1,
13       "feedback_types": [
14         {
15           "type": "rating"
16         }
17       ],
18       "team_id": "team_id",
19       "created_at": "2024-01-15T09:30:00Z",
20       "updated_at": "2024-01-15T09:30:00Z",
21       "active_config": {
22         "project_id": "project_id",
23         "project_name": "project_name",
24         "created_at": "2024-01-15T09:30:00Z",
25         "updated_at": "2024-01-15T09:30:00Z",
26         "last_used": "2024-01-15T09:30:00Z",
27         "config": {
28           "type": "model",
29           "id": "id",
30           "model": "model"
31         }
32       },
33       "config_type": "generic",
34       "active_evaluators": [
35         {
36           "name": "name",
37           "description": "description",
38           "arguments_type": "target_free",
39           "return_type": "boolean",
40           "type": "python",
41           "id": "id",
42           "created_at": "2024-01-15T09:30:00Z",
43           "updated_at": "2024-01-15T09:30:00Z"
44         }
45       ],
46       "directory_id": "directory_id"
47     }
48   ],
49   "page": 1,
50   "size": 1,
51   "total": 1
52 }

Built with

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

1	{
2	"records": [
3	{
4	"id": "id",
5	"name": "name",
6	"users": [
7	{
8	"id": "id",
9	"email_address": "email_address"
10	}
11	],
12	"data_count": 1,
13	"feedback_types": [
14	{
15	"type": "rating"
16	}
17	],
18	"team_id": "team_id",
19	"created_at": "2024-01-15T09:30:00Z",
20	"updated_at": "2024-01-15T09:30:00Z",
21	"active_config": {
22	"project_id": "project_id",
23	"project_name": "project_name",
24	"created_at": "2024-01-15T09:30:00Z",
25	"updated_at": "2024-01-15T09:30:00Z",
26	"last_used": "2024-01-15T09:30:00Z",
27	"config": {
28	"type": "model",
29	"id": "id",
30	"model": "model"
31	}
32	},
33	"config_type": "generic",
34	"active_evaluators": [
35	{
36	"name": "name",
37	"description": "description",
38	"arguments_type": "target_free",
39	"return_type": "boolean",
40	"type": "python",
41	"id": "id",
42	"created_at": "2024-01-15T09:30:00Z",
43	"updated_at": "2024-01-15T09:30:00Z"
44	}
45	],
46	"directory_id": "directory_id"
47	}
48	],
49	"page": 1,
50	"size": 1,
51	"total": 1
52	}