Sign in

v76

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-015764591.5 MB
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

completed_byinteger

User ID of the person who created this annotation

ground_truthboolean

This annotation is a Ground Truth

lead_timenumber

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

projectinteger

Project ID for this annotation

resultobject[]

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

taskinteger

Corresponding task for this annotation

updated_byinteger

Last user who updated this annotation

was_cancelledboolean

User skipped the task

Example request

{
  "ground_truth": true,
  "result": [
    {
      "from_name": "bboxes",
      "image_rotation": 0,
      "original_height": 1080,
      "original_width": 1920,
      "to_name": "image",
      "type": "rectanglelabels",
      "value": {
        "height": 60,
        "rotation": 0,
        "values": {
          "rectanglelabels": [
            "Person"
          ]
        },
        "width": 50,
        "x": 20,
        "y": 30
      }
    }
  ],
  "was_cancelled": false
}

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