Skip to navigation
API ReferenceAnnotation History

✨ Retrieve a single annotation history item (full result for hydration)

Label Studio Enterprise badge

This endpoint is not available in Label Studio Community Edition. Learn more about Label Studio Enterprise

Get one annotation history item by ID with full result. Used when FIT-720 lazy load is on and the user clicks a stubbed history item to hydrate it.

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: 

curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"

Path parameters

idintegerRequired

Response

This endpoint returns an object.
commentstring or nullRead-only
created_atdatetimeRead-only
idintegerRead-only
actionenum or nullOptional
  • 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
annotation_idinteger or nullOptional-2147483648-2147483647
Corresponding annotation for this historical annotation
comment_idinteger or nullOptional-2147483648-2147483647
Comment id sent with result
created_byinteger or nullOptional-2147483648-2147483647
Created by user id
draft_idinteger or nullOptional-2147483648-2147483647
Corresponding draft for this historical annotation
lead_timedouble or nullOptional
How much time it took to annotate the task
organization_idinteger or nullOptional-2147483648-2147483647
Organization for this annotation history
project_idinteger or nullOptional-2147483648-2147483647
Project for this annotation history
resultany or nullOptional
Labeling result
review_idinteger or nullOptional-2147483648-2147483647
AnnotationReview ID, using with review field
started_atdatetime or nullOptional
The time that a user started working on this revision of the annotation
task_idinteger or nullOptional-2147483648-2147483647
Task id