API ReferenceProjects

Update a project

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.

Headers

AuthorizationstringRequired

Header authentication of the form Token <token>

Request

This endpoint expects an object.
titlestringOptional
Project title
descriptionstringOptional
Project description
label_configstringOptional
Label config in XML format
expert_instructionstringOptional
Labeling instructions to show to the user
show_instructionbooleanOptional
Show labeling instructions
show_skip_buttonbooleanOptional
Show skip button
enable_empty_annotationbooleanOptional
Allow empty annotations
show_annotation_historybooleanOptional
Show annotation history
reveal_preannotations_interactivelybooleanOptional
Reveal preannotations interactively. If set to True, predictions will be shown to the user only after selecting the area of interest
show_collab_predictionsbooleanOptional
Show predictions to annotators
maximum_annotationsintegerOptional
Maximum annotations per task
colorstringOptionalDefaults to #FFFFFF
Project color in HEX format
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 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}}

workspaceintegerOptional
Workspace ID
model_versionstringOptional
Model version

Response

titlestring or null
Project title
descriptionstring or null
Project description
label_configstring or null
Label config in XML format
expert_instructionstring or null
Labeling instructions to show to the user
show_instructionboolean or null
Show labeling instructions
show_skip_buttonboolean or null
Show skip button
enable_empty_annotationboolean or null
Allow empty annotations
show_annotation_historyboolean or null
Show annotation history
reveal_preannotations_interactivelyboolean or null
Reveal preannotations interactively. If set to True, predictions will be shown to the user only after selecting the area of interest
show_collab_predictionsboolean or null
Show predictions to annotators
maximum_annotationsinteger or null
Maximum annotations per task
annotation_limit_countinteger or null
Maximum number of annotations per annotator
annotation_limit_percentdouble or null
Maximum percentage of annotations per annotator
colorstring or nullDefaults to #FFFFFF
Project color in HEX format
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}}