Update annotation

PATCH

http://localhost:8000/api/annotations/:id/

PATCH

/api/annotations/:id/

$ curl -X PATCH http://localhost:8000/api/annotations/1/ \
>      -H "Authorization: Token  <api_key>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

200response

1 {
2   "created_ago": "",
3   "created_at": "2024-06-18T23:45:46.048490Z",
4   "created_username": "",
5   "id": 1,
6   "state": "CREATED",
7   "updated_at": "2024-06-18T23:45:46.048538Z",
8   "completed_by": 1,
9   "ground_truth": false,
10   "lead_time": 10,
11   "project": 1,
12   "result": [
13     {
14       "from_name": "bboxes",
15       "image_rotation": 0,
16       "original_height": 1080,
17       "original_width": 1920,
18       "to_name": "image",
19       "type": "rectanglelabels",
20       "value": {
21         "height": 60,
22         "rotation": 0,
23         "values": {
24           "rectanglelabels": [
25             "Person"
26           ]
27         },
28         "width": 50,
29         "x": 20,
30         "y": 30
31       }
32     }
33   ],
34   "task": 1,
35   "updated_by": 1,
36   "was_cancelled": false
37 }

Update existing attributes on an annotation.

Authentication

AuthorizationToken

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

idintegerRequired

Request

This endpoint expects an object.

bulk_createdboolean or nullOptional

Annotation was created in bulk mode

completed_byintegerOptional

draft_created_atdatetime or nullOptional

Draft creation time

ground_truthbooleanOptional

This annotation is a Ground Truth (ground_truth)

import_idlong or nullOptional-9223372036854776000-9223372036854776000

Original annotation ID that was at the import step or NULL if this annotation wasn't imported

last_actionenum or nullOptional

Action which was performed in the last annotation history item

prediction - Created from prediction
propagated_annotation - Created from another annotation
imported - Imported
submitted - Submitted
updated - Updated
skipped - Skipped
accepted - Accepted
rejected - Rejected
fixed_and_accepted - Fixed and accepted
deleted_review - Deleted review

last_created_byinteger or nullOptional

User who created the last annotation history item

lead_timedouble or nullOptional

How much time it took to annotate the task

parent_annotationinteger or nullOptional

Points to the parent annotation from which this annotation was created

parent_predictioninteger or nullOptional

Points to the prediction from which this annotation was created

projectinteger or nullOptional

Project ID for this annotation

resultlist of objectsOptional

List of annotation results for the task

taskinteger or nullOptional

Corresponding task for this annotation

unique_idstringOptional>=1 character

updated_byinteger or nullOptional

Last user who updated this annotation

was_cancelledbooleanOptional

User skipped the task

Response

Updated annotation

created_agostringRead-onlyDefaults to

Time delta from creation time

created_atdatetimeRead-only

Creation time

created_usernamestringRead-onlyDefaults to

Username string

idintegerRead-only

statestringRead-only

updated_atdatetimeRead-only

Last updated time