Get task — API Reference

Get task data, metadata, annotations and other attributes for a specific labeling task by task ID. The task ID is available from the Label Studio URL when viewing the task, or you can retrieve it programmatically with Get task list.

Path parameters

idstringRequired

Task ID

Response

This endpoint returns an object

data

map from strings to any

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.

integerOptional

predictions

list of objectsOptional

Predictions for this task

annotations

list of objectsOptional

drafts

list of objectsOptional

Drafts for this task

annotators

list of unionsOptional

Annotators who annotated this task

inner_id

integerOptional

cancelled_annotations

integerOptional

total_annotations

integerOptional

total_predictions

integerOptional

completed_at

datetimeOptional

annotations_results

stringOptional

predictions_results

stringOptional

predictions_score

doubleOptional

file_upload

stringOptional

storage_filename

stringOptional

annotations_ids

stringOptional

predictions_model_versions

stringOptional

avg_lead_time

doubleOptional

draft_exists

booleanOptional

updated_by

list of maps from strings to anyOptional

User IDs who updated this task

meta

map from strings to anyOptional

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.

created_at

datetimeOptional

Time a task was created

updated_at

datetimeOptional

Last time a task was updated

is_labeled

booleanOptional

True if the number of annotations for this task is greater than or equal to the number of maximum_completions for the project

overlap

integerOptional

Number of distinct annotators that processed the current task

comment_count

integerOptional

Number of comments in the task including all annotations

unresolved_comment_count

integerOptional

Number of unresolved comments in the task including all annotations

last_comment_updated_at

datetimeOptional

When the last comment was updated

project

integerOptional

Project ID for this task

comment_authors

list of integersOptional

Users who wrote comments

1 curl http://localhost:8080/api/tasks/id/ \ 2 -H "Authorization: Token <api_key>"

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

1	curl http://localhost:8080/api/tasks/id/ \
2	-H "Authorization: Token <api_key>"

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