Update project details

PATCH

http://localhost:8000/api/projects/:id/

PATCH

/api/projects/:id/

$ curl -X PATCH http://localhost:8000/api/projects/1/ \
>      -H "Authorization: Token  <api_key>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

200Updated

1 {
2   "assignment_settings": {
3     "id": 1,
4     "label_stream_task_distribution": "auto_distribution",
5     "project": 1
6   },
7   "config_has_control_tags": true,
8   "config_suitable_for_bulk_annotation": true,
9   "created_at": "2024-01-15T09:30:00Z",
10   "finished_task_number": 1,
11   "ground_truth_number": 1,
12   "id": 1,
13   "num_tasks_with_annotations": 1,
14   "parsed_label_config": {},
15   "prompts": "string",
16   "queue_done": 1,
17   "queue_total": 1,
18   "review_settings": {
19     "id": 1,
20     "requeue_rejected_tasks_to_annotator": true,
21     "anonymize_annotations": true,
22     "instruction": "string",
23     "only_finished_tasks": true,
24     "project": 1,
25     "requeue_rejected_tasks_mode": "requeue",
26     "require_comment_on_reject": true,
27     "review_criteria": "all",
28     "review_only_manual_assignments": true,
29     "review_task_limit_percent": "string",
30     "sampling": "task_id",
31     "show_agreement_to_reviewers": true,
32     "show_data_manager_to_reviewers": true,
33     "show_instruction": true,
34     "show_unused_data_columns_to_reviewers": true
35   },
36   "skipped_annotations_number": 1,
37   "start_training_on_annotation_update": true,
38   "state": "string",
39   "task_number": 1,
40   "total_annotations_number": 1,
41   "total_predictions_number": 1,
42   "useful_annotation_number": 1,
43   "workspace": 1,
44   "workspace_title": "string",
45   "agreement_methodology": "consensus",
46   "agreement_threshold": "string",
47   "annotation_limit_count": 1,
48   "annotation_limit_percent": "string",
49   "annotator_evaluation_continuous_tasks": 0,
50   "annotator_evaluation_enabled": true,
51   "annotator_evaluation_minimum_score": "95.00",
52   "annotator_evaluation_minimum_tasks": 10,
53   "annotator_evaluation_onboarding_tasks": 0,
54   "color": "string",
55   "comment_classification_config": "string",
56   "control_weights": {},
57   "created_by": {
58     "avatar": "string",
59     "id": 1,
60     "username": "string",
61     "email": "string",
62     "first_name": "string",
63     "last_name": "string"
64   },
65   "custom_interface_code": "string",
66   "custom_interface_compiled": "string",
67   "custom_interface_params": null,
68   "custom_script": "string",
69   "custom_task_lock_ttl": 1,
70   "description": "string",
71   "enable_empty_annotation": true,
72   "evaluate_predictions_automatically": true,
73   "expert_instruction": "string",
74   "input_schema": null,
75   "is_draft": true,
76   "is_published": true,
77   "label_config": "string",
78   "max_additional_annotators_assignable": 1,
79   "maximum_annotations": 1,
80   "min_annotations_to_start_training": 1,
81   "model_version": "string",
82   "organization": 1,
83   "output_schema": null,
84   "overlap_cohort_percentage": 1,
85   "pause_on_failed_annotator_evaluation": false,
86   "pinned_at": "2024-01-15T09:30:00Z",
87   "require_comment_on_skip": false,
88   "reveal_preannotations_interactively": true,
89   "sampling": "Sequential sampling",
90   "show_annotation_history": true,
91   "show_collab_predictions": true,
92   "show_instruction": true,
93   "show_overlap_first": true,
94   "show_skip_button": true,
95   "show_unused_data_columns_to_annotators": true,
96   "skip_queue": "REQUEUE_FOR_ME",
97   "source_interface_id": 1,
98   "source_interface_version": 1,
99   "strict_task_overlap": true,
100   "task_data_login": "string",
101   "task_data_password": "string",
102   "title": "string",
103   "use_custom_interface": false,
104   "show_ground_truth_first": true
105 }

Update the details of a specific project.

Authentication

AuthorizationToken

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example:

curl https://label-studio-host/api/projects -H “Authorization: Token [your-token]”

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>

Path parameters

idintegerRequired

Query parameters

members_limitintegerOptionalDefaults to 10

Maximum number of members to return

Request

This endpoint expects an object.

agreement_methodologyenumOptionalDefaults to pairwise

Methodology (Consensus / Pairwise Averaging)

consensus - Consensus
pairwise - Pairwise Averaging

agreement_thresholdstring or nullOptionalformat: "decimal"

Agreement threshold

annotation_limit_countinteger or nullOptional>=1

Limit by number of tasks

annotation_limit_percentstring or nullOptionalformat: "decimal"

Limit by percentage of tasks

annotator_evaluation_continuous_tasksintegerOptional>=0Defaults to 0

Continuous Evaluation: Required tasks

annotator_evaluation_enabledbooleanOptional

Evaluate all annotators against ground truth

annotator_evaluation_minimum_scorestring or nullOptionalformat: "decimal"Defaults to 95.00

Score required to pass evaluation

annotator_evaluation_minimum_tasksinteger or nullOptional>=0Defaults to 10

Number of tasks for evaluation

annotator_evaluation_onboarding_tasksintegerOptional>=0Defaults to 0

Onboarding Evaluation: Required tasks

assignment_settingsobjectOptional

colorstring or nullOptional<=16 characters

Color

comment_classification_configstringOptional

control_weightsmap from strings to objects or nullOptional

Dict of weights for each control tag in metric calculation. Keys are control tag names from the labeling config. At least one tag must have a non-zero overall weight.

created_byobjectOptional

Project owner

custom_interface_codestring or nullOptional

custom_interface_compiledstring or nullOptional

custom_interface_paramsany or nullOptional

custom_scriptstringOptional

Plugins

custom_task_lock_ttlinteger or nullOptional1-86400

Task reservation time. TTL in seconds (UI displays and edits this value in minutes).

descriptionstring or nullOptional

Description

enable_empty_annotationbooleanOptional

Allow empty annotations

evaluate_predictions_automaticallybooleanOptional

Retrieve and display predictions when loading a task

expert_instructionstring or nullOptional

Instructions

input_schemaany or nullOptional

is_draftbooleanOptional

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

is_publishedbooleanOptional

Whether or not the project is published to annotators

label_configstring or nullOptional

Labeling Configuration

max_additional_annotators_assignableinteger or nullOptional

Maximum additional annotators

maximum_annotationsintegerOptional-2147483648-2147483647

Annotations per task

min_annotations_to_start_trainingintegerOptional-2147483648-2147483647

Minimum number of completed tasks after which model training is started

model_versionstring or nullOptional

Machine learning model version

organizationinteger or nullOptional

output_schemaany or nullOptional

overlap_cohort_percentageintegerOptional-2147483648-2147483647

Annotations per task coverage

pause_on_failed_annotator_evaluationboolean or nullOptionalDefaults to false

Pause annotator on failed evaluation

pinned_atdatetime or nullOptional

Pinned date and time

require_comment_on_skipbooleanOptionalDefaults to false

Require comment to skip

reveal_preannotations_interactivelybooleanOptional

Reveal pre-annotations interactively

review_settingsobjectOptional

samplingenum or nullOptional

Sequential sampling - Tasks are ordered by Data manager ordering
Uniform sampling - Tasks are chosen randomly
Uncertainty sampling - Tasks are chosen according to model uncertainty scores (active learning mode)

show_annotation_historybooleanOptional

Show Data Manager to Annotators

show_collab_predictionsbooleanOptional

Use predictions to pre-label Tasks

show_instructionbooleanOptional

Show instructions before labeling

show_overlap_firstbooleanOptional

Show tasks with overlap first

show_skip_buttonbooleanOptional

Allow skipping tasks

show_unused_data_columns_to_annotatorsboolean or nullOptional

Show only columns used in labeling configuration to Annotators. API uses inverse field semantics here: set false to show only used columns, set true to show all task.data columns.

skip_queueenum or nullOptional

REQUEUE_FOR_ME - Requeue for me
REQUEUE_FOR_OTHERS - Requeue for others
IGNORE_SKIPPED - Ignore skipped

source_interface_idinteger or nullOptional

source_interface_versioninteger or nullOptional

Stable version ID of the saved interface snapshot used by this project.

strict_task_overlapbooleanOptionalDefaults to true

Enforce strict overlap limit

task_data_loginstring or nullOptional<=256 characters

task_data_passwordstring or nullOptional<=256 characters

Password

titlestring or nullOptional3-50 characters

Project Name

use_custom_interfacebooleanOptionalDefaults to false

workspaceintegerOptional

Workspace

show_ground_truth_firstbooleanOptionalDeprecated

Onboarding mode (true): show ground truth tasks first in the labeling stream

Response

assignment_settingsobject

config_has_control_tagsbooleanRead-only

Flag to detect is project ready for labeling

config_suitable_for_bulk_annotationbooleanRead-only

Flag to detect is project ready for bulk annotation

created_atdatetimeRead-only

finished_task_numberintegerRead-only

Finished tasks

ground_truth_numberintegerRead-only

Honeypot annotation number in project

idintegerRead-only

num_tasks_with_annotationsintegerRead-only

Tasks with annotations count

parsed_label_configmap from strings to anyRead-only

JSON-formatted labeling configuration

promptsstringRead-only

queue_doneintegerRead-only

queue_totalintegerRead-only

review_settingsobject

skipped_annotations_numberintegerRead-only

Skipped by collaborators annotation number in project

start_training_on_annotation_updatebooleanRead-only

Start model training after any annotations are submitted or updated

statestringRead-only

task_numberintegerRead-only

Total task number in project

total_annotations_numberintegerRead-only

Total annotations number in project including skipped_annotations_number and ground_truth_number.

total_predictions_numberintegerRead-only

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

useful_annotation_numberintegerRead-only

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

workspaceinteger

Workspace

workspace_titlestringRead-only

agreement_methodologyenumDefaults to pairwise

Methodology (Consensus / Pairwise Averaging)

consensus - Consensus
pairwise - Pairwise Averaging

agreement_thresholdstring or nullformat: "decimal"

Agreement threshold

annotation_limit_countinteger or null>=1

Limit by number of tasks

annotation_limit_percentstring or nullformat: "decimal"

Limit by percentage of tasks

annotator_evaluation_continuous_tasksinteger>=0Defaults to 0

Continuous Evaluation: Required tasks

annotator_evaluation_enabledboolean

Evaluate all annotators against ground truth

annotator_evaluation_minimum_scorestring or nullformat: "decimal"Defaults to 95.00

Score required to pass evaluation

annotator_evaluation_minimum_tasksinteger or null>=0Defaults to 10

Number of tasks for evaluation

annotator_evaluation_onboarding_tasksinteger>=0Defaults to 0

Onboarding Evaluation: Required tasks

colorstring or null<=16 characters

Color

comment_classification_configstring

control_weightsmap from strings to objects or null

Dict of weights for each control tag in metric calculation. Keys are control tag names from the labeling config. At least one tag must have a non-zero overall weight.

created_byobject

Project owner

custom_interface_codestring or null

custom_interface_compiledstring or null

custom_interface_paramsany or null

custom_scriptstring

Plugins

custom_task_lock_ttlinteger or null1-86400

Task reservation time. TTL in seconds (UI displays and edits this value in minutes).

descriptionstring or null

Description

enable_empty_annotationboolean

Allow empty annotations

evaluate_predictions_automaticallyboolean

Retrieve and display predictions when loading a task

expert_instructionstring or null

Instructions

input_schemaany or null

is_draftboolean

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

is_publishedboolean

Whether or not the project is published to annotators

label_configstring or null

Labeling Configuration

max_additional_annotators_assignableinteger or null

Maximum additional annotators

maximum_annotationsinteger-2147483648-2147483647

Annotations per task

min_annotations_to_start_traininginteger-2147483648-2147483647

Minimum number of completed tasks after which model training is started

model_versionstring or null

Machine learning model version

organizationinteger or null

output_schemaany or null

overlap_cohort_percentageinteger-2147483648-2147483647

Annotations per task coverage

pause_on_failed_annotator_evaluationboolean or nullDefaults to false

Pause annotator on failed evaluation

pinned_atdatetime or null

Pinned date and time

require_comment_on_skipbooleanDefaults to false

Require comment to skip

reveal_preannotations_interactivelyboolean

Reveal pre-annotations interactively

samplingenum or null

Sequential sampling - Tasks are ordered by Data manager ordering
Uniform sampling - Tasks are chosen randomly
Uncertainty sampling - Tasks are chosen according to model uncertainty scores (active learning mode)

show_annotation_historyboolean

Show Data Manager to Annotators

show_collab_predictionsboolean

Use predictions to pre-label Tasks

show_instructionboolean

Show instructions before labeling

show_overlap_firstboolean

Show tasks with overlap first

show_skip_buttonboolean

Allow skipping tasks

show_unused_data_columns_to_annotatorsboolean or null

Show only columns used in labeling configuration to Annotators. API uses inverse field semantics here: set false to show only used columns, set true to show all task.data columns.

skip_queueenum or null

REQUEUE_FOR_ME - Requeue for me
REQUEUE_FOR_OTHERS - Requeue for others
IGNORE_SKIPPED - Ignore skipped

source_interface_idinteger or null

source_interface_versioninteger or null

Stable version ID of the saved interface snapshot used by this project.

strict_task_overlapbooleanDefaults to true

Enforce strict overlap limit

task_data_loginstring or null<=256 characters

task_data_passwordstring or null<=256 characters

Password

titlestring or null3-50 characters

Project Name

use_custom_interfacebooleanDefaults to false

show_ground_truth_firstbooleanDeprecated

Onboarding mode (true): show ground truth tasks first in the labeling stream