Humanloop Documentation and API Reference

Create a new project.

Request

This endpoint expects an object.

namestringRequired

Unique project name.

directory_idstringOptional

ID of directory to assign project to. Starts with dir_. If not provided, the project will be created in the root directory.

Response

Successful Response

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 -X POST https://api.humanloop.com/v4/projects \ 2 -H "X-API-KEY: <apiKey>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "name": "name" 6 }'

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

1	curl -X POST https://api.humanloop.com/v4/projects \
2	-H "X-API-KEY: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "name"
6	}'

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