Get task

GET

http://localhost:8000/api/tasks/:id/

GET

/api/tasks/:id/

1 from label_studio_sdk import LabelStudio
2 
3 client = LabelStudio(
4     api_key="YOUR_API_KEY",
5 )
6 client.tasks.get(
7     id="id",
8 )

Try it

200Retrieved

1 {
2   "agreement": "agreement",
3   "annotations": "annotations",
4   "annotations_ids": "annotations_ids",
5   "annotations_results": "annotations_results",
6   "annotators": [
7     1
8   ],
9   "annotators_count": 1,
10   "avg_lead_time": 1.1,
11   "cancelled_annotations": 1,
12   "comment_authors": [
13     {
14       "key": "value"
15     }
16   ],
17   "comment_authors_count": 1,
18   "comment_count": 1,
19   "comments": "comments",
20   "completed_at": "2024-01-15T09:30:00Z",
21   "created_at": "2024-01-15T09:30:00Z",
22   "data": {
23     "key": "value"
24   },
25   "draft_exists": true,
26   "drafts": [
27     {
28       "created_at": "2024-01-15T09:30:00Z",
29       "result": [
30         {
31           "key": "value"
32         }
33       ],
34       "updated_at": "2024-01-15T09:30:00Z"
35     }
36   ],
37   "file_upload": "file_upload",
38   "ground_truth": true,
39   "id": 1,
40   "inner_id": 1,
41   "is_labeled": true,
42   "last_comment_updated_at": "2024-01-15T09:30:00Z",
43   "meta": {
44     "key": "value"
45   },
46   "overlap": 1,
47   "predictions": [
48     {
49       "created_at": "2024-01-15T09:30:00Z",
50       "model": {
51         "key": "value"
52       },
53       "model_run": {
54         "key": "value"
55       },
56       "model_version": "model_version",
57       "project": 1,
58       "result": [
59         {
60           "key": "value"
61         }
62       ],
63       "score": 1.1,
64       "task": 1,
65       "updated_at": "2024-01-15T09:30:00Z"
66     }
67   ],
68   "predictions_model_versions": "predictions_model_versions",
69   "predictions_results": "predictions_results",
70   "predictions_score": 1.1,
71   "project": 1,
72   "reviewed": true,
73   "reviewers": [
74     {
75       "key": "value"
76     }
77   ],
78   "reviewers_count": 1,
79   "reviews_accepted": 1,
80   "reviews_rejected": 1,
81   "storage_filename": "storage_filename",
82   "total_annotations": 1,
83   "total_predictions": 1,
84   "unresolved_comment_count": 1,
85   "updated_at": "2024-01-15T09:30:00Z",
86   "updated_by": [
87     {
88       "key": "value"
89     }
90   ]
91 }

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

Path parameters

idstringRequired

Task ID

Response

object

Path parameters

Headers

Response