Get task | API Reference

curl http://localhost:8000/api/tasks/id/ \
     -H "Authorization: Token  <api_key>" \
     -H "Content-Type: application/json"

{
  "agreement": "75%",
  "agreement_selected": "annotator_3",
  "allow_skip": false,
  "annotation_time": 360,
  "annotations": "[{\"id\": \"ann1\", \"result\": [{\"type\": \"rectangle\", \"value\": {\"x\": 10, \"y\": 20, \"width\": 30, \"height\": 40}}]}]",
  "annotations_ids": "[\"ann1\", \"ann2\"]",
  "annotations_results": "[{\"id\": \"ann1\", \"result\": [{\"type\": \"rectangle\", \"value\": {\"x\": 10, \"y\": 20, \"width\": 30, \"height\": 40}}]}]",
  "annotators": [
    {
      "user_id": 42,
      "username": "jdoe",
      "first_name": "John",
      "last_name": "Doe"
    }
  ],
  "annotators_count": 3,
  "avg_lead_time": 45.5,
  "cancelled_annotations": 0,
  "comment_authors": [
    {
      "user_id": 42,
      "username": "jdoe"
    }
  ],
  "comment_authors_count": 2,
  "comment_count": 5,
  "comments": "[{\"id\": \"c1\", \"text\": \"Please review this annotation.\"}]",
  "completed_at": "2024-01-15T09:30:00Z",
  "created_at": "2024-01-10T08:00:00Z",
  "data": {
    "image_url": "https://example.com/images/task_1.jpg",
    "metadata": {
      "source": "user_upload",
      "category": "vehicles"
    }
  },
  "draft_exists": true,
  "drafts": [
    {
      "created_at": "2024-01-14T15:00:00Z",
      "result": [
        {
          "type": "rectangle",
          "value": {
            "x": 15,
            "y": 25,
            "width": 35,
            "height": 45
          }
        }
      ],
      "updated_at": "2024-01-14T16:00:00Z"
    }
  ],
  "file_upload": "task_1_image.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.82,
  "predictions": [
    {
      "created_at": "2024-01-14T12:00:00Z",
      "model": {
        "id": 101,
        "name": "Vehicle Detector v2"
      },
      "model_run": {
        "id": 202,
        "status": "completed"
      },
      "model_version": "v2.3.1",
      "project": 10,
      "result": [
        {
          "type": "rectangle",
          "value": {
            "x": 12,
            "y": 22,
            "width": 32,
            "height": 42
          }
        }
      ],
      "score": 0.95,
      "task": 12345,
      "updated_at": "2024-01-14T12:30:00Z"
    }
  ],
  "predictions_model_versions": "v2.3.1",
  "predictions_results": "[{\"type\": \"rectangle\", \"value\": {\"x\": 12, \"y\": 22, \"width\": 32, \"height\": 42}}]",
  "predictions_score": 0.95,
  "project": 10,
  "review_time": 120,
  "reviewed": true,
  "reviewers": [
    {
      "user_id": 55,
      "username": "asmith",
      "first_name": "Alice",
      "last_name": "Smith"
    }
  ],
  "reviewers_count": 1,
  "reviews_accepted": 1,
  "reviews_rejected": 0,
  "state": "completed",
  "storage_filename": "task_12345_storage.json",
  "total_annotations": 3,
  "total_predictions": 1,
  "unresolved_comment_count": 1,
  "updated_at": "2024-01-15T09:00:00Z",
  "updated_by": [
    {
      "user_id": 42,
      "username": "jdoe"
    }
  ]
}

Get task data, metadata, annotations and other attributes for a specific labeling task by task ID.

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

idstringRequired

Task ID

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.