Update task — API Reference

Update the attributes of an existing labeling task.

You will need the task ID. This 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

Request

This endpoint expects an object.

data

map from strings to anyOptional

Task data dictionary with arbitrary keys and values

project

integerOptional

Project 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

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

inner_id

integerOptional

Internal task ID in the project, starts with 1

total_annotations

integerOptional

Number of total annotations for the current task except cancelled annotations

cancelled_annotations

integerOptional

Number of total cancelled annotations for the current task

total_predictions

integerOptional

Number of total predictions for 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

updated_by

unionOptional

Last annotator or reviewer who updated this task

file_upload

unionOptional

Uploaded file used as data source for this task

comment_authors

list of integersOptional

Users who wrote comments

1 curl -X PATCH http://localhost:8080/api/tasks/id/ \ 2 -H "Authorization: Token <api_key>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "data": { 6 "image": "https://example.com/image.jpg", 7 "text": "Hello, world!" 8 }, 9 "project": 1 10 }'

1 { 2 "data": { 3 "image": "https://example.com/image.jpg", 4 "text": "Hello, AI!" 5 }, 6 "id": 1, 7 "meta": { 8 "meta": { 9 "key": "value" 10 } 11 }, 12 "created_at": "2024-06-18T23:45:46Z", 13 "updated_at": "2024-06-18T23:45:46Z", 14 "is_labeled": false, 15 "overlap": 1, 16 "inner_id": 1, 17 "total_annotations": 0, 18 "cancelled_annotations": 0, 19 "total_predictions": 0, 20 "comment_count": 0, 21 "unresolved_comment_count": 0, 22 "last_comment_updated_at": "2024-01-15T09:30:00Z", 23 "project": 1, 24 "updated_by": [ 25 { 26 "user_id": 1 27 } 28 ], 29 "file_upload": "42d46c4c-my-pic.jpeg", 30 "comment_authors": [ 31 1 32 ] 33 }

1	curl -X PATCH http://localhost:8080/api/tasks/id/ \
2	-H "Authorization: Token <api_key>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"data": {
6	"image": "https://example.com/image.jpg",
7	"text": "Hello, world!"
8	},
9	"project": 1
10	}'

1	{
2	"data": {
3	"image": "https://example.com/image.jpg",
4	"text": "Hello, AI!"
5	},
6	"id": 1,
7	"meta": {
8	"meta": {
9	"key": "value"
10	}
11	},
12	"created_at": "2024-06-18T23:45:46Z",
13	"updated_at": "2024-06-18T23:45:46Z",
14	"is_labeled": false,
15	"overlap": 1,
16	"inner_id": 1,
17	"total_annotations": 0,
18	"cancelled_annotations": 0,
19	"total_predictions": 0,
20	"comment_count": 0,
21	"unresolved_comment_count": 0,
22	"last_comment_updated_at": "2024-01-15T09:30:00Z",
23	"project": 1,
24	"updated_by": [
25	{
26	"user_id": 1
27	}
28	],
29	"file_upload": "42d46c4c-my-pic.jpeg",
30	"comment_authors": [
31	1
32	]
33	}