GuidesApi¶

class GuidesApi[source]¶

Bases: supervisely.api.module_api.ModuleApiBase

API for working with Guides. GuidesApi object is immutable.

Parameters

api : Api: API connection to the server.

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

api = sly.Api.from_env()

# Get list of guides in team
guides = api.guides.get_list(team_id=123)

Methods

`convert_info_to_json`	_convert_info_to_json
`get_info_by_id`	Get Guide information by ID.
`get_list`	Get list of Guides in the given Team.
`get_list_all_pages`	Get list of all or limited quantity entities from the Supervisely server.
`get_list_all_pages_generator`	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
`get_list_idx_page_async`	Get the list of items for a given page number.
`get_list_page_generator_async`	Yields list of images in dataset asynchronously page by page.
`info_sequence`	NamedTuple GuideInfo information about Guide.
`info_tuple_name`	NamedTuple name - GuideInfo.

Attributes

`MAX_WAIT_ATTEMPTS`	Maximum number of attempts that will be made to wait for a certain condition to be met.
`WAIT_ATTEMPT_TIMEOUT_SEC`	Number of seconds for intervals between attempts.

InfoType¶: alias of supervisely.api.module_api.GuideInfo

classmethod convert_info_to_json(info)¶

_convert_info_to_json

Return type: Dict

get_info_by_id(id)[source]¶

Get Guide information by ID.

Parameters

id : int: Guide ID in Supervisely.

Returns

Information about Guide.

Return type

GuideInfo

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

api = sly.Api.from_env()

guide_id = 1
guide_info = api.guides.get_info_by_id(guide_id)
print(guide_info)
# Output: GuideInfo(
#     id=1,
#     name='How to label objects',
#     description='Comprehensive guide on object labeling',
#     file_path='/path/to/guide.pdf',
#     created_at='2023-01-01T00:00:00.000Z',
#     updated_at='2025-11-17T18:21:10.217Z',
#     created_by_id=1,
#     team_id=1,
#     video_id=None,
#     disabled_by=None,
#     disabled_at=None
# )

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

Get list of Guides in the given Team.

Parameters

team_id : int: Team ID in Supervisely.
filters : List[Dict[str, str]], optional: List of parameters to filter Guides.

Returns

List of information about Guides.

Return type

List[GuideInfo]

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

api = sly.Api.from_env()

team_id = 123
guides = api.guides.get_list(team_id)
print(guides)
# Output: [
#     GuideInfo(
#         id=1,
#         name='How to label objects',
#         description='Comprehensive guide on object labeling',
#         file_path='/path/to/guide.pdf',
#         created_at='2023-01-01T00:00:00.000Z',
#         updated_at='2025-11-17T18:21:10.217Z',
#         created_by_id=1,
#         team_id=1,
#         video_id=None,
#         disabled_by=None,
#         disabled_at=None
#     )
# ]

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

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 : asyncio.Semaphore, optional: Semaphore for limiting the number of simultaneous requests.
kwargs: Additional arguments.

Returns

List of images in dataset.

Return type

AsyncGenerator[List[ImageInfo]]

Usage example

import supervisely as sly
import asyncio

os.environ['SERVER_ADDRESS'] = 'https://app.supervisely.com'
os.environ['API_TOKEN'] = 'Your Supervisely API Token'
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))

static info_sequence()[source]¶

NamedTuple GuideInfo information about Guide.

Example

GuideInfo(
    id=1,
    name='How to label objects',
    description='Comprehensive guide on object labeling',
    file_path='/path/to/guide.pdf',
    created_at='2023-01-01T00:00:00.000Z',
    updated_at='2025-11-17T18:21:10.217Z',
    created_by_id=1,
    team_id=1,
    video_id=None,
    disabled_by=None,
    disabled_at=None
)

static info_tuple_name()[source]¶: NamedTuple name - GuideInfo.