Get task | API Reference

curl http://localhost:8000/api/tasks/id/ \
     -H "Authorization: <apiKey>"

{
  "agreement": "string",
  "agreement_selected": "string",
  "allow_skip": true,
  "annotation_time": 1,
  "annotations": "string",
  "annotations_ids": "string",
  "annotations_results": "string",
  "annotators": [
    1
  ],
  "annotators_count": 1,
  "avg_lead_time": 1.1,
  "cancelled_annotations": 1,
  "comment_authors": [
    {}
  ],
  "comment_authors_count": 1,
  "comment_count": 1,
  "comments": "string",
  "completed_at": "2024-01-15T09:30:00Z",
  "created_at": "2024-01-15T09:30:00Z",
  "data": null,
  "draft_exists": true,
  "drafts": [
    {
      "created_at": "2024-01-15T09:30:00Z",
      "result": [
        {}
      ],
      "updated_at": "2024-01-15T09:30:00Z"
    }
  ],
  "file_upload": "string",
  "ground_truth": true,
  "id": 1,
  "inner_id": 1,
  "is_labeled": true,
  "last_comment_updated_at": "2024-01-15T09:30:00Z",
  "meta": null,
  "overlap": 1,
  "precomputed_agreement": 1.1,
  "predictions": [
    {
      "created_at": "2024-01-15T09:30:00Z",
      "model": {},
      "model_run": {},
      "model_version": "string",
      "project": 1,
      "result": [
        {}
      ],
      "score": 1.1,
      "task": 1,
      "updated_at": "2024-01-15T09:30:00Z"
    }
  ],
  "predictions_model_versions": "string",
  "predictions_results": "string",
  "predictions_score": 1.1,
  "project": 1,
  "review_time": 1,
  "reviewed": true,
  "reviewers": [
    {}
  ],
  "reviewers_count": 1,
  "reviews_accepted": 1,
  "reviews_rejected": 1,
  "state": "string",
  "storage_filename": "string",
  "total_annotations": 1,
  "total_predictions": 1,
  "unresolved_comment_count": 1,
  "updated_at": "2024-01-15T09:30:00Z",
  "updated_by": [
    {}
  ]
}

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

Authentication

Authorizationstring

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

object