Humanloop Documentation and API Reference

Get a specific project.

Path parameters

idstringRequired

String ID of project. Starts with pr_.

Response

This endpoint returns an object

idstring

Project ID

namestring

Unique project name.

userslist of objects

Users associated to the project.

data_countinteger

The count of datapoints that have been logged to the project.

feedback_typeslist of objects

The feedback types that have been defined in the project.

team_idstring

Unique ID of the team the project belongs to. Starts with tm_.

created_atdatetime

updated_atdatetime

active_configobjectOptional

Config that has been set as the project's active deployment.

config_typeenumOptional

Allowed values: genericmodeltoolagentevaluator

An enumeration.

active_evaluatorslist of objectsOptional

Evaluators that have been set as active for the project.

directory_idstringOptional

String ID of the directory the project belongs to. Starts with dir_.

Errors

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

1 { 2 "id": "id", 3 "name": "name", 4 "active_config": { 5 "project_id": "project_id", 6 "project_name": "project_name", 7 "created_at": "2024-01-15T09:30:00Z", 8 "updated_at": "2024-01-15T09:30:00Z", 9 "last_used": "2024-01-15T09:30:00Z", 10 "num_datapoints": 1, 11 "evaluation_aggregates": [ 12 { 13 "model_config_id": "model_config_id", 14 "evaluator_id": "evaluator_id", 15 "evaluator_version_id": "evaluator_version_id" 16 } 17 ], 18 "config": { 19 "type": "generic", 20 "id": "config", 21 "other": { 22 "key": "value" 23 }, 24 "created_by": { 25 "id": "id", 26 "email_address": "email_address", 27 "verified": true 28 }, 29 "status": "config", 30 "name": "config", 31 "description": "config" 32 } 33 }, 34 "users": [ 35 { 36 "id": "id", 37 "email_address": "email_address", 38 "full_name": "full_name" 39 } 40 ], 41 "data_count": 1, 42 "feedback_types": [ 43 { 44 "type": "rating", 45 "values": [ 46 { 47 "value": "value", 48 "sentiment": "positive" 49 } 50 ] 51 } 52 ], 53 "team_id": "team_id", 54 "config_type": "generic", 55 "active_evaluators": [ 56 { 57 "name": "name", 58 "description": "description", 59 "arguments_type": "target_free", 60 "return_type": "boolean", 61 "code": "code", 62 "model_config": { 63 "id": "id", 64 "model": "model" 65 }, 66 "type": "python", 67 "id": "id", 68 "created_at": "2024-01-15T09:30:00Z", 69 "updated_at": "2024-01-15T09:30:00Z" 70 } 71 ], 72 "directory_id": "directory_id", 73 "created_at": "2024-01-15T09:30:00Z", 74 "updated_at": "2024-01-15T09:30:00Z" 75 }

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

1	{
2	"id": "id",
3	"name": "name",
4	"active_config": {
5	"project_id": "project_id",
6	"project_name": "project_name",
7	"created_at": "2024-01-15T09:30:00Z",
8	"updated_at": "2024-01-15T09:30:00Z",
9	"last_used": "2024-01-15T09:30:00Z",
10	"num_datapoints": 1,
11	"evaluation_aggregates": [
12	{
13	"model_config_id": "model_config_id",
14	"evaluator_id": "evaluator_id",
15	"evaluator_version_id": "evaluator_version_id"
16	}
17	],
18	"config": {
19	"type": "generic",
20	"id": "config",
21	"other": {
22	"key": "value"
23	},
24	"created_by": {
25	"id": "id",
26	"email_address": "email_address",
27	"verified": true
28	},
29	"status": "config",
30	"name": "config",
31	"description": "config"
32	}
33	},
34	"users": [
35	{
36	"id": "id",
37	"email_address": "email_address",
38	"full_name": "full_name"
39	}
40	],
41	"data_count": 1,
42	"feedback_types": [
43	{
44	"type": "rating",
45	"values": [
46	{
47	"value": "value",
48	"sentiment": "positive"
49	}
50	]
51	}
52	],
53	"team_id": "team_id",
54	"config_type": "generic",
55	"active_evaluators": [
56	{
57	"name": "name",
58	"description": "description",
59	"arguments_type": "target_free",
60	"return_type": "boolean",
61	"code": "code",
62	"model_config": {
63	"id": "id",
64	"model": "model"
65	},
66	"type": "python",
67	"id": "id",
68	"created_at": "2024-01-15T09:30:00Z",
69	"updated_at": "2024-01-15T09:30:00Z"
70	}
71	],
72	"directory_id": "directory_id",
73	"created_at": "2024-01-15T09:30:00Z",
74	"updated_at": "2024-01-15T09:30:00Z"
75	}