Get project by ID — API Reference

Retrieve information about a specific project by project ID. The project ID can be found in the URL when viewing the project in Label Studio, or you can retrieve all project IDs using List all projects.

Path parameters

idintegerRequired

A unique integer value identifying this project.

Response

This endpoint returns an object.

idintegerOptional

titlestringOptional

Project name. Must be between 3 and 50 characters long.

descriptionstringOptional

Project description

label_configstringOptional

Label config in XML format. See more about it in documentation

expert_instructionstringOptional

Labeling instructions in HTML format

show_instructionbooleanOptional

Show instructions to the annotator before they start

show_skip_buttonbooleanOptional

Show a skip button in interface and allow annotators to skip the task

enable_empty_annotationbooleanOptional

Allow annotators to submit empty annotations

show_annotation_historybooleanOptional

Show annotation history to annotator

organizationintegerOptional

colorstringOptional

maximum_annotationsintegerOptional

Maximum number of annotations for one task. If the number of annotations per task is equal or greater to this value, the task is completed (is_labeled=True)

is_publishedbooleanOptional

Whether or not the project is published to annotators

model_versionstringOptional

Machine learning model version

is_draftbooleanOptional

Whether or not the project is in the middle of being created

created_byobjectOptional

Project owner

created_atdatetimeOptional

min_annotations_to_start_trainingintegerOptional

Minimum number of completed tasks after which model training is started

start_training_on_annotation_updatestringOptional

Start model training after any annotations are submitted or updated

show_collab_predictionsbooleanOptional

If set, the annotator can view model predictions

num_tasks_with_annotationsintegerOptional

Tasks with annotations count

task_numberintegerOptional

Total task number in project

useful_annotation_numberintegerOptional

Useful annotation number in project not including skipped_annotations_number and ground_truth_number. Total annotations = annotation_number + skipped_annotations_number + ground_truth_number

ground_truth_numberintegerOptional

Honeypot annotation number in project

skipped_annotations_numberintegerOptional

Skipped by collaborators annotation number in project

total_annotations_numberintegerOptional

Total annotations number in project including skipped_annotations_number and ground_truth_number.

total_predictions_numberintegerOptional

Total predictions number in project including skipped_annotations_number, ground_truth_number, and useful_annotation_number.

samplingenumOptional

Allowed values: Sequential samplingUniform samplingUncertainty sampling

show_ground_truth_firstbooleanOptional

show_overlap_firstbooleanOptional

overlap_cohort_percentageintegerOptional

task_data_loginstringOptional

Task data credentials: login

task_data_passwordstringOptional

Task data credentials: password

control_weightsmap from strings to anyOptional

Dict of weights for each control tag in metric calculation. Each control tag (e.g. label or choice) will have it's own key in control weight dict with weight for each label and overall weight.For example, if bounding box annotation with control tag named my_bbox should be included with 0.33 weight in agreement calculation, and the first label Car should be twice more important than Airplaine, then you have to need the specify: {'my_bbox': {'type': 'RectangleLabels', 'labels': {'Car': 1.0, 'Airplaine': 0.5}, 'overall': 0.33}

parsed_label_configmap from strings to anyOptional

JSON-formatted labeling configuration

evaluate_predictions_automaticallybooleanOptional

Retrieve and display predictions when loading a task

config_has_control_tagsstringOptional

Flag to detect is project ready for labeling

skip_queueenumOptional

Allowed values: REQUEUE_FOR_MEREQUEUE_FOR_OTHERSIGNORE_SKIPPED

reveal_preannotations_interactivelybooleanOptional

Reveal pre-annotations interactively

pinned_atdatetimeOptional

Pinned date and time

finished_task_numberintegerOptional

Finished tasks

queue_totalstringOptional

queue_donestringOptional

1	{
2	"id": 1,
3	"title": "My project",
4	"description": "My first project",
5	"label_config": "<View>[...]</View>",
6	"expert_instruction": "Label all cats",
7	"show_instruction": true,
8	"show_skip_button": true,
9	"enable_empty_annotation": true,
10	"show_annotation_history": true,
11	"organization": 1,
12	"color": "#FF0000",
13	"maximum_annotations": 1,
14	"is_published": true,
15	"model_version": "1.0.0",
16	"is_draft": false,
17	"created_by": {
18	"id": 1,
19	"first_name": "Jo",
20	"last_name": "Doe",
21	"email": "manager@humansignal.com",
22	"avatar": "avatar"
23	},
24	"created_at": "2023-08-24T14:15:22Z",
25	"min_annotations_to_start_training": 0,
26	"start_training_on_annotation_update": "start_training_on_annotation_update",
27	"show_collab_predictions": true,
28	"num_tasks_with_annotations": 10,
29	"task_number": 100,
30	"useful_annotation_number": 10,
31	"ground_truth_number": 5,
32	"skipped_annotations_number": 0,
33	"total_annotations_number": 10,
34	"total_predictions_number": 0,
35	"sampling": "Sequential sampling",
36	"show_ground_truth_first": true,
37	"show_overlap_first": true,
38	"overlap_cohort_percentage": 100,
39	"task_data_login": "user",
40	"task_data_password": "secret",
41	"control_weights": {
42	"key": "value"
43	},
44	"parsed_label_config": {
45	"key": "value"
46	},
47	"evaluate_predictions_automatically": false,
48	"config_has_control_tags": "config_has_control_tags",
49	"skip_queue": "REQUEUE_FOR_ME",
50	"reveal_preannotations_interactively": true,
51	"pinned_at": "2023-08-24T14:15:22Z",
52	"finished_task_number": 10,
53	"queue_total": "queue_total",
54	"queue_done": "queue_done"
55	}

1	curl http://localhost:8080/api/projects/1/ \
2	-H "Authorization: Token <api_key>"