Sign in
Annotations

Get annotation by its ID

Retrieve a specific annotation for a task using the annotation result ID.

get/api/annotations/{id}/

Path parameters

idinteger required

Response

Retrieved annotation

bulk_createdboolean nullable

Annotation was created in bulk mode

completed_byinteger
created_agostring required

Time delta from creation time

created_atstring date-time required

Creation time

created_usernamestring required

Username string

draft_created_atstring date-time nullable

Draft creation time

ground_truthboolean

This annotation is a Ground Truth (ground_truth)

idinteger required
import_idinteger nullable

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

last_action'prediction' | 'propagated_annotation' | 'imported' | 'submitted' | 'updated' | 'skipped' | 'accepted' | 'rejected' | 'fixed_and_accepted' | 'deleted_review'
  • 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 nullable

User who created the last annotation history item

lead_timenumber double nullable

How much time it took to annotate the task

parent_annotationinteger nullable

Points to the parent annotation from which this annotation was created

parent_predictioninteger nullable

Points to the prediction from which this annotation was created

projectinteger nullable

Project ID for this annotation

resultobject[]

List of annotation results for the task

statestring required
taskinteger nullable

Corresponding task for this annotation

updated_atstring date-time required

Last updated time

updated_byinteger nullable

Last user who updated this annotation

was_cancelledboolean

User skipped the task

Changes

Changed in 1 of the 97 revisions of this API.2

  • 04ff286141b52See the full diff
    • ○

      added AnnotationHistoryActionEnum to the last_action response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      removed LastActionEnum from the last_action response property allOf list for the response status 200

      response-property-all-of-removed

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 97 revisions, 1 has no diff computed.