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

Project information

idintegerOptional

titlestringOptional>=3 characters<=50 characters

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

promptslist of objectsOptional

colorstringOptional<=16 characters

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)

annotation_limit_countintegerOptional

Maximum number of tasks that can be annotated by a single annotator in this project pause

annotation_limit_percentdoubleOptional

Maximum percentage of tasks in this project that can be annotated by a single annotator

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_updatebooleanOptional

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:

show_ground_truth_firstbooleanOptional

show_overlap_firstbooleanOptional

overlap_cohort_percentageintegerOptional

task_data_loginstringOptional<=256 characters

Task data credentials: login

task_data_passwordstringOptional<=256 characters

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_tagsbooleanOptional

Flag to detect is project ready for labeling

skip_queueenumOptional

Allowed values:

reveal_preannotations_interactivelybooleanOptional

Reveal pre-annotations interactively

pinned_atdatetimeOptional

Pinned date and time

finished_task_numberintegerOptional

Finished tasks

queue_totalintegerOptional

queue_doneintegerOptional

1	from label_studio_sdk import LabelStudio
2
3	client = LabelStudio(
4	api_key="YOUR_API_KEY",
5	)
6	client.projects.get(
7	id=1,
8	)

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	"prompts": [
13	{
14	"title": "title",
15	"input_fields": [
16	"input_fields"
17	],
18	"output_classes": [
19	"output_classes"
20	],
21	"description": "description",
22	"created_by": 1,
23	"created_at": "2024-01-15T09:30:00Z",
24	"updated_at": "2024-01-15T09:30:00Z",
25	"organization": 1,
26	"associated_projects": [
27	1
28	],
29	"skill_name": "skill_name"
30	}
31	],
32	"color": "#FF0000",
33	"maximum_annotations": 1,
34	"annotation_limit_count": 10,
35	"annotation_limit_percent": 50,
36	"is_published": true,
37	"model_version": "1.0.0",
38	"is_draft": false,
39	"created_by": {
40	"id": 1,
41	"first_name": "Jo",
42	"last_name": "Doe",
43	"email": "manager@humansignal.com",
44	"avatar": "avatar"
45	},
46	"created_at": "2023-08-24T14:15:22Z",
47	"min_annotations_to_start_training": 0,
48	"start_training_on_annotation_update": true,
49	"show_collab_predictions": true,
50	"num_tasks_with_annotations": 10,
51	"task_number": 100,
52	"useful_annotation_number": 10,
53	"ground_truth_number": 5,
54	"skipped_annotations_number": 0,
55	"total_annotations_number": 10,
56	"total_predictions_number": 0,
57	"sampling": "Sequential sampling",
58	"show_ground_truth_first": true,
59	"show_overlap_first": true,
60	"overlap_cohort_percentage": 100,
61	"task_data_login": "user",
62	"task_data_password": "secret",
63	"control_weights": {
64	"key": "value"
65	},
66	"parsed_label_config": {
67	"key": "value"
68	},
69	"evaluate_predictions_automatically": false,
70	"config_has_control_tags": true,
71	"skip_queue": "REQUEUE_FOR_ME",
72	"reveal_preannotations_interactively": true,
73	"pinned_at": "2023-08-24T14:15:22Z",
74	"finished_task_number": 10,
75	"queue_total": 10,
76	"queue_done": 100
77	}

Path parameters

Headers

Response