Projects

Create new project

POST

Create a project and set up the labeling interface. For more information about setting up projects, see the following:

$curl -H Content-Type:application/json -H 'Authorization: Token abc123' -X POST 'https://localhost:8080/api/projects' --data '{"label_config": "<View>[...]</View>"}'

Request

This endpoint expects an object.
title
stringOptional
Project title
description
stringOptional
Project description
label_config
stringOptional
Label config in XML format
expert_instruction
stringOptional
Labeling instructions to show to the user
show_instruction
booleanOptional
Show labeling instructions
show_skip_button
booleanOptional
Show skip button
enable_empty_annotation
booleanOptional
Allow empty annotations
show_annotation_history
booleanOptional
Show annotation history
reveal_preannotations_interactively
booleanOptional
Reveal preannotations interactively. If set to True, predictions will be shown to the user only after selecting the area of interest
show_collab_predictions
booleanOptional
Show predictions to annotators
maximum_annotations
integerOptional
Maximum annotations per task
color
stringOptionalDefaults to #FFFFFF
Project color in HEX format
control_weights
map from strings to anyOptional
Dict of weights for each control tag in metric calculation. Each control tag (e.g. label or choice) will have its own key in control weight dict with weight for each label and overall weight. For example, if a bounding box annotation with a control tag named my_bbox should be included with 0.33 weight in agreement calculation, and the first label Car should be twice as important as Airplane, then you need to specify: {'my_bbox': {'type': 'RectangleLabels', 'labels': {'Car': 1.0, 'Airplane': 0.5}, 'overall': 0.33}

Response

This endpoint returns an object
title
stringOptional
Project title
description
stringOptional
Project description
label_config
stringOptional
Label config in XML format
expert_instruction
stringOptional
Labeling instructions to show to the user
show_instruction
booleanOptional
Show labeling instructions
show_skip_button
booleanOptional
Show skip button
enable_empty_annotation
booleanOptional
Allow empty annotations
show_annotation_history
booleanOptional
Show annotation history
reveal_preannotations_interactively
booleanOptional
Reveal preannotations interactively. If set to True, predictions will be shown to the user only after selecting the area of interest
show_collab_predictions
booleanOptional
Show predictions to annotators
maximum_annotations
integerOptional
Maximum annotations per task
color
stringOptionalDefaults to #FFFFFF
Project color in HEX format
control_weights
map from strings to anyOptional
Dict of weights for each control tag in metric calculation. Each control tag (e.g. label or choice) will have its own key in control weight dict with weight for each label and overall weight. For example, if a bounding box annotation with a control tag named my_bbox should be included with 0.33 weight in agreement calculation, and the first label Car should be twice as important as Airplane, then you need to specify: {'my_bbox': {'type': 'RectangleLabels', 'labels': {'Car': 1.0, 'Airplane': 0.5}, 'overall': 0.33}
POST
1curl -X POST http://localhost:8080/api/projects/ \
2 -H "Authorization: Token <api_key>" \
3 -H "Content-Type: application/json" \
4 -d '{}'
200Successful
1{
2 "title": "My project",
3 "description": "My first project",
4 "label_config": "<View>[...]</View>",
5 "expert_instruction": "Label all cats",
6 "show_instruction": true,
7 "show_skip_button": true,
8 "enable_empty_annotation": true,
9 "show_annotation_history": true,
10 "reveal_preannotations_interactively": true,
11 "show_collab_predictions": true,
12 "maximum_annotations": 1,
13 "color": "color",
14 "control_weights": {
15 "my_bbox": {
16 "type": "RectangleLabels",
17 "labels": {
18 "Car": 1,
19 "Airplaine": 0.5
20 },
21 "overall": 0.33
22 }
23 }
24}