Tasks

Update task

Update the attributes of an existing labeling task.

patch/api/tasks/{id}/

Path parameters

idstring required

Task ID

Request body

allow_skipboolean nullable

Whether this task can be skipped. Set to False to make task unskippable.

avg_lead_timenumber double
cancelled_annotationsinteger
comment_countinteger

Number of comments in the task including all annotations

completed_atstring date-time
dataobject

User imported or uploaded data for a task. Data is formatted according to the project label config. You can find examples of data for your project on the Import page in the Label Studio Data Manager UI.

draft_existsboolean
ground_truthboolean
inner_idinteger
is_labeledboolean

True if the number of annotations for this task is greater than or equal to the number of maximum_completions for the project

last_comment_updated_atstring date-time nullable

When the last comment was updated

{"stackTrail":"components:schemas:PatchedLseTaskRequest:properties:meta","oasType":"schema","type":"unknown","description":"Meta is user imported (uploaded) data and can be useful as input for an ML Backend for embeddings, advanced vectors, and other info. It is passed to ML during training/predicting steps.","nullable":true}
overlapinteger

Number of distinct annotators that processed the current task

precomputed_agreementnumber double nullable

Average agreement score for the task

predictions_scorenumber double
projectinteger nullable

Project ID for this task

reviewedboolean
reviews_acceptedinteger
reviews_rejectedinteger
total_annotationsinteger
total_predictionsinteger
unresolved_comment_countinteger

Number of unresolved comments in the task including all annotations

Response

OR
OR

Changes

Changed in 4 of the 97 revisions of this API.19

    • the response property oneOf[LseTaskSerializerForReviewers]/file_upload became nullable for the status 200

      response-property-became-nullable

    • the response property oneOf[LseTaskSerializerForReviewers]/storage_filename became nullable for the status 200

      response-property-became-nullable

    • the response property oneOf[LseTask]/file_upload became nullable for the status 200

      response-property-became-nullable

    • the response property oneOf[LseTask]/storage_filename became nullable for the status 200

      response-property-became-nullable

    • the oneOf[LseTaskSerializerForReviewers]/agreement response's property type/format changed from string/ to number/double for status 200

      response-property-type-changed

    • the oneOf[LseTaskSerializerForReviewers]/agreement_selected response's property type/format changed from string/ to number/double for status 200

      response-property-type-changed

    • the oneOf[LseTask]/agreement response's property type/format changed from string/ to number/double for status 200

      response-property-type-changed

    • the oneOf[LseTask]/agreement_selected response's property type/format changed from string/ to number/double for status 200

      response-property-type-changed

    • the oneOf[LseTaskSerializerForAnnotators]/annotations response's property type/format changed from string/ to array/ for status 200

      response-property-type-changed

    • the oneOf[LseTaskSerializerForAnnotators]/comment_count response's property type/format changed from string/ to integer/ for status 200

      response-property-type-changed

    • the oneOf[LseTaskSerializerForAnnotators]/unresolved_comment_count response's property type/format changed from string/ to integer/ for status 200

      response-property-type-changed

    • the oneOf[LseTaskSerializerForReviewers]/annotations response's property type/format changed from string/ to array/ for status 200

      response-property-type-changed

    • the oneOf[LseTask]/annotations response's property type/format changed from string/ to array/ for status 200

      response-property-type-changed

    • the response property oneOf[LseTaskSerializerForReviewers]/annotation_time became nullable for the status 200

      response-property-became-nullable

    • the response property oneOf[LseTaskSerializerForReviewers]/review_time became nullable for the status 200

      response-property-became-nullable

    • the response property oneOf[LseTask]/annotation_time became nullable for the status 200

      response-property-became-nullable

    • the response property oneOf[LseTask]/review_time became nullable for the status 200

      response-property-became-nullable

    • the oneOf[LseTaskSerializerForReviewers]/annotators/items/ response's property type/format changed from integer/ to object/ for status 200

      response-property-type-changed

    • the oneOf[LseTask]/annotators/items/ response's property type/format changed from integer/ to object/ for status 200

      response-property-type-changed

Of the 97 revisions, 1 has no diff computed.