Reference

Annotations

client.annotations.get(...)

📝 Description

Tasks can have multiple annotations. Use this call to retrieve a specific annotation using its ID.

You can find the ID in the Label Studio UI listed at the top of the annotation in its tab. It is also listed in the History panel when viewing the annotation. Or you can use Get all task annotations to find all annotation IDs.

🔌 Usage

from label_studio_sdk import LabelStudio

client = LabelStudio(
    api_key="YOUR_API_KEY",
)
client.annotations.get(
    id=1,
)

⚙️ Parameters

id: int — A unique integer value identifying this annotation.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.annotations.delete(...)

📝 Description

Delete an annotation.

This action can't be undone!

You will need to supply the annotation's unique ID. You can find the ID in the Label Studio UI listed at the top of the annotation in its tab. It is also listed in the History panel when viewing the annotation. Or you can use Get all task annotations to find all annotation IDs.

🔌 Usage

from label_studio_sdk import LabelStudio

client = LabelStudio(
    api_key="YOUR_API_KEY",
)
client.annotations.delete(
    id=1,
)

⚙️ Parameters

id: int — A unique integer value identifying this annotation.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.annotations.update(...)

📝 Description

Update attributes for an existing annotation.

You will need to supply the annotation's unique ID. You can find the ID in the Label Studio UI listed at the top of the annotation in its tab. It is also listed in the History panel when viewing the annotation. Or you can use Get all task annotations to find all annotation IDs.

For information about the JSON format used in the result, see Label Studio JSON format of annotated tasks.

🔌 Usage

from label_studio_sdk import LabelStudio

client = LabelStudio(
    api_key="YOUR_API_KEY",
)
client.annotations.update(
    id=1,
    result=[
        {
            "original_width": 1920,
            "original_height": 1080,
            "image_rotation": 0,
            "from_name": "bboxes",
            "to_name": "image",
            "type": "rectanglelabels",
            "value": {
                "x": 20,
                "y": 30,
                "width": 50,
                "height": 60,
                "rotation": 0,
                "values": {"rectanglelabels": ["Person"]},
            },
        }
    ],
    was_cancelled=False,
    ground_truth=True,
)

⚙️ Parameters

id: int — A unique integer value identifying this annotation.

result: typing.Optional[typing.Sequence[typing.Dict[str, typing.Optional[typing.Any]]]] — Labeling result in JSON format. Read more about the format in the Label Studio documentation.

task: typing.Optional[int] — Corresponding task for this annotation

project: typing.Optional[int] — Project ID for this annotation

completed_by: typing.Optional[int] — User ID of the person who created this annotation

updated_by: typing.Optional[int] — Last user who updated this annotation

was_cancelled: typing.Optional[bool] — User skipped the task

ground_truth: typing.Optional[bool] — This annotation is a Ground Truth

lead_time: typing.Optional[float] — How much time it took to annotate the task (in seconds)

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.annotations.list(...)

📝 Description

List all annotations for a task.

You will need to supply the task ID. You can find this in Label Studio by opening a task and checking the URL. It is also listed at the top of the labeling interface. Or you can use Get tasks list.

🔌 Usage

from label_studio_sdk import LabelStudio

client = LabelStudio(
    api_key="YOUR_API_KEY",
)
client.annotations.list(
    id=1,
)

⚙️ Parameters

id: int — Task ID

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.annotations.create(...)

📝 Description

Add annotations to a task like an annotator does.

You will need to supply the task ID. You can find this in Label Studio by opening a task and checking the URL. It is also listed at the top of the labeling interface. Or you can use Get tasks list.

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:

{
"result": {},
"was_cancelled": true,
"ground_truth": true,
"lead_time": 0,
"task": 0
"completed_by": 123
}

🔌 Usage

from label_studio_sdk import LabelStudio

client = LabelStudio(
    api_key="YOUR_API_KEY",
)
client.annotations.create(
    id=1,
    result=[
        {
            "original_width": 1920,
            "original_height": 1080,
            "image_rotation": 0,
            "from_name": "bboxes",
            "to_name": "image",
            "type": "rectanglelabels",
            "value": {
                "x": 20,
                "y": 30,
                "width": 50,
                "height": 60,
                "rotation": 0,
                "values": {"rectanglelabels": ["Person"]},
            },
        }
    ],
    was_cancelled=False,
    ground_truth=True,
)