Tasks

Update task

Changed on

Update the attributes of an existing labeling task.

patch/api/tasks/{id}/

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/api/tasks/{id}/
  • Auth
    API key in header Authorization

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

metaunknown
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
reviewed_atstring date-time nullable
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

  • 4179f5b5996aRevision changes
    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

  • cbc94e6444bbRevision changes
    • info

      added the required property //// to the response with the status