API ReferenceAnnotations

Update an annotation

Update attributes for an existing annotation.

You will need to supply the annotation’s unique ID. You can find the ID in the Label Studio UI listed at the top of the annotation in its tab. It is also listed in the History panel when viewing the annotation. Or you can use Get all task annotations to find all annotation IDs.

For information about the JSON format used in the result, see Label Studio JSON format of annotated tasks.

Path parameters

idintegerRequired
A unique integer value identifying this annotation.

Headers

AuthorizationstringRequired

Header authentication of the form Token <token>

Request

This endpoint expects an object.
resultlist of maps from strings to anyOptional

Labeling result in JSON format. Read more about the format in the Label Studio documentation.

taskintegerOptional
Corresponding task for this annotation
projectintegerOptional
Project ID for this annotation
completed_byintegerOptional
User ID of the person who created this annotation
updated_byintegerOptional
Last user who updated this annotation
was_cancelledbooleanOptional
User skipped the task
ground_truthbooleanOptional
This annotation is a Ground Truth
lead_timedoubleOptional

How much time it took to annotate the task (in seconds)

Response

Updated annotation
idinteger or null
resultlist of maps from strings to any or null
List of annotation results for the task
created_usernamestring or null
Username string
created_agostring or null>=1 characterDefaults to
Time delta from creation time
completed_byobject or integer or null
unique_idstring or null>=1 character
was_cancelledboolean or null
User skipped the task
ground_truthboolean or null

This annotation is a Ground Truth (ground_truth)

created_atdatetime or null
Creation time
updated_atdatetime or null
Last updated time
draft_created_atdatetime or null
Draft creation time
lead_timedouble or null
How much time it took to annotate the task
import_idinteger or null
Original annotation ID that was at the import step or NULL if this annotation wasn't imported
last_actionenum or null
Action which was performed in the last annotation history item
taskinteger or null
Corresponding task for this annotation
projectinteger or null
Project ID for this annotation
updated_byinteger or null
Last user who updated this annotation
parent_predictioninteger or null
Points to the prediction from which this annotation was created
parent_annotationinteger or null
Points to the parent annotation from which this annotation was created
last_created_byinteger or null
User who created the last annotation history item