Sign in
Annotations

Create annotation

    Add annotations to a task like an annotator does. The content of the result field depends on your
    labeling configuration. For example, send the following data as part of your POST
    request to send an empty annotation with the ID of the user who completed the task:

    ```json
    {
    "result": {},
    "was_cancelled": true,
    "ground_truth": true,
    "lead_time": 0,
    "task": 0
    "completed_by": 123
    }
    ```
post/api/tasks/{id}/annotations/

Path parameters

idinteger required

Task ID

Request body

bulk_createdboolean nullable

Annotation was created in bulk mode

completed_byinteger
draft_created_atstring date-time nullable

Draft creation time

ground_truthboolean

This annotation is a Ground Truth (ground_truth)

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

taskinteger nullable

Corresponding task for this annotation

unique_idstring
updated_byinteger nullable

Last user who updated this annotation

was_cancelledboolean

User skipped the task

Response

Created 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 2 of the 97 revisions of this API.116

  • e1ba2ecdbabb114See the full diff
    • ▲

      the lead_time request property type/format changed from number/ to number/double

      request-property-type-changed

    • ○

      added the new optional request property bulk_created

      new-optional-request-property

    • ○

      added the new optional request property draft_created_at

      new-optional-request-property

    • ○

      added the new optional request property import_id

      new-optional-request-property

    • ○

      added the new optional request property last_action

      new-optional-request-property

    • ○

      added the new optional request property last_created_by

      new-optional-request-property

    • ○

      added the new optional request property parent_annotation

      new-optional-request-property

    • ○

      added the new optional request property parent_prediction

      new-optional-request-property

    • ○

      added the new optional request property unique_id

      new-optional-request-property

    • ○

      added the media type application/x-www-form-urlencoded to the request body

      request-body-media-type-added

    • ○

      added the media type multipart/form-data to the request body

      request-body-media-type-added

    • ○

      the request property lead_time became nullable

      request-property-became-nullable

    • ○

      the request property project became nullable

      request-property-became-nullable

    • ○

      the request property task became nullable

      request-property-became-nullable

    • ○

      the request property updated_by became nullable

      request-property-became-nullable

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

  • 04ff286141b52See the full diff
    • ○

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

      response-property-all-of-added

    • ○

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

      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.