Get annotation by its ID | API Reference

curl http://localhost:8000/api/annotations/1/ \
     -H "Authorization: Token  <api_key>" \
     -H "Content-Type: application/json"

{
  "created_ago": "2 hours ago",
  "created_at": "2024-06-18T23:45:46.048490Z",
  "created_username": "annotator_jane",
  "id": 1,
  "state": "CREATED",
  "updated_at": "2024-06-18T23:45:46.048538Z",
  "completed_by": 42,
  "ground_truth": false,
  "lead_time": 125.5,
  "project": 7,
  "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
      }
    }
  ],
  "task": 15,
  "updated_by": 42,
  "was_cancelled": false
}

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

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: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>

Path parameters

idintegerRequired

Response

Retrieved annotation

created_agostringRead-onlyDefaults to

Time delta from creation time

created_atdatetimeRead-only

Creation time

created_usernamestringRead-onlyDefaults to

Username string

idintegerRead-only

statestringRead-only

updated_atdatetimeRead-only

Last updated time

bulk_createdboolean or null

Annotation was created in bulk mode

completed_byinteger

draft_created_atdatetime or null

Draft creation time

ground_truthboolean

This annotation is a Ground Truth (ground_truth)

import_idlong or null-9223372036854776000-9223372036854776000

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

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 or null

User who created the last annotation history item

lead_timedouble or null

How much time it took to annotate the task

parent_annotationinteger or null

Points to the parent annotation from which this annotation was created

parent_predictioninteger or null

Points to the prediction from which this annotation was created

projectinteger or null

Project ID for this annotation

resultlist of objects

List of annotation results for the task

taskinteger or null

Corresponding task for this annotation

updated_byinteger or null

Last user who updated this annotation

was_cancelledboolean

User skipped the task