ProjectApi ¶

static info_sequence()[source]¶

Sequence of fields that are returned by the API to represent ProjectInfo.

Usage Example:

ProjectInfo(
    id=999,
    name="Cat_breeds",
    description="",
    size="861069",
    readme="",
    workspace_id=58,
    images_count=10,
    items_count=10,
    datasets_count=2,
    created_at="2020-11-17T17:44:28.158Z",
    updated_at="2021-03-01T10:51:57.545Z",
    type="images",
    reference_image_url="http://app.supervisely.com/h5un6l2bnaz1vj8a9qgms4-public/images/original/...jpg",
    custom_data={},
    backup_archive={},
    team_id=2,
    import_settings={},
    version={"id": 260, "version": 3},
    created_by_id=7,
    embeddings_enabled=False,
    embeddings_updated_at=None,
    embeddings_in_progress=False,
    local_entities_count=10,
    remote_entities_count=0,
)

static info_sequence_for_listing()[source]¶

NamedTuple ProjectInfo fields available for listing operations.

This subset includes only fields that are available in the projects.list API endpoint. For complete project information, use get_info_by_id().

Returns:: List of API field names available for listing
Return type:: List[str]

static info_tuple_name()[source]¶: Name of the tuple that represents ProjectInfo.

add_import_history(id, task_id)[source]¶

Adds import history to project info. Gets task info and adds it to project custom data.

Parameters:

id : int¶: Project ID
task_id : int¶: Task ID

Returns:

None

Return type:

None

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()
project_id = 123
task_id = 456
api.project.add_import_history(project_id, task_id)

append_classes(id, classes)[source]¶

Append new classes to given Project.

Parameters:

id : int¶: Project ID in Supervisely.
classes¶: New classes

Returns:

None

Return type:

None

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

proj_id = 28145
lung_obj_class = sly.ObjClass("lung", sly.Mask3D)
api.project.append_classes(proj_id, [lung_obj_class])

archive(id, archive_url, ann_archive_url=None)[source]¶

Archive Project by ID and save backup URLs in Project info.

Parameters:

id : int¶: Project ID in Supervisely.
archive_url : str¶: Shared URL of files backup on Dropbox.
ann_archive_url : str, optional¶: Shared URL of annotations backup on Dropbox.

Returns:

None

Return type:

None

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

id = 18464
archive_url = 'https://www.dropbox.com/...'
api.project.archive(id, archive_url, ann_archive_url)

archive_batch(ids, archive_urls, ann_archive_urls=None)[source]¶

Archive Projects by ID and save backup URLs in Project info for every Project.

Parameters:

ids : List[int]¶: Project IDs in Supervisely.
archive_urls : List[str]¶: Shared URLs of files backup on Dropbox.
ann_archive_urls : List[str], optional¶: Shared URLs of annotations backup on Dropbox.

Returns:

None

Return type:

None

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

ids = [18464, 18461]
archive_urls = ['https://www.dropbox.com/...', 'https://www.dropbox.com/...']
api.project.archive_batch(ids, archive_urls, ann_archive_urls)

calculate_embeddings(id)[source]¶

Calculate embeddings for the project. This method is used to calculate embeddings for all images in the project.

To check status of embeddings calculation, use get_embeddings_in_progress()

Parameters:

id : int¶: Project ID

Returns:

None

Return type:

None

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

project_id = 123
# Calculate embeddings for the project
api.project.calculate_embeddings(project_id)

check_imageset_backup(id)[source]¶

Check if a backup of the project image set exists. If yes, it returns a link to the archive.

Parameters:

id : int¶: Project ID

Returns:

dict with shared URL of files backup or None

Return type:

Dict, optional

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

response = check_imageset_backup(project_id)
archive_url = response['imagesArchiveUrl']

clone(id, dst_workspace_id, dst_name)¶

Clones the entity with the given ID to the given workspace with the given name. Returns the ID of the task that is created to perform the cloning operation.

Parameters:

id : int¶: ID of the entity to clone.
dst_workspace_id : int¶: ID of the workspace to clone to.
dst_name : str¶: Name of the cloned entity.

Returns:

Returns the ID of the task that is created to perform the cloning operation.

Return type:

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

# ID of the entity to clone
project_id = 123456

# ID of the destination workspace
workspace_id = 123456

# Create a task to clone the project
task_id = api.project.clone(project_id, workspace_id, "my_cloned_project")

# Wait until the task is finished
api.task.wait(task_id, api.task.Status.FINISHED)

task_info = api.task.get_info_by_id(task_id)

dst_project_id = task_info["meta"]["output"]["project"]["id"]
print(f"Cloned project ID: {dst_project_id}")

clone_by_shared_link(shared_link, dst_workspace_id, dst_name)¶

Clones the entity with the given shared link to the given workspace with the given name. Returns the ID of the task that is created to perform the cloning operation.

Parameters:

shared_link : str¶: Shared link of the entity to clone.
dst_workspace_id : int¶: ID of the workspace to clone to.
dst_name : str¶: Name of the cloned entity.

Returns:

Returns the ID of the task that is created to perform the cloning operation.

Return type:

clone_from_explore(explore_path, dst_workspace_id, dst_name)¶

Clones the entity with the given explore path to the given workspace with the given name. Returns the ID of the task that is created to perform the cloning operation.

Parameters:

explore_path : str¶: Explore path of the entity to clone.
dst_workspace_id : int¶: ID of the workspace to clone to.
dst_name : str¶: Name of the cloned entity.

Returns:

Returns the ID of the task that is created to perform the cloning operation.

Return type:

create(workspace_id, name, type=ProjectType.IMAGES, description='', change_name_if_conflict=False, readme=None, settings=None, custom_data=None, read_only=None)[source]¶

Create Project with given name in the given Workspace ID.

Parameters:

workspace_id : int¶: Workspace ID in Supervisely where Project will be created.
name : str¶: Project Name.
type=ProjectType.IMAGES¶: Type of project. Example: ProjectType.IMAGES, ProjectType.VIDEOS and etc.
description : str¶: Project description.
change_name_if_conflict : bool, optional¶: Checks if given name already exists and adds suffix to the end of the name.
readme : str, optional¶: Project readme.
settings : dict, optional¶: Optional project settings dict.
custom_data : dict, optional¶: Optional custom metadata dict.
read_only : bool, optional¶: Optional flag to set the project as read-only. Works only with image and video projects. If set to True, the project will be created with read-only settings, and users will not be able to modify annotations in this project. Default is False.

Returns:

ProjectInfo object with information about the Project.

Return type:

ProjectInfo

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

workspace_id = 8
new_proj = api.project.create(workspace_id, "fruits_test", sly.ProjectType.IMAGES)
print(new_proj)
# Output: ProjectInfo(id=1993,
#                     name='fruits_test',
#                     description='',
#                     size='0',
#                     readme='',
#                     workspace_id=58,
#                     images_count=None,
#                     items_count=None,
#                     datasets_count=None,
#                     created_at='2021-03-11T09:28:42.585Z',
#                     updated_at='2021-03-11T09:28:42.585Z',
#                     type='images',
#                     reference_image_url=None,
#                     custom_data={},
#                     backup_archive={},
#                     import_settings={}
#                   )

disable_embeddings(id, silent=True)[source]¶

Disable embeddings for the project.

Parameters:

id : int¶: Project ID
silent : bool¶: Determines whether the updatedAt timestamp of the Project should be updated or not. If False, updatedAt will be updated.

Returns:

None

Return type:

None

download_images_tags(id, progress_cb=None)[source]¶

Get matching tag names to ImageInfos.

Parameters:

id : int¶: Project ID in Supervisely.
progress_cb : tqdm or callable, optional¶: Function for tracking download progress.

Returns:

Defaultdict matching tag names to ImageInfos

Return type:

defaultdict

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

project_id = 8200
tags_to_infos = api.project.download_images_tags(project_id)
for tag_name in tags_to_infos:
    print(tag_name, tags_to_infos[tag_name])
# Output:
# train [ImageInfo(id=2389064, name='IMG_4451_JjH4WPkHlk.jpeg', link=None, hash='6EpjCL+lBdMBYo...
# val [ImageInfo(id=2389066, name='IMG_1836.jpeg', link=None, hash='Si0WvJreU6pmrx1EDa1itkqqSkQkZFzNJSu...

edit_info(id, name=None, description=None, readme=None, custom_data=None, project_type=None)[source]¶

Edits the project info by given parameters.

Parameters:

id : int¶: ID of the project to edit info
name : Optional[str]¶: new name of the project
description : Optional[str]¶: new description of the project
readme : Optional[str]¶: new readme of the project
custom_data : Optional[Dict[Any, Any]]¶: new custom data of the project
project_type : Optional[str]¶: new type of the project

Returns:

ProjectInfo of the edited project

Return type:

ProjectInfo

Raises:

ValueError – if no arguments are specified
ValueError – if invalid project type is specified
ValueError – if project with given id already has given type
ValueError – if conversion from current project type to given project type is not supported

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

project_id = 123
new_name = "new_name"
new_description = "new_description"
project_info = api.project.edit_info(project_id, name=new_name, description=new_description)

enable_embeddings(id, silent=True)[source]¶

Enable embeddings for the project.

Parameters:

id : int¶: Project ID
silent : bool¶: Determines whether the updatedAt timestamp of the Project should be updated or not. If False, updatedAt will be updated.

Returns:

None

Return type:

None

exists(parent_id, name)¶

Checks if an entity with the given parent_id and name exists

Parameters:

parent_id : int¶: ID of the parent entity.
name : str¶: Name of the entity.

Returns:

Returns True if entity exists, and False if not

Return type:

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

name = "IMG_0315.jpeg"
dataset_id = 55832
exists = api.image.exists(dataset_id, name)
print(exists) # True

get_activity(id, progress_cb=None)[source]¶

Get Project activity by ID.

Parameters:

id : int¶: Project ID in Supervisely.

Returns:

Pandas DataFrame with project activity.

Return type:

pandas.DataFrame

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

project_id = 1951
project_activity = api.project.get_activity(project_id)
print(project_activity)
# Output:    userId               action  ... tagId             meta
#         0       7  annotation_duration  ...  None  {'duration': 1}
#         1       7  annotation_duration  ...  None  {'duration': 2}
#         2       7        create_figure  ...  None               {}
#
#         [3 rows x 18 columns]

get_archivation_list(to_day=None, from_day=None, skip_exported=None, sort=None, sort_order=None, account_type=None)[source]¶

List of all projects in all available workspaces that can be archived.

Parameters:

to_day : int, optional¶: Sets the number of days from today. If the project has not been updated during this period, it will be added to the list.
from_day : int, optional¶: Sets the number of days from today. If the project has not been updated before this period, it will be added to the list.
skip_exported : bool, optional.¶: Determines whether to skip already archived projects.
sort : Optional[Literal["id", "title", "size", "createdAt", "updatedAt"]]¶: Specifies by which parameter to sort the project list.
sort_order : Optional[Literal["asc", "desc"]]¶: Determines which value to list from.

Returns:

List of ProjectInfo objects.

Return type:

List[ProjectInfo]

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

project_list = api.project.get_archivation_list()
print(project_list)
# Output: [
# ProjectInfo(id=861,
#             name='Project_COCO'
#             size='22172241',
#             workspace_id=58,
#             created_at='2020-11-09T18:21:32.356Z',
#             updated_at='2020-11-09T18:21:32.356Z',
#             type='images',
#             ...
#             ),
# ProjectInfo(id=777,
#             name='Trucks',
#             size='76154769',
#             workspace_id=58,
#             created_at='2021-07-077T17:44:28.158Z',
#             updated_at='2023-07-15T12:33:45.747Z',
#             type='images',)
# ]

# Project list for desired date range
project_list = api.project.get_archivation_list(to_day=2)
print(project_list)
# Output: ProjectInfo(id=777,
#                     name='Trucks',
#                     size='76154769',
#                     workspace_id=58,
#                     created_at='2021-07-077T17:44:28.158Z',
#                     updated_at='2023-07-15T12:33:45.747Z',
#                     type='images',
#                     ...
#                     )
# ]

get_custom_data(id)[source]¶

Returns custom data of the Project by ID. Custom data is a dictionary that can be used to store any additional information.

Parameters:

id : int¶: Project ID in Supervisely.

Returns:

Custom data of the project.

Return type:

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

project_id = 123456
custom_data = api.project.get_custom_data(project_id)
print(custom_data) # Output: {'key': 'value'}

get_datasets_count(id)[source]¶

Number of Datasets in the given Project by ID.

Parameters:

id : int¶: Project ID in Supervisely.

Returns:

Number of Datasets in the given project.

Return type:

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

project_id = 454
project_ds_count = api.project.get_datasets_count(project_id)
print(project_ds_count)
# Output: 4

get_embeddings_in_progress(id)[source]¶

Get the embeddings in progress status for the project. This method checks whether embeddings are currently being created for the project.

Parameters:

id : int¶: Project ID

Returns:

True if embeddings are in progress, False otherwise.

Return type:

get_embeddings_updated_at(id)[source]¶

Get the timestamp when embeddings were last updated for the project.

Parameters:

id : int¶: Project ID

Returns:

ISO format timestamp (YYYY-MM-DDTHH:MM:SS.fffZ) or None if not set.

Return type:

Optional[str]

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

# Get embeddings updated timestamp
project_id = 123
updated_at = api.project.get_embeddings_updated_at(project_id)
print(updated_at)  # Output: "2025-06-01T10:30:45.123Z" or None

get_free_name(parent_id, name)¶

Generates a free name for an entity with the given parent_id and name. Adds an increasing suffix to original name until a unique name is found.

Parameters:

parent_id : int¶: ID of the parent entity.
name : str¶: Name of the entity.

Returns:

Returns free name.

Return type:

str

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

name = "IMG_0315.jpeg"
dataset_id = 55832
free_name = api.image.get_free_name(dataset_id, name)
print(free_name) # IMG_0315_001.jpeg

get_images_count(id)[source]¶

Number of images in the given Project by ID.

Parameters:

id : int¶: Project ID in Supervisely.

Returns:

Number of images in the given project.

Return type:

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

project_id = 454
project_imgs_count = api.project.get_images_count(project_id)
print(project_imgs_count)
# Output: 24

get_info_by_id(id, expected_type=None, raise_error=False, extra_fields=None)[source]¶

Get Project information by ID.

Parameters:

id : int¶: Project ID in Supervisely.
expected_type=None¶: Expected project type.
raise_error : bool, optional¶: If True raise error if given name is missing in the Project, otherwise skips missing names.
extra_fields : list[str], optional¶: List of extra fields to include in the response.

Returns:

ProjectInfo object with information about the Project.

Return type:

ProjectInfo

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

project_id = 1951
project_info = api.project.get_info_by_id(project_id)
print(project_info)
# Output: ProjectInfo(id=861,
#                     name='fruits_annotated',
#                     description='',
#                     size='22172241',
#                     readme='',
#                     workspace_id=58,
#                     images_count=6,
#                     items_count=6,
#                     datasets_count=1,
#                     created_at='2020-11-09T18:21:32.356Z',
#                     updated_at='2020-11-09T18:21:32.356Z',
#                     type='images',
#                     reference_image_url='http://78.46.75.100:38585/h5un6l2bnaz1vj8a9qgms4-public/images/original/...jpg',
#                     custom_data={},
#                     backup_archive={},
#                     import_settings={}
#                   )

get_info_by_name(parent_id, name, expected_type=None, raise_error=False)[source]¶

Get Project information by name.

Version information is not available while getting project by name. If you need version information, use get_info_by_id().

Parameters:

parent_id : int¶: Workspace ID.
name : str¶: Project name.
expected_type=None¶: Expected project type.
raise_error : bool, optional¶: If True raise error if given name is missing in the Project, otherwise skips missing names.

Returns:

ProjectInfo object with information about the Project.

Return type:

ProjectInfo

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

project_info = api.project.get_info_by_name(58, "fruits_annotated")
print(project_info)
# Output: ProjectInfo(id=861,
#                     name='fruits_annotated',
#                     description='',
#                     size='22172241',
#                     readme='',
#                     workspace_id=58,
#                     images_count=6,
#                     items_count=6,
#                     datasets_count=1,
#                     created_at='2020-11-09T18:21:32.356Z',
#                     updated_at='2020-11-09T18:21:32.356Z',
#                     type='images',
#                     reference_image_url='http://78.46.75.100:38585/h5un6l2bnaz1vj8a9qgms4-public/images/original/...jpg',
#                     custom_data={},
#                     backup_archive={},
#                     import_settings={}
#                   )

get_list(workspace_id=None, filters=None, fields=[], team_id=None)[source]¶

List of Projects in the given Workspace (without version info).

NOTE: Version information is not available while getting list of projects. If you need version information, use get_info_by_id().

Parameters:

workspace_id : int, optional¶: Workspace ID in which the Projects are located.
filters : List[dict], optional¶: List of params to sort output Projects.
fields : List[str]¶: The list of api fields which will be returned with the response. You must specify all fields you want to receive, not just additional ones.
team_id : int, optional¶: Team ID in which the Projects are located.

Returns:

List of all projects in the workspace (without version info). See info_sequence_for_listing().

Return type:

List[ProjectInfo]

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

workspace_id = 58
project_list = api.project.get_list(workspace_id)
print(project_list)
# Output: [
# ProjectInfo(id=861,
#             name='Project_COCO',
#             description='',
#             size='22172241',
#             readme='',
#             workspace_id=58,
#             images_count=6,
#             items_count=6,
#             datasets_count=1,
#             created_at='2020-11-09T18:21:32.356Z',
#             updated_at='2020-11-09T18:21:32.356Z',
#             type='images',
#             reference_image_url='http://78.46.75.100:38585/h5un6l2bnaz1vj8a9qgms4-public/images/original/...jpg',
#             custom_data={},
#             backup_archive={},
#             import_settings={}
#           ),
# ProjectInfo(id=999,
#             name='Cat_breeds',
#             description='',
#             size='861069',
#             readme='',
#             workspace_id=58,
#             images_count=10,
#             items_count=10,
#             datasets_count=2,
#             created_at='2020-11-17T17:44:28.158Z',
#             updated_at='2021-03-01T10:51:57.545Z',
#             type='images',
#             reference_image_url='http://78.46.75.100:38585/h5un6l2bnaz1vj8a9qgms4-public/images/original/...jpg',
#             custom_data={},
#             backup_archive={},
#             import_settings={}
#           )
# ]

# Filtered Project list
project_list = api.project.get_list(workspace_id, filters=[{ 'field': 'name', 'operator': '=', 'value': 'Cat_breeds'}])
print(project_list)
# Output: ProjectInfo(id=999,
#                     name='Cat_breeds',
#                     description='',
#                     size='861069',
#                     readme='',
#                     workspace_id=58,
#                     images_count=10,
#                     items_count=10,
#                     datasets_count=2,
#                     created_at='2020-11-17T17:44:28.158Z',
#                     updated_at='2021-03-01T10:51:57.545Z',
#                     type='images',
#                     reference_image_url='http://78.46.75.100:38585/h5un6l2bnaz1vj8a9qgms4-public/images/original/...jpg',
#                     custom_data={},
#                     backup_archive={},
#                     import_settings={}
#                   )
# ]

get_list_all(filters=None, skip_exported=True, sort=None, sort_order=None, per_page=None, page='all', account_type=None, extra_fields=None)[source]¶

List all available projects from all available teams for the user that match the specified filtering criteria.

Parameters:

filters : List[Dict[str, str]], optional¶: List of parameters for filtering the available Projects. Every Dict must consist of keys: - ‘field’: Takes values ‘id’, ‘projectId’, ‘workspaceId’, ‘groupId’, ‘createdAt’, ‘updatedAt’, ‘type’ - ‘operator’: Takes values ‘=’, ‘eq’, ‘!=’, ‘not’, ‘in’, ‘!in’, ‘>’, ‘gt’, ‘>=’, ‘gte’, ‘<’, ‘lt’, ‘<=’, ‘lte’ - ‘value’: Takes on values according to the meaning of ‘field’ or null
skip_exported : bool, optional.¶: Determines whether to skip archived projects.
sort : str, optional¶: Specifies by which parameter to sort the project list. Takes values ‘id’, ‘name’, ‘size’, ‘createdAt’, ‘updatedAt’
sort_order : str, optional¶: Determines which value to list from.
per_page : int, optional¶: Number of first items found to be returned. ‘None’ will return the first page with a default size of 20000 projects.
page : Union[int, Literal["all"]], optional¶: Page number, used to retrieve the following items if the number of them found is more than per_page. The default value is ‘all’, which retrieves all available projects. ‘None’ will return the first page with projects, the amount of which is set in param ‘per_page’.
account_type : str, optional¶: (Deprecated) Type of user account
extra_fields : List[str], optional¶: List of additional fields to be included in the response.

Returns:

Search response information and ‘ProjectInfo’ of all projects that are searched by a given criterion.

Return type:

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

filter_1 = {
    "field": "updatedAt",
    "operator": "<",
    "value": "2023-12-03T14:53:00.952Z"
}
filter_2 = {
    "field": "updatedAt",
    "operator": ">",
    "value": "2023-04-03T14:53:00.952Z"
}
filters = [filter_1, filter_2]
projects = api.projects.get_list_all(filters, True)
print(projects)
# Output:
# {
#     "total": 2,
#     "perPage": 20000,
#     "pagesCount": 1,
#     "entities": [ ProjectInfo(id = 22,
#                       name = 'lemons_annotated',
#                       description = None,
#                       size = '861069',
#                       readme = None,
#                       workspace_id = 2,
#                       images_count = None,
#                       items_count = None,
#                       datasets_count = None,
#                       created_at = '2020-04-03T13:43:24.000Z',
#                       updated_at = '2020-04-03T14:53:00.952Z',
#                       type = 'images',
#                       reference_image_url = None,
#                       custom_data = None,
#                       backup_archive = None,
#                       team_id = 1,
#                       import_settings = {},
#                   ),
#                   ProjectInfo(id = 23,
#                       name = 'lemons_test',
#                       description = None,
#                       size = '1177212',
#                       readme = None,
#                       workspace_id = 2,
#                       images_count = None,
#                       items_count = None,
#                       datasets_count = None,
#                       created_at = '2020-04-03T13:43:24.000Z',
#                       updated_at = '2020-04-03T14:53:00.952Z',
#                       type = 'images',
#                       reference_image_url = None,
#                       custom_data = None,
#                       backup_archive = None),
#                       team_id = 1,
#                       import_settings = {},
#                   )
#                 ]
# }

get_list_all_pages(method, data, progress_cb=None, convert_json_info_cb=None, limit=None, return_first_response=False)¶

Get list of all or limited quantity entities from the Supervisely server.

Parameters:

method : str¶: Request method name
data : dict¶: Dictionary with request body info
progress_cb : Progress, optional¶: Function for tracking download progress.
convert_json_info_cb : Callable, optional¶: Function for convert json info
limit : int, optional¶: Number of entity to retrieve
return_first_response : bool, optional¶: Specify if return first response

Returns:

List of entities.

Return type:

List[dict]

get_list_all_pages_generator(method, data, progress_cb=None, convert_json_info_cb=None, limit=None, return_first_response=False)¶

This generator function retrieves a list of all or a limited quantity of entities from the Supervisely server, yielding batches of entities as they are retrieved

Parameters:

method : str¶: Request method name
data : dict¶: Dictionary with request body info
progress_cb : Progress, optional¶: Function for tracking download progress.
convert_json_info_cb : Callable, optional¶: Function for convert json info
limit : int, optional¶: Number of entity to retrieve
return_first_response : bool, optional¶: Specify if return first response

async get_list_idx_page_async(method, data)¶

Get the list of items for a given page number. Page number is specified in the data dictionary.

Parameters:

method : str¶: Method to call for listing items.
data : dict¶: Data to pass to the API method.

Returns:

List of items.

Return type:

Tuple[int, List[NamedTuple]]

async get_list_page_generator_async(method, data, pages_count=None, semaphore=None)¶

Yields list of images in dataset asynchronously page by page.

Parameters:

method : str¶: Method to call for listing items.
data : dict¶: Data to pass to the API method.
pages_count : int, optional¶: Preferred number of pages to retrieve if used with a per_page limit. Will be automatically adjusted if the pagesCount differs from the requested number.
semaphore=None¶: Semaphore for limiting the number of simultaneous requests.

Returns:

List of images in dataset.

Return type:

AsyncGenerator[List[ImageInfo]]

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

method = 'images.list'
data = {'datasetId': 123456}

loop = sly.utils.get_or_create_event_loop()
images = loop.run_until_complete(api.image.get_list_generator_async(method, data))

get_meta(id, with_settings=False)[source]¶

Get ProjectMeta by Project ID.

Parameters:

id : int¶: Project ID in Supervisely.
with_settings : bool¶: Add settings field to the meta. By default False.

Returns:

ProjectMeta dict

Return type:

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

project_meta = api.project.get_meta(project_id)
print(project_meta)
# Output: {
#     "classes":[
#         {
#             "id":22310,
#             "title":"kiwi",
#             "shape":"bitmap",
#             "hotkey":"",
#             "color":"#FF0000"
#         },
#         {
#             "id":22309,
#             "title":"lemon",
#             "shape":"bitmap",
#             "hotkey":"",
#             "color":"#51C6AA"
#         }
#     ],
#     "tags":[],
#     "projectType":"images"
# }

get_or_clone_from_explore(explore_path, dst_workspace_id, dst_name)¶

get_or_create(workspace_id, name, type=ProjectType.IMAGES, description='')[source]¶

Returns project info if project with given name exists in given workspace, otherwise creates new project and returns info about it.

Parameters:

workspace_id : int¶: Workspace ID in which the Project will be searched or created.
name : str¶: name of the project to search or create
type=ProjectType.IMAGES¶: type of the project to create
description : Optional[str]¶: description of the project to create

Returns:

ProjectInfo about found or created project

Return type:

ProjectInfo

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

project_name = "my_project"
workspace_id = 123
project_info = api.project.get_or_create(workspace_id, project_name)

get_stats(id)[source]¶

Get Project stats by ID.

Parameters:

id : int¶: Project ID in Supervisely.

Returns:

Project statistics

Return type:

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

project_id = 1951
project_stats = api.project.get_stats(project_id)

get_validation_schema(id, use_caching=False)[source]¶

Returns validation schema of the Project by ID. Validation schema is a dictionary that can be used to validate metadata of each entity in the project if corresnpoding schema is provided. If using caching, the schema will be loaded from the cache if available. Use cached version only in scenarios when the schema is not expected to change, otherwise it may lead to checks with outdated schema.

Parameters:

id : int¶: Project ID in Supervisely.
use_caching=False¶: If True, uses cached version of the schema if available. NOTE: This may lead to checks with outdated schema. Use with caution. And only in scenarios when the schema is not expected to change.

Returns:

Validation schema of the project.

Return type:

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

project_id = 123456
validation_schema = api.project.get_validation_schema(project_id)
print(validation_schema) # Output: {'key': 'Description of the field'}

images_grouping(id, enable, tag_name, sync=False)[source]¶

Enables and disables images grouping by given tag name.

Parameters:

id : int¶: Project ID, where images grouping will be enabled.
enable : bool¶: if True groups images by given tag name, otherwise disables images grouping.
tag_name : str¶: Name of the tag. Images will be grouped by this tag.
sync : bool¶: Enable the syncronization views mode in the grouping settings. By default, False

is_embeddings_enabled(id)[source]¶

Check if embeddings are enabled for the project.

Parameters:

id : int¶: Project ID

Returns:

True if embeddings are enabled, False otherwise.

Return type:

is_read_only(id)[source]¶

Check if the project is read-only.

Parameters:

id : int¶: Project ID

Returns:

True if the project is read-only, False otherwise

Return type:

merge_metas(src_project_id, dst_project_id)[source]¶

Merges ProjectMeta from given Project to given destination Project.

Parameters:

src_project_id : int¶: Source Project ID.
dst_project_id : int¶: Destination Project ID.

Returns:

ProjectMeta dict

Return type:

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

lemons_proj_id = 1951
kiwis_proj_id = 1980
merged_projects = api.project.merge_metas(lemons_proj_id, kiwis_proj_id)

move(id, workspace_id)[source]¶

Move project between workspaces within current team.

Parameters:

id : int¶: Project ID
workspace_id : int¶: Workspace ID the project will move in

Returns:

None

Return type:

None

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

workspace_id = 688
project_id = 17173
api.project.move(id=project_id, workspace_id=workspace_id)

perform_ai_search(project_id, dataset_id=None, image_id=None, prompt=None, method=None, limit=100, clustering_method=None, num_clusters=None, image_id_scope=None, threshold=None)[source]¶

Send AI search request to initiate search process. This method allows you to search for similar images in a project using either a text prompt, an image ID, or a method type. It is mutually exclusive, meaning you can only provide one of the parameters: prompt, image_id, or method.

Parameters:

project_id : int¶: ID of the project.
dataset_id : Optional[int]¶: ID of the dataset. If not None - search will be limited to this dataset.
image_id : Optional[Union[int, List[int]]]¶: ID(s) of the image(s). Searches for images similar to the specified image(s).
prompt : Optional[str]¶: Text prompt for search request. Searches for similar images based on a text description.
method : Optional[Literal["centroids", "random"]]¶: Activates diverse search using one of the following methods: “centroids”, “random”.
limit : int¶: Limit for search request
clustering_method : Optional[Literal["kmeans", "dbscan"]]¶: Method for clustering results. Can be “kmeans” or “dbscan”. If None, no clustering is applied.
num_clusters : Optional[int]¶: Number of clusters to create if clustering_method is specified. Required for “kmeans” method.
image_id_scope : Optional[List[int]]¶: List of image IDs to limit the search scope. If None, the search will be performed across all images in the project if other filters are not set.
threshold : Optional[float]¶: Threshold for similarity. If provided, only images with similarity above this threshold will be returned.

Raises:

ValueError – Exactly one of prompt, image_id or method must be provided. If method is set, it must be one of the allowed values.

Returns:

Entitites Collection ID of the search results, or None if no collection was created.

Return type:

Optional[int]

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

project_id = 123
image_id = 789
prompt = "person with a dog"

# Search with text prompt
collection_id = api.project.perform_ai_search(
    project_id=project_id,
    prompt=prompt,
)

# Search with method
collection_id = api.project.perform_ai_search(
    project_id=project_id,
    method="centroids",
)

# Search with image ID
collection_id = api.project.perform_ai_search(
    project_id=project_id,
    image_id=image_id,
)

pull_meta_ids(id, meta)[source]¶

Updates given ProjectMeta with ids from server.

Parameters:

id : int¶: Project ID
meta¶: ProjectMeta to update ids

Returns:

None

Return type:

None

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

project_id = 123
# We already have ProjectMeta and now we want to update ids in it
# from server
meta: sly.ProjectMeta

api.project.pull_meta_ids(project_id, meta)

recreate_structure(src_project_id, dst_project_id=None, dst_project_name=None)[source]¶

This method can be used to recreate a project with hierarchial datasets (without the data itself).

Parameters:

src_project_id : int¶: Source project ID
dst_project_id : int, optional¶: Destination project ID
dst_project_name : str, optional¶: Name of the destination project. If dst_project_id is None, a new project will be created with this name. If dst_project_id is provided, this parameter will be ignored.

Returns:

List of tuples of source and destination DatasetInfo objects.

Return type:

List[Tuple[DatasetInfo, DatasetInfo]]

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

src_project_id = 123
dst_project_name = "New Project"
infos = api.project.recreate_structure(src_project_id, dst_project_name=dst_project_name)
print(f"Recreated project {src_project_id}")

recreate_structure_generator(src_project_id, dst_project_id=None, dst_project_name=None)[source]¶

This method can be used to recreate a project with hierarchial datasets (without the data itself) and yields the tuple of source and destination DatasetInfo objects.

Parameters:

src_project_id : int¶: Source project ID
dst_project_id : int, optional¶: Destination project ID
dst_project_name : str, optional¶: Name of the destination project. If dst_project_id is None, a new project will be created with this name. If dst_project_id is provided, this parameter will be ignored.

Returns:

Generator of tuples of source and destination DatasetInfo objects.

Return type:

Generator[Tuple[DatasetInfo, DatasetInfo], None, None]

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

src_project_id = 123
dst_project_id = api.project.create("new_project", "images").id

for src_ds, dst_ds in api.project.recreate_structure_generator(src_project_id, dst_project_id):
    print(f"Recreated dataset {src_ds.id} -> {dst_ds.id}")
    # Implement your logic here to process the datasets.

remove(id)¶

Remove an entity with the specified ID from the Supervisely server.

Parameters:

id : int¶: Entity ID in Supervisely

Returns:

None

Return type:

None

remove_batch(ids, progress_cb=None)¶

Remove entities with given IDs from the Supervisely server.

Parameters:

ids : List[int]¶: IDs of entities in Supervisely.
progress_cb : Callable¶: Function for control remove progress.

Returns:

None

Return type:

None

remove_permanently(ids, batch_size=50, progress_cb=None)[source]¶

!!! WARNING !!! Be careful, this method deletes data from the database, recovery is not possible.

Delete permanently projects with given IDs from the Supervisely server. All project IDs must belong to the same team. Therefore, it is necessary to sort IDs before calling this method.

Parameters:

ids : Union[int, List]¶: IDs of projects in Supervisely.
batch_size : int, optional¶: The number of entities that will be deleted by a single API call. This value must be in the range 1-50 inclusive, if you set a value out of range it will automatically adjust to the boundary values.
progress_cb : Callable, optional¶: Function for control delete progress.

Returns:

A list of response content in JSON format for each API call.

Return type:

List[dict]

remove_validation_schema(id)[source]¶

Removes validation schema of the Project by ID.

Parameters:

id : int¶: Project ID in Supervisely.

Returns:

ProjectInfo object in json format.

Return type:

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

project_id = 123456
api.project.remove_validation_schema(project_id)

set_embeddings_in_progress(id, in_progress, error_message=None)[source]¶

Set embeddings in progress status for the project. This method is used to indicate whether embeddings are currently being created for the project.

Parameters:

id : int¶: Project ID
in_progress : bool¶: Status to set. If True, embeddings are in progress right now.
error_message : Optional[str]¶: Optional error message to provide additional context.

Returns:

None

Return type:

None

set_embeddings_updated_at(id, timestamp=None, silent=True)[source]¶

Set the timestamp when embeddings were last updated for the project. If no timestamp is provided, uses the current UTC time.

Parameters:

id : int¶: Project ID
timestamp : Optional[str]¶: ISO format timestamp (YYYY-MM-DDTHH:MM:SS.fffffZ). If None, current UTC time is used.
silent : bool¶: Determines whether the updatedAt timestamp of the Project should be updated or not. If False, updatedAt will be updated.

Returns:

None

Return type:

None

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

# Set current time as embeddings update timestamp
project_id = 123
api.project.set_embeddings_updated_at(project_id)

# Set specific timestamp
api.project.set_embeddings_updated_at(project_id, "2025-06-01T10:30:45.123456Z")

set_multispectral_settings(project_id)[source]¶

Sets the project settings for multispectral images. Images will be grouped by tag and have synchronized view and labeling.

Parameters:

project_id : int¶: Project ID to set multispectral settings.

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()
api.project.set_multispectral_settings(project_id=123)

set_multiview_settings(project_id)[source]¶

Sets the project settings for multiview mode. Automatically detects project type and applies appropriate settings:

For IMAGE projects: Images are grouped by tag with synchronized view and labeling.
For VIDEO projects: Videos are grouped by datasets (each dataset = one group).

Parameters:

project_id : int¶: Project ID to set multiview settings.

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

# For images project - will enable grouping by tags
api.project.set_multiview_settings(image_project_id)

# For videos project - will enable grouping by datasets
api.project.set_multiview_settings(video_project_id)

set_overlay_settings(project_id)[source]¶

Sets the project labeling interface to overlay mode.

In overlay mode, images that share the same parent (linked via parent_id) are displayed as layered overlays on top of the parent image in the labeling UI.

Note

This method only changes the project’s labeling interface setting. To upload images as overlays of a parent image, use upload_overlay_images().

Parameters:

project_id : int¶: Project ID to apply overlay settings to.

Returns:

None

Return type:

None

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

api.project.set_overlay_settings(project_id=123)

set_read_only(id, enable=True)[source]¶

Set or unset read-only status for the project.

Parameters:

id : int¶: Project ID
enable : bool¶: If True, sets the project to read-only. If False, unsets the read-only status.

Returns:

None

Return type:

None

set_validation_schema(id, schema)[source]¶

Sets validation schema of the Project by ID. NOTE: This method will overwrite existing validation schema. To extend existing schema, use get_validation_schema first to get current schema, then update it and use this method to set new schema.

Parameters:

id : int¶: Project ID in Supervisely.
schema : dict¶: Validation schema to set.

Returns:

ProjectInfo object in json format.

Return type:

Usage Example:

import os
from dotenv import load_dotenv

import supervisely as sly

# Load secrets and create API object from .env file (recommended)
# Learn more here: https://developer.supervisely.com/getting-started/basics-of-authentication
if sly.is_development():
    load_dotenv(os.path.expanduser("~/supervisely.env"))

api = sly.Api.from_env()

project_id = 123456
schema = {'key': 'Description of the field'}
api.project.set_validation_schema(project_id, schema)

update(id, name=None, description=None)¶

Update an entity with the specified ID.

Parameters:

id : int¶: ID of the entity to update.
name : str, optional¶: New name of the entity.
description : str, optional¶: New description of the entity.

Returns:

Entity with updated information.

Return type:

update_custom_data(id, data, silent=False)[source]¶

Updates custom data of the Project by ID.

IMPORTANT: This method replaces the current custom data with the provided one. If you want to extend the custom data or update specific key-value pairs, use :func:get_custom_data first to retrieve the existing data, then modify it accordingly before calling this method.

Parameters:

id : int¶: Project ID in Supervisely.
data : dict¶: Custom data
silent : bool¶: Determines whether the updatedAt timestamp should be updated or not. If False, updatedAt will be updated.

Returns:

ProjectInfo object in json format.

Return type: