Merge pull request #883 from superannotateai/develop

Develop

Author: VaghinakDev

CHANGELOG.rst

@@ -6,6 +6,24 @@ History
 
 All release highlights of this project will be documented in this file.
 
+4.6.0 - Aug 16, 2026
+____________________
+
+**Added**
+
+    - ``SAClient.grant_team_user_permissions()`` Grants permissions to a team user, with support for granting specific permissions or all available permissions based on the user's role.
+    - ``SAClient.revoke_team_user_permissions()`` Revokes permissions from a team user, with support for revoking specific permissions or all available permissions based on the user's role.
+
+**Updated**
+
+    - ``SAClient.upload_annotations()`` Added the ``integration`` parameter to sign private external URLs when creating new items in Multimodal projects. The integration must already exist on SuperAnnotate and is supported only when ``data_spec="multimodal"``.
+    - ``SAClient(token=<API key>)`` Added support for authentication using both Personal API Keys and Team API Keys.
+
+**Removed**
+
+    - ``SAClient.search_team_contributors()`` Recommended replacements: ``SAClient.get_item_metadata()`` or ``SAClient.list_items()``
+    - ``SAClient.search_items()`` Recommended replacements: ``SAClient.get_user_metadata()`` or ``SAClient.list_users()``
+
 4.5.9 - July 21, 2026
 _____________________
 **Updated**
@@ -15,6 +33,11 @@ _____________________
 4.5.8 - July 12, 2026
 _____________________
 
+**Added**
+
+    - ``SAClient.grant_team_user_permissions()`` Grants team-level user permissions.
+    - ``SAClient.revoke_team_user_permissions()`` Revokes team-level user permissions.
+
 **Updated**
 
     - ``SAClient.generate_items()`` The name key now supports values with up to 200 characters.

README.rst

@@ -31,7 +31,7 @@ Authentication
     # by environment variable SA_TOKEN
     sa_client = SAClient()
     # by token
-    sa_client = SAClient(token='<team 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')
@@ -42,8 +42,9 @@ config.ini example
 .. code-block:: python
 
     [DEFAULT]
-    SA_TOKEN = <Token>
+    SA_TOKEN = <API key>
     LOGGING_LEVEL = INFO
+    LOGGING_PATH = /Users/username/data/superannotate_logs
 
 
 Using superannotate
@@ -54,7 +55,7 @@ Using superannotate
     from superannotate import SAClient
 
 
-    sa_client =SAClient()
+    sa_client = SAClient()
 
     project = 'Dogs'
 
@@ -110,34 +111,6 @@ Windows (`Anaconda <https://www.anaconda.com/products/individual#windows>`__
 ) platforms.
 
 
-Supported Features
-------------------
-
-- search/get/create/clone/update/delete projects
-- search/get/create/delete folders
-- assign folders to project contributors
-- upload items to a project from a local or AWS S3 folder
-- attach items by URL or from an integrated storage, meanwhile keeping them secure in your cloud provider
-- get integrated cloud storages
-- upload annotations (also from local or AWS S3 folder)
-- delete annotations
-- set items annotations statuses
-- get/download/export annotations from a project (also to a local or AWS S3 folder)
-- invite/search team contributors or add contributors to a specific project
-- search/get/copy/move items in a project
-- query items using SA Query Language
-- define custom metadata for items and upload custom values (query based on your custom metadata)
-- upload priority scores
-- get available subsets (sets of segregated items), query items in a subset or add items to a subset
-- assign or anassign items to project contributors
-- download an image that has been uploaded to project
-- search/create/download/delete project annotation classes
-- search/download models
-- run predictions
-- convert annotations from/to COCO format
-- convert annotation from VOC, SuperVisely, LabelBox, DataLoop, VGG, VoTT, SageMaker, GoogleCloud, YOLO formats
-- CLI commands for simple tasks
-
 Questions and Issues
 --------------------
 

docs/source/api_reference/api_item.rst

@@ -6,7 +6,6 @@ Items
 .. automethod:: superannotate.SAClient.query
 .. automethod:: superannotate.SAClient.get_item_by_id
 .. automethod:: superannotate.SAClient.list_items
-.. automethod:: superannotate.SAClient.search_items
 .. automethod:: superannotate.SAClient.attach_items
 .. automethod:: superannotate.SAClient.generate_items
 .. automethod:: superannotate.SAClient.item_context

docs/source/api_reference/api_team.rst

@@ -7,7 +7,6 @@ Team
 .. automethod:: superannotate.SAClient.list_workflows
 .. automethod:: superannotate.SAClient.get_integrations
 .. automethod:: superannotate.SAClient.invite_contributors_to_team
-.. automethod:: superannotate.SAClient.search_team_contributors
 .. automethod:: superannotate.SAClient.get_user_metadata
 .. automethod:: superannotate.SAClient.set_user_custom_field
 .. automethod:: superannotate.SAClient.list_users
@@ -18,3 +17,5 @@ Team
 .. automethod:: superannotate.SAClient.set_user_scores
 .. automethod:: superannotate.SAClient.set_contributors_categories
 .. automethod:: superannotate.SAClient.remove_contributors_categories
+.. automethod:: superannotate.SAClient.grant_team_user_permissions
+.. automethod:: superannotate.SAClient.revoke_team_user_permissions

docs/source/cli_client.rst

@@ -22,11 +22,11 @@ ________________________
 Initialization and configuration
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-To initialize CLI (and SDK) with team token:
+To initialize CLI (and SDK) with an API key:
 
 .. code-block:: bash
 
-   superannotatecli init --token <token>
+   superannotatecli init --token <API key>
                          [--logging_level <NOTSET/INFO/DEBUG/WARNING/ERROR/CRITICAL (Default=INFO)>]
                          [--logging_path <Default=/Users/username/.superannotate/logs>]
 

docs/source/userguide/SDK_Functions_sheet.csv

@@ -31,7 +31,6 @@ Folders,search_folders(),Yes,Not Relevant,Not Relevant,Not Relevant,Not Relevant
 Items,query(),Yes,Not Relevant,Not Relevant,Not Relevant,Not Relevant
 ,get_item_by_id(),Yes,Not Relevant,Not Relevant,Not Relevant,Not Relevant
 ,list_items(),Yes,Not Relevant,Not Relevant,Not Relevant,Not Relevant
-,search_items(),Yes,Not Relevant,Not Relevant,Not Relevant,Not Relevant
 ,attach_items(),Not Relevant,Not Relevant,No,No,Not Relevant
 ,item_context(),Yes,Not Relevant,Not Relevant,Not Relevant,Not Relevant
 ,copy_items(),Yes,Not Relevant,Not Relevant,Not Relevant,Not Relevant
@@ -74,7 +73,6 @@ Images,download_image(),Not Relevant,Not Relevant,Not Relevant,Not Relevant,Not
 Team,get_team_metadata(),Not Relevant,Not Relevant,Not Relevant,Not Relevant,Not Relevant
 ,get_integrations(),Not Relevant,Not Relevant,Not Relevant,Not Relevant,Not Relevant
 ,invite_contributors_to_team(),Not Relevant,Not Relevant,Not Relevant,Not Relevant,Not Relevant
-,search_team_contributors(),Not Relevant,Not Relevant,Not Relevant,Not Relevant,Not Relevant
 ,get_user_metadata(),Not Relevant,Not Relevant,Not Relevant,Not Relevant,Not Relevant
 ,set_user_custom_field(),Not Relevant,Not Relevant,Not Relevant,Not Relevant,Not Relevant
 ,list_users(),Not Relevant,Not Relevant,Not Relevant,Not Relevant,Not Relevant

docs/source/userguide/quickstart.rst

@@ -31,8 +31,16 @@ It can be installed on Ubuntu with:
 Initialization and authorization
 ================================
 
-To use the SDK, you need to create a config file with a team-specific authentication token. The token is available
-to team admins on the team settings page at https://doc.superannotate.com/docs/token-for-python-sdk#generate-a-token-for-python-sdk.
+To use the SDK, you need to create a config file with an API key. The API key is available to team owners and team admins
+on the team setup page, for more details please visit our documentation at https://doc.superannotate.com/docs/api-keys.
+
+**API key types**
+
+- **Team API key** — scoped to one team. Works with ``SAClient``.
+- **Personal (team-user) API key** — scoped to one team, tied to your user. Works with ``SAClient``.
+- **Organization API key** — not scoped to a team. Not supported by the SDK;
+  ``SAClient`` will reject it.
+
 
 SAClient can be used with or without arguments
 ______________________________________________
@@ -52,7 +60,7 @@ ______________________________________________
 
 .. code-block:: bash
 
-   superannotatecli init --token <token>
+   superannotatecli init --token <API key>
                          [--logging_level <NOTSET/INFO/DEBUG/WARNING/ERROR/CRITICAL (Default=INFO)>]
                          [--logging_path <Default=/Users/username/.superannotate/logs>]
 
@@ -66,7 +74,7 @@ ______________________________________________
    from superannotate import SAClient
 
 
-   SAClient(token="<token>")
+   sa_client = SAClient(token="<API key>")
 
 
 *Method 2:* Create a custom config file:
@@ -84,7 +92,7 @@ Custom config.ini example:
 .. code-block:: ini
 
     [DEFAULT]
-    SA_TOKEN = <token>
+    SA_TOKEN = <API key>
     LOGGING_LEVEL = INFO
     LOGGING_PATH = /Users/username/data/superannotate_logs
 

pytest.ini

@@ -3,4 +3,4 @@ minversion = 3.7
 log_cli=true
 python_files = test_*.py
 ;pytest_plugins = ['pytest_profiling']
-;addopts = -n 6 --dist loadscope
+addopts = -n 6 --dist loadscope

requirements.txt

@@ -1,11 +1,11 @@
 pydantic~=2.5
 pydantic-extra-types~=2.11
-aiohttp~=3.8
+aiohttp~=3.14
 boto3~=1.42
 opencv-python-headless~=4.7
 plotly~=6.5
 pandas~=2.0
-pillow~=12.1
+pillow~=12.3
 tqdm~=4.66
 requests~=2.33
 aiofiles~=25.1

src/superannotate/__init__.py

@@ -2,7 +2,7 @@
 import os
 import sys
 
-__version__ = "4.5.9"
+__version__ = "4.6.0dev1"
 
 
 os.environ.update({"sa_version": __version__})