superannotate

Welcome to the SuperAnnotate Python Software Development Kit (SDK), which enables Python programmers to create software that incorporates services of the platform and effortlessly integrates SuperAnnotate into their AI process.

Resources

API Reference and User Guide available on Read the Docs
Platform documentation

Authentication

from superannotate import SAClient
# by environment variable SA_TOKEN
sa_client = SAClient()
# by token
sa_client = SAClient(token='<API key>')
# by config file
# default path is ~/.superannotate/config.ini
sa_client = SAClient(config_path='~/.superannotate/dev_config.ini')

config.ini example

[DEFAULT]
SA_TOKEN = <API key>
LOGGING_LEVEL = INFO
LOGGING_PATH = /Users/username/data/superannotate_logs

Using superannotate

from superannotate import SAClient


sa_client = SAClient()

project = 'Dogs'

sa_client.create_project(
        project_name=project,
        project_description='Test project generated via SDK',
        project_type='Vector'
    )

sa_client.create_annotation_class(
    project=project,
    name='dog',
    color='#F9E0FA',
    class_type='tag'
)

sa_client.attach_items(
        project=project,
        attachments=[
            {
                'url': 'https://drive.google.com/uc?export=download&id=1ipOrZNSTlPUkI_hnrW9aUD5yULqqq5Vl',
                'name': 'dog.jpeg'
            }
        ]
    )

sa_client.upload_annotations(
        project=project,
        annotations=[
            {
                'metadata': {'name': 'dog.jpeg'},
                'instances': [
                    {'type': 'tag', 'className': 'dog'}
                ]
            }
        ]
    )

sa_client.get_annotations(project=project, items=['dog.jpeg'])

Installation

SuperAnnotate python SDK is available on PyPI:

pip install superannotate

The package officially supports Python 3.10+ and was tested under Linux and Windows (Anaconda ) platforms.

Questions and Issues

For questions and issues please use this repo’s issue tracker on GitHub or contact support@superannotate.com.

Metadata

Release files for superannotate 4.6.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for superannotate 4.6.1
File	Size	Uploaded
superannotate-4.6.1.tar.gz	212.7 kB	Sep 13, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for superannotate 4.6.1
File	Interpreter	ABI	Platform	Reset
superannotate-4.6.1-py3-none-any.whl 266.4 kB Sep 13, 2026	Python 3	none	any	Details

Total release size: 479.1 kB

Release files / superannotate-4.6.1.tar.gz

Download URL	superannotate-4.6.1.tar.gz
Size	212.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`534f456a92c0da2b13f60b9fab2feff20fa397a068817ecb7b816a43be46404f`
BLAKE2b-256 checksum How to use checksums	`e6096cf92ffeecfaec0903ae8f3018fa5edb518bd2f375023bec1be89534f6b3`
Upload date	Sep 13, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Release files / superannotate-4.6.1-py3-none-any.whl

Download URL	superannotate-4.6.1-py3-none-any.whl
Size	266.4 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`a4654c6c78219ce624fa9e032e404c346ee076db1655f6a807049be8818474af`
BLAKE2b-256 checksum How to use checksums	`60e35fcbcf992a7f4411b01c1b0028da5fe9b81ad17824e83c1b72e3c0616816`
Upload date	Sep 13, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.13.14`