Update task | API Reference

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

{
  "agreement": "0.85",
  "agreement_selected": "0.90",
  "allow_skip": true,
  "annotation_time": 360,
  "annotations": "[{\"id\": 101, \"result\": [{\"from_name\": \"label\", \"to_name\": \"image\", \"type\": \"rectanglelabels\", \"value\": {\"x\": 10, \"y\": 20, \"width\": 30, \"height\": 40}}]}]",
  "annotations_ids": "[101, 102]",
  "annotations_results": "[{\"id\": 101, \"result\": [{\"from_name\": \"label\", \"to_name\": \"image\", \"type\": \"rectanglelabels\", \"value\": {\"x\": 10, \"y\": 20, \"width\": 30, \"height\": 40}}]}]",
  "annotators": [
    {}
  ],
  "annotators_count": 3,
  "avg_lead_time": 420.5,
  "cancelled_annotations": 2,
  "comment_authors": [
    {}
  ],
  "comment_authors_count": 2,
  "comment_count": 5,
  "comments": "[{\"author\": \"user1\", \"text\": \"Please review the bounding box.\"}, {\"author\": \"user2\", \"text\": \"Annotation looks good.\"}]",
  "completed_at": "2024-01-15T09:30:00Z",
  "created_at": "2024-01-10T08:00:00Z",
  "data": {},
  "draft_exists": true,
  "drafts": [
    {
      "created_at": "2024-01-14T12:00:00Z",
      "result": [
        {}
      ],
      "updated_at": "2024-01-14T15:00:00Z"
    }
  ],
  "file_upload": "image_001.jpg",
  "ground_truth": false,
  "id": 12345,
  "inner_id": 67890,
  "is_labeled": true,
  "last_comment_updated_at": "2024-01-15T08:45:00Z",
  "meta": null,
  "overlap": 2,
  "precomputed_agreement": 0.88,
  "predictions": [
    {
      "created_at": "2024-01-14T10:00:00Z",
      "model": {},
      "model_run": {},
      "model_version": "v1.2.3",
      "project": 101,
      "result": [
        {}
      ],
      "score": 0.92,
      "task": 12345,
      "updated_at": "2024-01-14T11:00:00Z"
    }
  ],
  "predictions_model_versions": "v1.2.3",
  "predictions_results": "[{\"result\": [{\"from_name\": \"label\", \"to_name\": \"image\", \"type\": \"rectanglelabels\", \"value\": {\"x\": 12, \"y\": 22, \"width\": 28, \"height\": 38}}]}]",
  "predictions_score": 0.92,
  "project": 101,
  "review_time": 180,
  "reviewed": true,
  "reviewers": [
    {}
  ],
  "reviewers_count": 2,
  "reviews_accepted": 4,
  "reviews_rejected": 1,
  "state": "completed",
  "storage_filename": "image_001.jpg",
  "total_annotations": 5,
  "total_predictions": 3,
  "unresolved_comment_count": 1,
  "updated_at": "2024-01-15T09:00:00Z",
  "updated_by": [
    {}
  ]
}

Update the attributes of an existing labeling task.

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: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>

Path parameters

idstringRequired

Task ID

Request

This endpoint expects an object.

allow_skipboolean or nullOptional

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

avg_lead_timedoubleOptional

cancelled_annotationsintegerOptional

comment_countintegerOptional-2147483648-2147483647

Number of comments in the task including all annotations

completed_atdatetimeOptional

datamap from strings to anyOptional

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_existsbooleanOptional

ground_truthbooleanOptional

inner_idintegerOptional

is_labeledbooleanOptional

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_atdatetime or nullOptional

When the last comment was updated

metaany or nullOptional

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.

overlapintegerOptional-2147483648-2147483647

Number of distinct annotators that processed the current task

precomputed_agreementdouble or nullOptional

Average agreement score for the task

predictions_scoredoubleOptional

projectinteger or nullOptional

Project ID for this task

reviewedbooleanOptional

reviews_acceptedintegerOptional

reviews_rejectedintegerOptional

total_annotationsintegerOptional

total_predictionsintegerOptional

unresolved_comment_countintegerOptional-2147483648-2147483647

Number of unresolved comments in the task including all annotations

Response

LseTaskobject

Data Manager Task Serializer with FSM state support.

LseTaskSerializerForReviewersobject

Data Manager Task Serializer with FSM state support.

LseTaskSerializerForAnnotatorsobject

Data Manager Task Serializer with FSM state support.