API ReferenceProjects

Update a project

PATCH

Update the project settings for a specific project. For more information, see the following:

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.

If you are modifying the labeling config for project that has in-progress work, note the following:

  • You cannot remove labels or change the type of labeling being performed unless you delete any existing annotations that are using those labels.
  • If you make changes to the labeling configuration, any tabs that you might have created in the Data Manager are removed.

Path parameters

idintegerRequired
A unique integer value identifying this project.

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}
workspace
integerOptional
Workspace ID

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