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

Task

datamap 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.

idinteger or null

predictionslist of objects or null

Predictions for this task

annotationslist of objects or null

draftslist of objects or null

Drafts for this task

annotatorslist of integers or maps from strings to any or null

Annotators who annotated this task

inner_idinteger or null

cancelled_annotationsinteger or null

total_annotationsinteger or null

total_predictionsinteger or null

completed_atdatetime or null

annotations_resultsstring or null

predictions_resultsstring or null

predictions_scoredouble or null

file_uploadstring or null

storage_filenamestring or null

annotations_idsstring or null

predictions_model_versionsstring or null

avg_lead_timedouble or null

draft_existsboolean or null

updated_bylist of maps from strings to any or null

User IDs who updated this task

metamap from strings to any or null

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

Time a task was created

updated_atdatetime or null

Last time a task was updated

is_labeledboolean or null

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

overlapinteger or null

Number of distinct annotators that processed the current task

comment_countinteger or null

Number of comments in the task including all annotations

unresolved_comment_countinteger or null

Number of unresolved comments in the task including all annotations

last_comment_updated_atdatetime or null

When the last comment was updated

projectinteger or null

Project ID for this task

comment_authorslist of integers or maps from strings to any or null

Users who wrote comments

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

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

Path parameters

Headers

Response