API ReferenceProjects

Get project by ID

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.

Headers

AuthorizationstringRequired

Header authentication of the form Token <token>

Response

Project information
idinteger or null
titlestring or null>=3 characters<=50 characters
Project name. Must be between 3 and 50 characters long.
descriptionstring or null
Project description
label_configstring or null
Label config in XML format. See more about it in documentation
expert_instructionstring or null
Labeling instructions in HTML format
show_instructionboolean or null
Show instructions to the annotator before they start
show_skip_buttonboolean or null
Show a skip button in interface and allow annotators to skip the task
enable_empty_annotationboolean or null
Allow annotators to submit empty annotations
show_annotation_historyboolean or null
Show annotation history to annotator
organizationinteger or null
promptslist of objects or null
colorstring or null<=16 characters
maximum_annotationsinteger or null

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_countinteger or null
Maximum number of tasks that can be annotated by a single annotator in this project pause
annotation_limit_percentdouble or null
Maximum percentage of tasks in this project that can be annotated by a single annotator
is_publishedboolean or null
Whether or not the project is published to annotators
model_versionstring or null
Machine learning model version
is_draftboolean or null
Whether or not the project is in the middle of being created
created_byobject or null
Project owner
created_atdatetime or null
min_annotations_to_start_traininginteger or null
Minimum number of completed tasks after which model training is started
start_training_on_annotation_updateboolean or null
Start model training after any annotations are submitted or updated
show_collab_predictionsboolean or null
If set, the annotator can view model predictions
num_tasks_with_annotationsinteger or null
Tasks with annotations count
task_numberinteger or null
Total task number in project
useful_annotation_numberinteger or null

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_numberinteger or null
Honeypot annotation number in project
skipped_annotations_numberinteger or null
Skipped by collaborators annotation number in project
total_annotations_numberinteger or null

Total annotations number in project including skipped_annotations_number and ground_truth_number.

total_predictions_numberinteger or null

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

samplingenum or null
Allowed values:
show_ground_truth_firstboolean or null
show_overlap_firstboolean or null
overlap_cohort_percentageinteger or null
task_data_loginstring or null<=256 characters

Task data credentials: login

task_data_passwordstring or null<=256 characters

Task data credentials: password

control_weightsmap from strings to any or null

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}}

parsed_label_configmap from strings to any or null

JSON-formatted labeling configuration

evaluate_predictions_automaticallyboolean or null
Retrieve and display predictions when loading a task
config_has_control_tagsboolean or null
Flag to detect is project ready for labeling
skip_queueenum or null
Allowed values:
reveal_preannotations_interactivelyboolean or null

Reveal pre-annotations interactively

pinned_atdatetime or null
Pinned date and time
finished_task_numberinteger or null
Finished tasks
queue_totalinteger or null
queue_doneinteger or null