Supervisely
API integration

create_a_supervisely_agents_net_set_status

Update the network status of a Supervisely agent by recording its last-seen timestamp. Returns an opaque success object. Required: token, lastSeenAt.

supervisely_agents_exists

Check whether a Supervisely agent exists by its token. Returns: agent, 5XX. Required: token.

supervisely_agents_available

List available Supervisely agents for a team, optionally filtered by capability type, GPU requirements, and environment variables. Returns: id, name, token, userId, createdAt, updatedAt, capabilities. Required: teamId.

list_all_supervisely_agents

List all Supervisely agents in a team with sorting and filtering options. Returns: id, name, token, userId, createdAt, updatedAt, capabilities. Required: teamId.

supervisely_agents_upgrade

Queue an upgrade task for a Supervisely agent by token. The agent recreates its container on the latest released version and disconnects briefly. Returns a success response. Required: token.

get_single_supervisely_agent_by_id

Get information about a specific Supervisely agent by id. Returns the full agent object including id, name, token, userId, teamId, createdAt, updatedAt, capabilities, version, dockerImage, and host. Required: id.

create_a_supervisely_agent

Create a new Supervisely agent in a team. Returns: id, name, token, agent. Required: teamId, type.

supervisely_agents_bulk_update

Update a Supervisely agent's name, capabilities, and options by id. Returns the updated agent object including id, name, token, userId, teamId, capabilities, version, and host. Required: id.

list_all_supervisely_agents_storage_downloads

Download a file from a Supervisely agent by agent ID and file path. Returns the downloaded file data as a JSON object whose fields are not further documented by the upstream API. Required: id, path.

list_all_supervisely_agents_options_infos

Get Supervisely agent options by agent token. Returns the agentOptions object (including runtime, dockerImage, pullPolicy, agentStorage, offlineMode, deleteTaskDirOnFinish, deleteTaskDirOnFailure) and agentCACert. Required: token.

list_all_supervisely_agents_storage_lists

List files stored on a Supervisely agent by agent ID and file path. Returns an array of agent file entries. Required: id, path.

create_a_supervisely_annotation_objects_tags_add

Add a tag to a Supervisely annotation object. Returns a success object whose exact fields are not documented by the upstream API. Example body: {"tagId": 1, "objectId": 24, "value": "invalid"}. Required: tagId, objectId.

create_a_supervisely_annotation_objects_tags_bulk_add_tag

Bulk-add a single tag to multiple annotation objects in Supervisely. Returns: id, 5XX. Required: tagId, ids.

create_a_supervisely_annotation_objects_tags_bulk_add

Bulk add tags to annotation objects in Supervisely. Returns: an array of created tag assignments, each containing its id. Required: tags.

create_a_supervisely_annotation_objects_bulk_add

Create new empty Annotation Objects in bulk within an existing Supervisely Dataset. Returns an array of objects each containing the id of a created Annotation Object. Required: datasetId, annotationObjects.

create_a_supervisely_annotation_objects_tags_bulk_finish

Bulk finish annotation object tags in Supervisely by setting an end frame for each tag. Returns a generic success response object. Required: tags.

list_all_supervisely_annotation_objects

List annotation objects in a Supervisely dataset with optional filtering, sorting, and archived controls. Returns: id, description, meta, createdAt, updatedAt, 5XX. Filter supports up to 10 conditions. Required: datasetId.

supervisely_annotation_objects_merge

Merge multiple Supervisely annotation objects into a single destination object, creating the destination automatically if not specified. Returns: id, description, meta, createdAt, updatedAt, 5XX. Required: srcIds.

supervisely_annotation_objects_split

Split a figure from a Supervisely annotation object into a separate destination object, creating the destination automatically if not specified. Returns: id, description, meta, createdAt, updatedAt, 5XX. Required: srcId, figureId.

supervisely_annotation_objects_swap

Swap figures between two Supervisely annotation objects. Returns: id, description, meta, createdAt, updatedAt, 5XX. Exactly 2 figure IDs required. Required: figureIds.

get_single_supervisely_annotation_object_by_id

Get annotation object info by ID in Supervisely. Returns: id, description, datasetId, groupId, classId, meta, createdAt, imageId, updatedAt, createdBy, disabledAt, disabledBy. Required: id.

supervisely_annotation_objects_bulk_update

Update an annotation object's class or description in Supervisely. Returns: id, description, datasetId, groupId, classId, meta, createdAt, imageId, updatedAt, createdBy, disabledAt, disabledBy. Required: id.

list_all_supervisely_annotation_objects_tag_values

List annotation objects tag values in Supervisely filtered by tag ID. Returns: values, 5XX. Required: tagId.

supervisely_annotation_objects_bulk_removes_bulk_delete

Soft-delete Supervisely annotation objects by IDs. Data is retained for 7 days before permanent removal. Returns a generic success response object with no documented fields.

annotation_objects_figures_remove_from_frame_ranges_bulk_delete

Remove figures from annotation objects in Supervisely within a specified frame range. Returns an opaque success response object. Required: objectIds, startFrame, endFrame.

create_a_supervisely_annotation_objects_tags_remove

Remove an annotation object tag in Supervisely by its tag id. Returns an opaque success object with no documented response fields. Required: id.

supervisely_annotation_objects_bulk_restores_bulk_update

Restore archived Supervisely Annotation Objects by their IDs, optionally restoring associated figures and tags. Returns an opaque success object with no documented response fields. Required: annotationObjectIds.

create_a_supervisely_annotation_objects_tags_restore

Restore a disabled tag on an annotation object in Supervisely. Returns a success response object on completion. Required: id.

create_a_supervisely_annotation_objects_tags_bulk_unfinish

Bulk unfinish annotation object tags in Supervisely by supplying a list of tag IDs, optionally indicating whether each tag's frame range was reversed during the original finish operation. Returns a success response object. Required: tags.

create_a_supervisely_annotation_objects_tags_update_value

Update an annotation object tag value in Supervisely. Returns a generic success object. Set nonFinalValue to true to assign a default value based on tag settings (value must be null in that case). Required: id.

supervisely_annotation_objects_tags_updates_bulk_update

Update the frame range of an Annotation Object Tag in Supervisely. Returns: id, 5XX. The frameRange must be an array of exactly two non-negative integers representing the start and end frame. Required: id, frameRange.

create_a_supervisely_annotations_bulk_copy

Copy annotations from one dataset to another in Supervisely. Returns a success response object. Source and destination image IDs must each be within a single dataset and contain unique values. Required: srcImageIds, destImageIds.

create_a_supervisely_annotations_bulk_add

Create annotations for images in a Supervisely dataset in bulk. Each entry pairs an imageId with a Supervisely-format annotation object containing labeled objects, tags, and image dimensions. Returns a success response object. Supports up to 1000 annotations per request. Required: datasetId, annotations.

list_all_supervisely_annotations

List image annotations for a dataset in Supervisely. Returns per image: imageId, imageName, createdAt, updatedAt, and the annotation object with size, tags, and labeled objects. Supports sorting by imageId, name, description, labelsCount, createdAt, or updatedAt and filtering by imageId, description, name, or labelsCount. Required: datasetId.

get_single_supervisely_annotation_by_id

Get a single image annotation in Supervisely by image ID. Returns: imageId, imageName, createdAt, updatedAt, annotation. Required: imageId.

list_all_supervisely_annotations_bulk_infos

Get bulk annotation information for images in Supervisely by image IDs. Returns: imageId, imageName, createdAt, updatedAt, annotation. Maximum 100 image IDs per request. Required: imageIds.

create_a_supervisely_annotations_bulk_render

Render annotations of images in Supervisely by submitting up to 100 image entries with optional rendering options such as color, class filtering, and border thickness. Returns an opaque success response with no documented fields. Required: images.

list_all_supervisely_apps

List apps in Supervisely with filtering, sorting, and session-scoping options. Returns: id, name, repo, config, size, status, startedAt, finishedAt, meta, attempt, archived, createdBy, teamId, isShared, isPrivate, user, agentId. Supports filtering by id, name, and moduleId with a max of 10 filter conditions, and sorting by id, name, createdAt, or updatedAt.

supervisely_apps_restore

Restore a previously archived Supervisely app by id. Returns an empty 204 response on success. Required: id.

get_single_supervisely_app_by_id

Get information about a specific Supervisely app by ID. Returns: id, repo, config. Required: id.

create_a_supervisely_app

Add an app from the Supervisely Ecosystem to a specified team. Returns: id, repo, config, name. Required: teamId, moduleId.

supervisely_apps_bulk_delete

Archive a Supervisely app by ID. Returns an empty 204 response on success. Required: id.

create_a_supervisely_apps_link_github

Link a public GitHub repository as an app into a Supervisely team. The upstream API returns a generic success object with no documented fields. Required: teamId, repo.

list_all_supervisely_apps_tasks_lists

List app tasks in Supervisely filtered by app and team. Returns task entities with id, type, status, startedAt, finishedAt, meta (app info, progress, advanced settings), attempt, archived, createdBy, teamId, user, and agentId. Required: appId, teamId.

create_a_supervisely_apps_sessions_update

Update a Supervisely app session by setting a new session name. Returns a generic success object confirming the update. Required: id.

create_a_supervisely_apps_services_add

Create an App Service in Supervisely. Returns: id, name, 5XX. Service names must be unique within a team (a 400 NONUNIQUE error is returned otherwise). Required: teamId, name.

list_all_supervisely_apps_services_lists

List App Services in Supervisely with optional filtering by id or name, sorting, and session tag matching. Returns each service with id, name, description, size, agentId, isShared, priority, createdAt, and updatedAt. Supports up to 10 filter conditions.

create_a_supervisely_apps_services_remove

Remove an App Service in Supervisely by its numeric ID. Returns a success response object. Required: id.

create_a_supervisely_apps_services_update

Update a Supervisely App Service by id. Returns the updated service object including id, name, description, agentId, isShared, config, priority, createdAt, and updatedAt. Required: id.

create_a_supervisely_advanced_object_classes_add

Create a new Object Class in an existing Supervisely project. Returns: id, name, 5XX. The color must be a hex color string (e.g. #B6FF00), hotkey is a single character, and shape must be one of the supported annotation geometry types. Required: name, color, shape, projectId.

list_all_supervisely_advanced_object_classes_infos

Get a Supervisely object class by its ID. Returns: id, teamId, workspaceId, projectId, name, description, shape, color, createdAt, updatedAt, 5XX. Required: id.

list_all_supervisely_advanced_object_classes_lists

List object classes for a Supervisely project. Returns each class with id, name, description, shape, color, createdAt, and updatedAt. Supports filtering by id, name, description, and shape (max 10 conditions) and sorting by id, name, description, shape, createdAt, or updatedAt. Required: projectId.

supervisely_advanced_object_classes_edit_infos_bulk_update

Update a Supervisely object class by editing fields such as name, shape, color, and hotkey. Returns: id, name, description, shape, color, hotkey, settings, 5XX. Required: id.

list_all_supervisely_data_commander_tasks_lists

List Data Commander tasks in Supervisely filtered by module ID. Returns task entities with id, type, status, startedAt, finishedAt, and meta (including step, config, output, and preset). Required: moduleId.

supervisely_datasets_favorite_changes_bulk_update

Toggle a Supervisely dataset's favorite status — add it to favorites or remove it from favorites. Returns a success response object. Required: id, isFavorite.

list_all_supervisely_datasets

List Supervisely datasets within a project. Returns per dataset: id, name, description, size, imagesCount, status, createdAt, updatedAt, customData. Supports sorting, filtering, and recursive listing. Required: projectId.

supervisely_datasets_move

Move a Supervisely dataset from one parent to another. Returns a success confirmation. Omit destId to move the dataset to the project root. Required: srcId.

get_single_supervisely_dataset_by_id

Get information about a specific Supervisely dataset by id. Returns: id, teamId, workspaceId, projectId, name, description, size, imagesCount, status, createdAt, updatedAt, customData. Required: id.

create_a_supervisely_dataset

Create a new empty dataset in an existing Supervisely project. Returns: id, name. Required: projectId, name.

supervisely_datasets_bulk_update

Update a Supervisely dataset's editable fields such as name, description, and custom data. Returns: id, teamId, workspaceId, projectId, name, description, size, imagesCount, status, createdAt, updatedAt, customData. Required: id.

supervisely_datasets_bulk_delete

Soft-delete a Supervisely dataset by id. Data is retained for 7 days before permanent removal. Returns an empty 204 response on success. Required: id.

list_all_supervisely_datasets_list_stats

List Supervisely dataset statistics for a project, optionally filtered by dataset id, archived status, or recursive traversal. Returns each dataset's id, name, description, size, imagesCount, status, createdAt, and updatedAt. Required: projectId.

supervisely_datasets_remove_permanentlies_bulk_delete

Permanently delete one or more Supervisely datasets by ID. Returns an opaque success object. Unlike the soft-delete endpoint, removal is immediate and irreversible. Required: datasets.

supervisely_ecosystems_add

Add a module to the Supervisely ecosystem from a Git repository. Returns a generic success object. Required: repo, token, provider.

supervisely_ecosystems_changelog

Get the Supervisely ecosystem apps changelog file. Returns a generic success object.

supervisely_ecosystems_counters

Get module counters for a Supervisely ecosystem module. Returns a generic success object. Required: repo, counter.

list_all_supervisely_ecosystems

List Supervisely ecosystem apps with optional filtering by category, context, search, and integration surface. Returns each item with: id, slug, name, type, config, createdAt, updatedAt, isPrivate, disabled, provider, repo, isShared.

supervisely_ecosystems_refresh

Refresh Supervisely ecosystem modules by their IDs. Returns a success response object. Required: teamId, workspaceId.

supervisely_ecosystems_release

Create or update a Supervisely ecosystem app by uploading a release archive with config and metadata. Returns a success response object.

supervisely_ecosystems_remove

Remove a Supervisely ecosystem item by ID, optionally permanently. Returns a success response object. Required: id.

get_single_supervisely_ecosystem_by_id

Get Supervisely ecosystem app info by ID, slug, or app key. Returns the full app object including id, slug, name, type, config, readme, createdAt, updatedAt, meta, repo, and visibility flags.

create_a_supervisely_ecosystem_models_add

Add an ecosystem model in Supervisely. Returns: id, 5XX. The model name must be unique; a duplicate name results in a 400 error. Required: name, framework, task, modality.

create_a_supervisely_ecosystem_change_owner

Change the owner of an Ecosystem app in Supervisely by providing the ecosystem item id and the new owner's login or email. Returns a success response object. Required: id.

list_all_supervisely_ecosystem_check_for_updates

List Supervisely ecosystem apps that have been updated since a given timestamp. Returns a list of app name strings identifying the updated apps.

list_all_supervisely_ecosystem_client_side_files

Get a Client Side App file from Supervisely by module ID and file path. Returns the requested App file content as an opaque JSON object whose structure depends on the file requested. Required: moduleId, filePath.

list_all_supervisely_ecosystem_last_updates

Get the last updates for Supervisely Ecosystem apps. Returns a JSON object with ecosystem update information; the upstream API does not enumerate specific response fields.

list_all_supervisely_ecosystem_file_downloads

Download an Ecosystem App file from Supervisely by specifying the module and optional file filters. Returns an opaque JSON object containing the requested file content; the upstream schema does not enumerate specific response fields. Required: moduleId.

list_all_supervisely_ecosystem_models_lists

List ecosystem models in Supervisely with optional filtering by name, framework, architecture, task, and module slugs, plus sorting. Returns each model with id, name, framework, architecture, task, pretrained, modality, numClasses, size, paramsM, GFLOPs, serveModuleId, trainModuleId, serveModuleSlug, trainModuleSlug, tags, runtimes, files, speedTests, evaluation, createdAt, and updatedAt.

list_all_supervisely_ecosystem_models_fields

Get available ecosystem model fields in Supervisely, optionally filtered by framework, architecture, task, and local model inclusion. Returns the ecosystem model fields object.

list_all_supervisely_ecosystem_models_frameworks

List model frameworks available in Supervisely's ecosystem, with optional filtering by framework, architecture, task, serve module slug, or train module slug. Returns framework records including framework, architecture, task, serveModuleSlug, and trainModuleSlug. Supports up to 10 filter conditions and sorting by any field in ascending or descending order.

supervisely_ecosystem_version_removes_bulk_delete

Remove a Supervisely Ecosystem app branch (specific version) by specifying the ecosystem item id and version string. Returns an opaque success response with no documented fields. Required: id, version.

create_a_supervisely_ecosystem_seed_default

Seed default modules in Supervisely teams. Returns a success response object. No request body parameters are required.

supervisely_ecosystem_item_updates_bulk_update

Update an ecosystem item in Supervisely by module ID, optionally setting its token and shared status. Returns a generic JSON object confirming the update result. Required: moduleId.

create_a_supervisely_ecosystem_models_update

Update an Ecosystem Model in Supervisely by specifying the model id and any fields to modify such as name, framework, architecture, task, tags, or evaluation metrics. Returns the updated model object including id, name, framework, architecture, and task. Required: id.

create_a_supervisely_embeddings_calculate_project_embedding

Calculate project embeddings in Supervisely by providing a project ID. Returns a success response object whose fields are not documented in the upstream API. Required: projectId.

supervisely_embeddings_healthcheck

Check the health of the Supervisely Embeddings Generator service. Returns: success.

create_a_supervisely_embeddings_send_ai_search

Send an AI search request in Supervisely to find images by prompt text, by reference image IDs, or via the diverse sampling method. Returns an opaque JSON object with search results whose fields are not enumerated by the upstream schema. Required: projectId.

create_a_supervisely_entities_bulk_add

Add existing entities to a Supervisely dataset in bulk using an id-based contract. Returns an array of created entity objects, each with id and name. Required: datasetId, entities.

create_a_supervisely_entities_tags_bulk_add

Bulk add tags to entities (Images, Videos, etc.) in Supervisely. Returns an array of created entity tag objects including id, entityId, tagId, value, startFrame, and endFrame. Required: projectId, tags.

supervisely_entities_download

Download a Supervisely entity file by ID. Returns the entity file as binary data (application/octet-stream). Required: id.

list_all_supervisely_entities

List entities in a Supervisely dataset or project using a generic ID-based contract. Returns each entity with id, name, title, description, parentId, projectId, datasetId, createdAt, updatedAt. Supports sorting, field-level and advanced filtering, and custom field selection.

get_single_supervisely_entity_by_id

Get a single Supervisely entity by ID. Returns: id, title, description, parentId, projectId, datasetId, createdAt, updatedAt, createdBy, meta, fileMeta, frame, hash, pathOriginal, link, fullStorageUrl, name, customData, objectsCount, workspaceId, size, customSort, collectionItemIndex, tags. Required: id.

create_a_supervisely_entities_collections_items_bulk_add

Add items in bulk to an entities collection in Supervisely by specifying entity IDs or entity items with optional metadata. Returns: items, missing, 5XX. Required: collectionId.

list_all_supervisely_entities_collections

List Entities Collections in a Supervisely project. Returns each collection with id, teamId, projectId, name, description, createdAt, updatedAt. Required: projectId.

get_single_supervisely_entities_collection_by_id

Get information about a specific Entities Collection in Supervisely by id. Returns: id, teamId, projectId, name, description, createdAt, updatedAt. Required: id.

create_a_supervisely_entities_collection

Create a new empty Entities Collection in an existing Supervisely project. Returns: id, name. Required: projectId, name.

supervisely_entities_collections_bulk_delete

Delete an Entities Collection in Supervisely by id. By default performs a soft-delete; set hardDelete to true to permanently delete instead. Returns a success response with no documented body fields. Required: id.

supervisely_entities_collections_bulk_update

Update fields of an Entities Collection in Supervisely, such as name and description. Returns the updated collection object including id, teamId, projectId, name, description, createdAt, and updatedAt. Required: id.

supervisely_entities_collections_items_bulk_removes_bulk_delete

Remove multiple items from a Supervisely Entities Collection. Returns: items, missing, 5XX. Required: collectionId, entityIds.

supervisely_figures_add_annotation_durations_bulk_update

Add annotation duration for a figure in Supervisely. Returns a generic success object with no documented fields. Required: figureId, duration.

create_a_supervisely_figures_tags_bulk_add

Bulk-add tags to figures in Supervisely. Returns an array of created figure tag objects, each containing its id. Required: tags.

supervisely_figures_bind

Bind multiple Supervisely figures together by their IDs. Returns: id, 5XX. Required: ids.

supervisely_figures_clone

Clone existing Supervisely figures to a destination image. Returns the cloned figure objects including id, imageId, geometry, geometryType, tool, and area. Required: entityId, ids.

list_all_supervisely_figures

List Supervisely figures with filtering, sorting, and optional field selection. Returns an array of figure objects each including id, entityId, imageId, geometry, geometryType, tool, and area.

supervisely_figures_unbind

Unbind a set of Supervisely figures from their annotation objects by figure IDs. Returns an opaque success response with no documented fields. Required: ids.

supervisely_figures_volumetric_interpolation

Trigger volumetric interpolation for figures on a volume in Supervisely. Returns an opaque success response with no documented fields. Required: volumeId, objectId, taskId.

get_single_supervisely_figure_by_id

Get information about a specific Supervisely figure by ID. Returns: id, createdAt, updatedAt, imageId, priority, objectId, classId, projectId, datasetId, geometry, meta, area, realArea, tool, instanceId, geometryType, description, createdBy, nnCreated, nnUpdated. Required: id.

supervisely_figures_bulk_delete

Soft-delete a Supervisely figure by ID. Data is retained for 7 days before permanent removal. Returns an opaque success response with no documented fields. Required: id.

supervisely_figures_bulk_update

Update a Supervisely figure's editable properties including geometry, tool, priority, description, objectId, classId, and geometryType by id. Returns: id, createdAt, updatedAt, imageId, priority, objectId, projectId, datasetId, meta, area, realArea, tool, geometryType, geometry. Required: id.

supervisely_figures_convert_bitmap_to_polygons_bulk_update

Convert bitmap figures to polygon figures in Supervisely by supplying a list of figure IDs. Returns a success object on completion. Required: ids.

create_a_supervisely_figures_bulk_add

Create annotation figures in bulk on a Supervisely entity. Returns an array of created figure objects, each containing its id. The figures array requires at least 1 item.

create_a_supervisely_figures_download_geometry

Download a single figure's geometry from Supervisely storage. Returns the geometry as a binary octet-stream blob. Set allowArchived to true to download geometry from archived figures. Required: id.

create_a_supervisely_figures_bulk_download_geometry

Download figure geometries from Supervisely storage by submitting a list of figure IDs. Returns a binary geometry file (octet-stream). Required: ids.

list_all_supervisely_figures_tags_lists

Get figure tags for a specific figure in Supervisely. Returns: id, tagId, value, createdAt, updatedAt, labelerLogin, name, 5XX. Required: id.

list_all_supervisely_figures_tag_values

Get figures tag values in Supervisely, optionally filtered by a search prefix. Returns: values, 5XX. Required: tagId.

supervisely_figures_bulk_removes_bulk_delete

Soft-delete multiple Supervisely figures by their IDs. Deleted data is retained for 7 days before permanent removal. Returns an opaque success response object with no documented fields. Required: figureIds.

create_a_supervisely_figures_remove_figures_after_figure

Remove annotation figure objects that appear after a specified figure in Supervisely. Returns an empty object on success. Required: figureId, mode.

create_a_supervisely_figures_bulk_restore

Restore archived Figures in Supervisely by their IDs. Accepts an array of unique Figure IDs (minimum 1) and returns an opaque success response with no documented fields.

list_all_supervisely_figures_custom_data_updates

Update a Supervisely figure's custom data by figure ID using a merge or replace strategy. Returns the updated customData object. Required: id, customData.

supervisely_figures_priority_updates_bulk_update

Update the priority of a Figure in Supervisely. Returns a success response object whose fields are not documented by the upstream API. Both values must be integers greater than or equal to 1. Required: id, priority.

create_a_supervisely_figures_bulk_upload_geometry

Upload figure geometry data to Supervisely storage in bulk. Returns a generic success response object whose specific fields are not enumerated by the Supervisely API documentation.

create_a_supervisely_file_storage_bulk_add_from_entity

Bulk add files from dataset entities (images, videos, point clouds, volumes) to Supervisely team file storage. Files are referenced, not copied, and supports both local and remote files. Returns an array of added file objects with id, path, name, size, teamId, and entityId. Required: teamId, files.

create_a_supervisely_file_storage_bulk_add_from_link

Bulk add files from HTTP/HTTPS URLs to Supervisely team file storage; files are referenced as links rather than downloaded. Returns an array of added file objects with id, path, name, size, teamId, and url. Required: teamId, files.

create_a_supervisely_file_storage_bulk_upload

Bulk upload files to Supervisely team storage. Returns an array of objects, each containing a hash representing an uploaded file. Required: team_id.

supervisely_file_storages_copy

Copy or move files and folders in Supervisely team file storage to a destination directory. Returns: 5XX. Set move to true to move instead of copy, and targetTeamId to copy or move across teams. Required: srcPaths, destDir, teamId.

supervisely_file_storages_download

Download a file or folder from Supervisely team file storage by path. Returns the raw binary file content as an octet-stream; folders are downloaded as a tar or zip archive. Required: path, teamId.

list_all_supervisely_file_storages

List files and folders at a given path in Supervisely team file storage. Returns a list of file and folder entries as a JSON object. Required: path, teamId.

supervisely_file_storages_remove

Remove a file or folder from Supervisely team file storage by path. Returns: 5XX. Required: path, teamId.

supervisely_file_storages_rename

Rename a file or directory in Supervisely team file storage. To rename a directory, the path must end with '/'. Returns the file information including id, name, path, hash, and teamId. Required: path, teamId.

supervisely_file_storages_upload

Upload a file to Supervisely team file storage at the specified path. Returns: hash, 5XX. Required: team_id, path.

get_single_supervisely_file_storage_by_id

Get information about a specific file in Supervisely team file storage by its id. Returns the file metadata including id, name, path, hash, teamId, and meta. Required: id.

list_all_supervisely_file_storage_bulk_downloads

Download multiple files from Supervisely storage by their paths, supporting both regular files and linked files (external URLs). Returns a binary file download (application/octet-stream). Required: paths, teamId.

list_all_supervisely_file_storage_v_2_lists

List files and folders in Supervisely team file storage at a given path. Returns a file and folder listing object; the upstream API does not enumerate specific response fields. Supports recursive listing, metadata inclusion, and file/folder filtering. Required: path, teamId.

supervisely_file_storage_bulk_removes_bulk_delete

Bulk remove files or folders in Supervisely by providing a list of paths and a team ID. Returns an empty success response on success. Maximum 20,000 paths per request. Required: paths, teamId.

create_a_supervisely_file_storage_resumable_upload_abort

Abort an in-progress resumable file upload in Supervisely by providing the upload session id. Returns a success response indicating the upload session was terminated. Required: sessionId.

create_a_supervisely_file_storage_resumable_upload_chunk

Upload a file chunk to a resumable file upload session in Supervisely. Returns: sha256, 5XX. Required: session_id, part_id.

create_a_supervisely_file_storage_resumable_upload_complete

Complete a resumable file upload in Supervisely by finalizing the upload session. Returns the uploaded file's metadata including id, name, path, storagePath, fullStorageUrl, fileTypeLabel, userId, teamId, and meta (size, mime, ext). Required: sessionId.

create_a_supervisely_file_storage_resumable_upload_request

Request a resumable file upload to Supervisely storage. Returns a sessionId and upload limits including isParallelUploadSupported, maxChunkSize, and maxChunks. Not all storage providers support this feature. Required: teamId, path.

create_a_supervisely_file_storage_resumable_upload_status

Get information about the parts of a resumable file upload in Supervisely by providing the upload session id. Returns: sessionId, 5XX. Required: sessionId.

create_a_supervisely_file_storage_update_content

Update the content of an existing file in Supervisely team file storage by replacing its text content. Returns a JSON object on success; the upstream API does not document the response shape. Required: path, teamId.

create_a_supervisely_github_repository_set_key

Add an SSH key to a GitHub repository in Supervisely. The response returns a success object with no additional documented fields. Required: repository.

create_a_supervisely_github_repository_create

Create a GitHub repository in Supervisely. Returns an empty object on success. Required: repository.

create_a_supervisely_github_user_info

Retrieve GitHub user info from Supervisely. Returns: id, attributes.

list_all_supervisely_guides

List labeling guides in Supervisely for a given team. Returns: id, name, description, filePath, videoId, createdAt, updatedAt, createdBy, disabledBy, disabledAt, teamId. Required: teamId.

get_single_supervisely_guide_by_id

Get a single labeling guide in Supervisely by id. Returns: id, name, description, filePath, videoId, createdAt, updatedAt, createdBy, disabledBy, disabledAt, teamId. Required: id.

supervisely_entity_add_annotation_durations_bulk_update

Add annotation duration to an Entity (image, video, or point cloud) in Supervisely. Returns an opaque success response object. Required: entityId, duration.

create_a_supervisely_images_bulk_add

Add already uploaded images to a Supervisely dataset by referencing their hash, remote link, or existing image/file IDs without re-uploading data. Returns: an array of added images, each with id and name. Required: datasetId, images.

supervisely_images_download

Download a Supervisely image file by its ID. Returns the image as a binary stream. Required: id.

supervisely_images_previews

Get preview thumbnails for multiple Supervisely images by their IDs. Returns an array of objects, each with id, link, and preview. Supports up to 1000 unique image IDs. Required: ids.

list_all_supervisely_images

List images in Supervisely with optional filtering, sorting, and dataset/project scoping. Returns: id, name, description, datasetId, link, hash, mime, size, width, height, labelsCount, createdAt, updatedAt.

supervisely_images_upload

Upload a raw image to Supervisely as binary data (application/octet-stream). Returns: hash.

get_single_supervisely_image_by_id

Get information about a specific image in Supervisely by its ID. Returns: id, datasetId, link, description, createdAt, updatedAt, hash, mime, size, width, height, name, labelsCount. Required: id.

supervisely_images_bulk_update

Update image fields such as name and description in Supervisely. Returns: id, datasetId, link, description, createdAt, updatedAt, hash, mime, size, width, height, name, labelsCount, success. Required: id.

list_all_supervisely_images_bulk_downloads

Download images in Supervisely by their IDs. Returns a binary file download containing the requested images as multipart/form-data or a tar archive. Supports up to 1000 unique image IDs per request. Required: datasetId, imageIds.

list_all_supervisely_images_data_downloads

Download images from Supervisely by project and download IDs. Returns binary image data as a multipart/form-data response. Required: projectId, downloadId.

list_all_supervisely_images_bulk_download_by_hashes

Download images in Supervisely by their hashes. Returns a binary file download (multipart/form-data) containing the requested images. Required: hashes.

list_all_supervisely_images_tag_values

List Supervisely image tag values for a given tag, optionally filtered by a search prefix. Returns: values, 5XX. Required: tagId.

create_a_supervisely_images_internal_hashes_list

Get internal Supervisely image hashes by submitting a list of image hash strings. Returns an array of hash strings corresponding to images that are internal to Supervisely.

list_all_supervisely_images_get_pages

Get the page number on which a specific image (by entityId) is located within a Supervisely dataset listing. Returns: page, 5XX. Required: entityId.

list_all_supervisely_images_groups_lists

List images groups in Supervisely grouped by a specified tag. Returns: total, perPage, pagesCount, entities, 5XX. Required: tagId.

list_all_supervisely_images_list_stats

List image statistics for images in a Supervisely dataset. Returns: total, perPage, pagesCount, entities, 5XX. Required: datasetId.

supervisely_images_bulk_removes_bulk_delete

Soft-delete Images by IDs from a specified dataset in Supervisely. A deprecated imagesIds alias is also accepted but should not be used. Returns a generic success response with no documented fields.

list_all_supervisely_images_bulk_set_custom_sorts

Set custom sort values for multiple Supervisely images in bulk. Returns: success, 5XX. Required: images.

supervisely_images_embeddings_updated_at_updates_bulk_update

Update the embeddingsUpdatedAt timestamp for one or more Supervisely images by ID. Returns: success, 5XX. The images array must contain at least one entry. Required: images.

supervisely_images_update_links_bulk_update

Update remote links for images in Supervisely — useful when moving files to another server, when a link expires, or when moving images from local storage to remote. Returns: 5XX. Required: images.

create_a_supervisely_images_upload_to_storage

Upload an image to Supervisely storage. Returns the storage path of the uploaded image. Returns: url.

create_a_supervisely_images_bulk_upload

Bulk upload images to Supervisely. Returns an array of objects, each containing a hash for an uploaded image. Accepted image formats: BMP, JPEG, PNG, WebP, TIFF, NRRD.

list_all_supervisely_import_storage_bulk_downloads

Download import files from Supervisely by their content hashes. Returns a multipart binary file download containing the requested files. Required: hashes.

create_a_supervisely_import_storage_internal_hashes_list

Check which file hashes already exist in Supervisely's import storage by submitting a list of hash strings. Returns: an array of matching file hash strings found in import storage. Accepts 1–1000 unique hashes, each exactly 44 characters.

create_a_supervisely_import_storage_internal_meta_list

Retrieve import file metadata in Supervisely by submitting file hashes. Returns an array of objects each containing hash and meta.

create_a_supervisely_import_storage_bulk_upload

Upload files to Import Storage in Supervisely. Returns: an array of objects, each containing a hash of the uploaded file in base64 encoding. Accepts an optional teamId query parameter.

supervisely_instances_version

Get the current version of the Supervisely instance. Returns: version. No required parameters.

list_all_supervisely_instance_get_render_previews_session_tokens

Get a Render Previews session token in Supervisely by providing the slug of an Ecosystem Item. Returns: 5XX. Optional: slug.

list_all_supervisely_instance_storage_stats

Get storage statistics for a Supervisely instance. Returns: tableSizes, imagesDataSizes, teamsFilesSizes.

supervisely_teams_meta_reserved_seats_updates_bulk_update

Update reserved seats for one or more Supervisely teams. Accepts an array of objects each specifying a team id and a reservedSeats count. Returns a generic success response object.

list_all_supervisely_instance_widgets_get_templates

Get a Supervisely widget template by its template id. Returns: data, state, template, 5XX. Required: id.

list_all_supervisely_instance_widgets_widget_charts

Handle Supervisely chart widget actions — initialize a chart or process a chart-click event. Returns a dynamically-structured chart widget response object whose shape depends on the widget configuration. Required: templateId, widgetId, action.

list_all_supervisely_instance_widgets_widget_galleries

Interact with a Supervisely gallery widget by performing an init or update-gallery action. Returns an opaque JSON object whose structure depends on the action and widget configuration. Required: templateId, widgetId, action.

list_all_supervisely_instance_widgets_widget_markdowns

Initialize a Supervisely markdown widget handler by template and widget ID. Returns a dynamic JSON object with widget handler response data. Required: templateId, widgetId, action.

list_all_supervisely_instance_widgets_widget_tables

Invoke the Supervisely table widget handler to initialize a table widget. Returns: data, 5XX. Required: templateId, widgetId, action.

list_all_supervisely_issues

List issues for a Supervisely team. Returns issue records with id, name, status, teamId, createdAt, and updatedAt. Required: teamId.

get_single_supervisely_issue_by_id

Get a Supervisely issue by ID. Returns: id, name, status, teamId, isLocal, isPinned, assignees, comment, createdAt, updatedAt. Required: id.

create_a_supervisely_issue

Create a new issue in Supervisely. Returns the created issue including id, name, status, teamId, isLocal, isPinned, assignees, comment, createdAt, and updatedAt. Required: name, isLocal, teamId.

supervisely_issues_bulk_delete

Delete a Supervisely issue by ID. Returns: id, name, status, teamId, isLocal, isPinned, assignees, comment, createdAt, updatedAt. Required: id.

supervisely_issues_bulk_update

Update a Supervisely issue's name, status, or pinned state. Returns the updated issue including id, name, status, teamId, isLocal, isPinned, assignees, comment, createdAt, and updatedAt. Required: id.

create_a_supervisely_issues_comments_add

Add a comment to a Supervisely issue. Returns: id, comment, issueId, 5XX. Required: issueId.

create_a_supervisely_issues_sub_issue_add

Add a sub-issue to an existing issue in Supervisely. Returns the created sub-issue object. The bindings array must contain exactly 1 item. Required: bindings, issueId.

list_all_supervisely_issues_dataset_issues_lists

List dataset issues in Supervisely, optionally filtered by dataset ID or project ID. Returns an issues object; the upstream API does not document specific response fields.

create_a_supervisely_issues_comments_edit_info

Update an issue comment's text in Supervisely. Returns: id, comment, 5XX. Required: id.

create_a_supervisely_issues_sub_issue_edit_info

Update a Supervisely sub-issue by id, optionally changing its status, parent issue, or metadata. Returns an opaque object confirming the update. Required: id.

supervisely_jobs_archive

Archive a labeling job in Supervisely by its numeric ID. Returns an empty 204 response on success. Required: id.

supervisely_jobs_stats

Get Supervisely job annotation statistics by ID. Returns: job, classes, 5XX. Required: id.

list_all_supervisely_jobs

List annotation jobs in a Supervisely team. Returns each job with id, name, projectId, datasetId, status, createdAt, imagesCount, and detailed meta including entity ranges and class assignments. Supports sorting, filtering by multiple fields, and field selection to limit returned attributes. Required: teamId.

supervisely_jobs_pause

Pause a Supervisely annotation job by id. Returns a success object confirming the job was paused. Required: id.

supervisely_jobs_reject

Reject all or unmarked annotations of a Supervisely job by id. Returns a success object confirming the rejection. The optional mode parameter controls whether all annotations or only unmarked ones are rejected; defaults to all. Required: id.

supervisely_jobs_restart

Restart a Supervisely annotation job, creating a new job with transferred entities. Returns an array of new job records each with id and name. Optional parameters control whether the existing job is marked complete, the transfer mode for entities, and the new job name. Required: id, userIds.

supervisely_jobs_resume

Resume a paused Supervisely annotation job by id. Returns a success object confirming the job was resumed. Required: id.

supervisely_jobs_stop

Stop a Supervisely job by its ID. Returns a generic success response. Required: id.

get_single_supervisely_job_by_id

Get detailed information about a specific Supervisely job by ID. Returns: id, projectId, datasetId, userId, createdBy, description, readme, projectTitle, workspaceId, workspaceTitle, datasetTitle, labelerLogin, managerLogin, createdAt, startedAt, finishedAt, reviewFinishedAt, annotationFinishedAt, status, meta, disabled, imagesCount, finishedImagesCount, acceptedImagesCount, rejectedImagesCount,…. Required: id.

create_a_supervisely_job

Create a new annotation job in Supervisely. Returns: id, name. Required: name, userIds, datasetId.

supervisely_jobs_bulk_update

Update a Supervisely job's info by ID, including custom data, annotator, reviewer, and meta settings. Returns: id, projectId, datasetId, userId, createdBy, description, readme, projectTitle, workspaceId, workspaceTitle, datasetTitle, labelerLogin, managerLogin, createdAt, startedAt, finishedAt, reviewFinishedAt, annotationFinishedAt, status, meta, disabled, imagesCount, finishedImagesCount,…. Required: id.

supervisely_jobs_bulk_archives_bulk_update

Bulk archive labeling jobs in Supervisely by providing a list of job IDs. Returns a success response object confirming the jobs were archived. Required: ids.

list_all_supervisely_jobs_stats_activities

Get Supervisely jobs activity aggregated by day. Returns the activity-by-days report as an object. Supports filtering by labeling queue, job IDs, and a date range (fromDate / toDate). Max 500 results per page; max 10 filter conditions.

supervisely_jobs_bulk_removes_bulk_delete

Bulk-remove Supervisely jobs by providing an array of job IDs. Returns a success response with no documented body fields. Required: ids.

supervisely_jobs_set_status_bulk_update

Set the status of a Supervisely annotation job by its ID. Returns a generic success response object. Status must be one of: pending, stopped, in_progress, on_review, review_completed, completed. Required: id, status.

supervisely_jobs_bulk_set_priorities_bulk_update

Bulk set priority for multiple Supervisely jobs in a single request. Returns: 5XX. Priority must be an integer between 1 and 5. Required: jobs.

supervisely_jobs_bulk_unarchives_bulk_update

Unarchive labeling jobs in Supervisely by supplying an array of job IDs. Returns an opaque success response object with no documented fields. Required: ids.

supervisely_jobs_figure_update_review_status_bulk_update

Set the class and/or geometry review status of a figure (annotation object) in a Supervisely job. Returns a success response object. Required: jobId, figureId.

supervisely_jobs_entities_update_review_status_bulk_update

Update the review status of a Job entity in Supervisely. Returns a generic success object. The status field accepts one of: none, done, accepted, rejected, quality_check_accepted. Required: jobId, entityId, status.

supervisely_jobs_tag_update_review_status_bulk_update

Set the review status of a Tag in a Supervisely job. Returns a success response object. Required: jobId, tagId, reviewStatus.

list_all_supervisely_labeling_performance_labeling_actions

Get labeling actions performance metrics for a Supervisely team, optionally split by time period and filtered by data type, workspace, project, job, or user. Returns a performance metrics object; the upstream API does not enumerate specific response fields. Required: teamId, filters.

supervisely_labeling_performances_classes

Get classes labeling performance metrics in Supervisely, broken down by annotation class. Returns a performance metrics object whose specific fields are not enumerated in the API documentation. Required: teamId, filters.

supervisely_labeling_performances_members

Get members labeling performance metrics in Supervisely, broken down by team member. Returns a performance metrics object whose specific fields are not enumerated in the API documentation. Required: teamId, filters.

supervisely_labeling_performances_modality

Get modality labeling performance metrics in Supervisely, broken down by data modality. Returns a performance metrics object whose specific fields are not enumerated in the API documentation. Required: teamId, filters.

supervisely_labeling_performances_objects

Get objects labeling performance metrics in Supervisely, broken down by labeled object. Returns a performance metrics object whose specific fields are not enumerated in the API documentation. Required: teamId, filters.

supervisely_labeling_performances_status

Get labeling status performance metrics in Supervisely, broken down by annotation status. Returns a performance metrics object whose specific fields are not enumerated in the API documentation. Required: teamId, filters.

supervisely_labeling_performances_tags

Get tags labeling performance metrics for a Supervisely team, filtered by data type, job, project, workspace, users, and date range. Returns an object containing tags labeling performance data whose shape is not further documented upstream.timezoneOffset). Required: teamId, filters.

list_all_supervisely_labeling_performance_members_quality_checks

Get members quality-check performance in Supervisely filtered by team, workspace, project, jobs, users, data type, and date range. Returns an opaque members performance object. Required: teamId, filters.

list_all_supervisely_labeling_performance_members_reviews

Get Supervisely members review labeling performance for a team. Returns a members performance object whose individual fields are not documented upstream. Required: teamId, filters.

list_all_supervisely_labeling_performance_team_activities

Get team activity performance data in Supervisely, optionally split by time granularity and filtered by data type, jobs, projects, workspaces, users, and date range. Returns a team activity performance object whose field structure is not enumerated by the upstream API.timezoneOffset). Required: teamId, filters.

list_all_supervisely_labeling_performance_labeling_times

Get labeling actions performance metrics in Supervisely filtered by team, data type, users, jobs, and date range. Returns a performance metrics object whose fields are not enumerated in the upstream docs.timezoneOffset). Required: teamId, filters.

list_all_supervisely_labeling_performance_quality_check_times

Get quality check time performance metrics in Supervisely, optionally split by year, month, day, or hour. Returns an object containing review performance metrics. Required: teamId, filters.

list_all_supervisely_labeling_performance_review_times

Get review performance metrics in Supervisely, optionally split by year, month, day, or hour and filtered by data type, project, workspace, users, and jobs. Returns an opaque review performance metrics object whose fields are not documented by the upstream API. Required: teamId, filters.

create_a_supervisely_labeling_queues_users_add

Add annotators, reviewers, and quality check users to a Supervisely labeling queue. Returns: id, 5XX. Required: id.

supervisely_labeling_queues_stats

Get annotation statistics for a Supervisely labeling queue by id. Returns the queue's annotation statistics as an opaque object. Required: id.

list_all_supervisely_labeling_queues

List labeling queues for a Supervisely team. Returns each queue with id, title, status, projectId, datasetId, createdAt, updatedAt, and additional fields including meta, jobs, and collection details. Required: teamId.

get_single_supervisely_labeling_queue_by_id

Get information about a specific Supervisely labeling queue by id. Returns: id, name. Required: id.

create_a_supervisely_labeling_queue

Create a new labeling queue in Supervisely with annotators, reviewers, and optional job configuration. Returns: id, name. Required: name, userIds, reviewerIds.

supervisely_labeling_queues_bulk_delete

Remove a labeling queue in Supervisely by its ID. Returns an opaque success response with no documented fields. Required: id.

list_all_supervisely_labeling_queues_entities_get_nexts

Get the next entity from a Supervisely labeling queue by job id, optionally skipping specified entity IDs. Returns: id, description, createdAt, updatedAt, meta, 5XX. Required: id.

list_all_supervisely_labeling_queues_stats_entities

List entity-level annotation stats for a Supervisely labeling queue. Returns: id, 5XX. Supports sorting and up to 10 filter conditions. Required: id.

supervisely_labeling_queues_set_status_bulk_update

Update the status of a labeling queue in Supervisely by queue ID. Returns a success response confirming the status change. Status must be one of: pending, stopped, in_progress, on_review, review_completed, completed. Required: id, status.

list_all_supervisely_labeling_queues_entities_skips

Skip an entity in a Supervisely labeling queue job. Returns a generic success object with no documented fields. Required: id, entityId.

supervisely_labeling_queues_update_titles_bulk_update

Update the title of a labeling queue in Supervisely. Returns a success object confirming the title update. The name field has a maximum length of 255 characters. Required: id, name, shouldRenameJobs.

supervisely_members_deactivate

Deactivate a Supervisely team member. Returns a success status object. Provide either userId or inviteEmail to identify the member to deactivate. Required: teamId.

supervisely_members_activity

Get a Supervisely user's activity log within a team. Returns an array of activity log entries. Required: userId, teamId.

list_all_supervisely_members

List Supervisely team members with optional sorting and filtering. Returns: id, login, name, email, logins, createdAt, updatedAt, role, roleId. Required: teamId.

supervisely_members_reactivate

Reactivate a deactivated Supervisely team member. Returns a success status object. Provide either userId or inviteEmail to identify the member to reactivate. Required: teamId.

create_a_supervisely_members_type_set

Set a Supervisely team member's type to core, labeling, or labeling_hours. Returns a generic success object on completion. Required: teamId, type.

supervisely_models_clone

Clone an existing Supervisely model into a target workspace. Returns: taskId, 5XX. Required: workspaceId, name.

supervisely_models_download

Download a Supervisely model by its ID as a binary file. Returns a binary stream (application/octet-stream). Required: id.

supervisely_models_infer

Run inference on a deployed Supervisely model by providing an image or JSON input data. Returns a model-specific inference result whose shape depends on the deployed model's architecture and output format.

list_all_supervisely_models

List Supervisely models in a workspace. Returns: id, title, userId, taskId, config, createdAt, updatedAt, onlyTrain, status, pluginId, pluginVersion, hash. Required: workspaceId.

supervisely_models_upload

Upload model weights to Supervisely as a tar archive identified by hash. Returns a success response with no documented fields.

get_single_supervisely_model_by_id

Get information about a Supervisely model by ID. Returns: id, name, userId, teamId, workspaceId, taskId, config, createdAt, updatedAt, onlyTrain, status, size, pluginId, pluginVersion, description, hash. Required: id.

supervisely_models_bulk_delete

Remove a Supervisely model by its ID. Returns a success response with no documented fields. Required: id.

create_a_supervisely_models_create_from_checkpoint

Create a new model from a checkpoint in Supervisely. Returns: taskId, 5XX. The name field has a maximum length of 255 characters. Required: id, taskId, name.

create_a_supervisely_models_hash_create

Create a model hash in Supervisely from a given task. Returns: id, hash, 5XX. Required: taskId.

list_all_supervisely_models_info_deployeds

Get deployed tasks of a Supervisely model by model ID. Returns a list of deployed tasks, each containing its task id. Required: id.

list_all_supervisely_plugins

List plugins for a Supervisely team. Returns each plugin's id, name, type, description, readme, defaultVersion, dockerImage, versions, configs, createdAt, updatedAt. Required: teamId.

get_single_supervisely_plugin_by_id

Get a single Supervisely plugin by ID. Returns: id, type, name, description, readme, defaultVersion, dockerImage, versions, configs, createdAt, updatedAt. Required: id.

create_a_supervisely_point_clouds_bulk_add

Bulk add already-uploaded point clouds to an existing Supervisely dataset without uploading new data. Returns an array of the added point clouds with id and name. Required: datasetId, pointClouds.

create_a_supervisely_point_clouds_images_add

Attach already uploaded images to an existing Point Cloud in Supervisely. Images can be referenced by hash, remote link, imageId from another dataset, or teamFileId from Team Files. Returns an empty success object. Required: images.

create_a_supervisely_point_clouds_tags_add

Add a tag to a point cloud in Supervisely. Returns the created tag assignment including its id. Required: tagId, entityId.

create_a_supervisely_point_clouds_tags_bulk_add

Bulk add tags to a point cloud in Supervisely. Returns an array of created tag assignment objects, each containing id. Each tag entry requires tagId; the tags array must contain at least one item. Required: entityId.

supervisely_point_clouds_download

Download a point cloud file from Supervisely by ID. Returns the binary point cloud file content as an octet-stream. Required: id.

supervisely_point_clouds_annotated_intervals

Get annotated intervals of point clouds in a Supervisely dataset by dataset ID. Returns a map of object IDs to arrays of annotated frame interval pairs. Required: id.

list_all_supervisely_point_clouds

List point clouds in Supervisely with filtering, sorting, and field selection. Returns each point cloud entity with id, title, description, createdAt, updatedAt, datasetId, projectId, pathOriginal, hash, fileMeta, fullStorageUrl, tags, figuresCount, and annotationObjectsCount.

get_single_supervisely_point_cloud_by_id

Get a single Supervisely point cloud by ID. Returns the point cloud record including id, title, description, createdAt, updatedAt, datasetId, projectId, pathOriginal, hash, fileMeta, fullStorageUrl, tags, figuresCount, and annotationObjectsCount. Required: id.

list_all_supervisely_point_clouds_images_downloads

Download a related point cloud image in Supervisely by its ID. Returns the image file as a binary stream (application/octet-stream). Required: id.

list_all_supervisely_point_clouds_episodes_annotations_infos

List point cloud episode annotations in Supervisely for a given dataset. Returns: imageId, imageName, createdAt, updatedAt, annotation, 5XX. Required: datasetId.

list_all_supervisely_point_clouds_annotations_bulk_infos

List point cloud annotations in bulk by point cloud IDs in Supervisely. Returns an array of annotation records, each containing imageId, imageName, createdAt, updatedAt, and an annotation object with description, tags, size, and objects. Max 100 IDs per request. Required: pointCloudIds.

list_all_supervisely_point_clouds_images_lists

List point cloud images in Supervisely filtered by dataset. Returns each image's id, name, description, mime, width, height, size, hash, datasetId, labelsCount, link, createdAt, and updatedAt. Supports sorting by id, name, createdAt, or updatedAt and filtering by id, entityId, or name with a maximum of 10 filter conditions. Required: datasetId.

create_point_clouds_episodes_notify_annotation_tool

Send a notification message to the Supervisely point-cloud-episodes Annotation Tool. Two message types are supported via a oneOf body: fetch-figures-in-range (requires data.trackId, data.datasetId, data.pointCloudIds) and tracking-error (requires data.trackId, data.error). Returns an opaque success object with no documented fields.

supervisely_point_clouds_tags_removes_bulk_delete

Remove a tag from a point cloud in Supervisely by providing the point cloud tag ID. Returns a success response indicating the tag was removed.

point_clouds_episodes_stop_figure_trackings_bulk_update

Stop figure tracking for a Point Cloud Episode track in Supervisely. Returns a success response object. Required: trackId.

supervisely_point_clouds_episodes_track_figures_bulk_update

Track figures in a Supervisely point cloud episode. Accepts a point cloud ID and figure IDs with optional tracking settings controlling mode, frames, direction, and overwrite behavior. Returns a success response object. Required: entityId, figureIds.

point_clouds_episodes_frames_update_orders_bulk_update

Update the frame ordering of point-cloud episodes by dataset ID in Supervisely. The new order is defined by the sequence of frame IDs provided in the request body. Returns a generic success response object. Required: datasetId, ids.

create_a_supervisely_point_clouds_tags_update_value

Update the value of an existing point cloud tag in Supervisely. Returns a success response object confirming the tag value was updated. Required: id.

create_a_supervisely_point_clouds_bulk_upload

Upload point cloud files in bulk to Supervisely. Returns an array of uploaded point cloud objects, each containing a base64-encoded hash. Accepted formats: PCD, LAS, LAZ, and PLY.

list_all_supervisely_projects_images_get_backup_archives

Get the backup images archive download URL for a Supervisely project. Returns: archiveUrl, 5XX. Required: id.

supervisely_projects_clone

Clone a Supervisely project by creating a copy of the source project in a target workspace. Returns: taskId, 5XX. Required: workspaceId, name.

supervisely_projects_activity

Get a Supervisely project's activity log by id, showing who created or edited objects and when. Returns: userId, action, date, user, projectId, project, datasetId, dataset, imageId, image, classId, class, figureId, 5XX. Required: id.

supervisely_projects_meta

Get annotation classes and tags metadata for a Supervisely project by ID. Returns: classes, tags, projectType, 5XX. Required: id.

supervisely_projects_stats

Get dataset, image, tag, and object annotation statistics for a Supervisely project by ID. Returns: datasets, images, imageTags, objectTags, objects, objectsArea. Required: id.

list_all_supervisely_projects

List Supervisely projects with optional filtering, sorting, and field selection. Returns: id, workspaceId, name, type, description, size, status, createdAt, updatedAt. Defaults to 500 per page.

get_single_supervisely_project_by_id

Get a single Supervisely project by ID. Returns: id, teamId, workspaceId, name, type, description, size, status, createdAt, updatedAt. Required: id.

create_a_supervisely_project

Create a new empty project in Supervisely. Returns: id, name. Project type defaults to images; supported types include meshes, volumes, point_clouds, videos, and point_cloud_episodes. Required: name, workspaceId.

supervisely_projects_bulk_update

Update a Supervisely project's meta information (name, description, readme, custom data, embeddings settings) by id. Returns: classes, tags, projectType. Required: id.

supervisely_projects_bulk_delete

Soft-delete a Supervisely project by id. Returns an empty 204 response on success. Data is retained for 7 days before permanent removal. Required: id.

create_a_supervisely_projects_share_link_create

Create a share link for a Supervisely project. Returns: link, id, token, 5XX. Required: projectId.

create_a_supervisely_projects_generate_project_statistic

Generate project statistics for a Supervisely project by project ID. Returns a JSON object on success (the upstream source does not enumerate the response fields). Required: projectId.

list_all_supervisely_projects_get_heatmaps_status

Get heatmaps status from the On-the-Fly Quality Assurance app in Supervisely for a given project. Returns a heatmaps status object; the upstream API does not enumerate its fields. Required: projectId.

list_all_supervisely_projects_advanced_stats_apexes

Get project statistics for apex in Supervisely by requesting a statistics file for a given project and team. Returns a JSON object with the requested project statistics data. Required: projectId, fileName, teamId.

list_all_supervisely_projects_advanced_stats_links

Get project statistics for link in Supervisely. Returns a JSON object of project link statistics. Required: projectId, fileName, teamId.

list_all_supervisely_projects_advanced_stats_references

Get project statistics for a reference in Supervisely by project, team, and file name. Returns an opaque object containing the project's advanced statistics reference data. Required: projectId, fileName, teamId.

list_all_supervisely_projects_advanced_stats_tables

Get project statistics in table format from Supervisely. Returns a project statistics object whose specific fields depend on the project's dataset and annotation configuration. Required: projectId, fileName, teamId.

list_all_supervisely_projects_categories_stats

List project stats per category (current / trash bin) in Supervisely. Returns: id, workspaceId, name, description, size, status, createdAt, updatedAt, 5XX. Required: workspaceId.

list_all_supervisely_projects_list_stats

List Supervisely projects with stats for a workspace, with optional sorting and filtering. Returns: id, workspaceId, name, description, size, status, createdAt, updatedAt, 5XX. Required: workspaceId.

create_a_supervisely_projects_workspace_set

Move a Supervisely project to a different workspace within the same team. Returns an opaque success response object. Required: id, workspaceId.

supervisely_projects_classes_removes_bulk_delete

Soft-delete a Supervisely project class by ID. Returns an empty success response on success. Required: id, projectId.

supervisely_projects_remove_permanentlies_bulk_delete

Permanently delete Supervisely projects by ID. Accepts 1–50 project entries per request, each with a required project id and optional exported archive URLs. Returns a success object. Required: projects.

supervisely_projects_tags_removes_bulk_delete

Soft-delete a Project Tag in Supervisely by its tag ID and project ID. The endpoint returns an opaque success response with no documented response fields. Required: id, projectId.

supervisely_projects_embeddings_in_progress_updates_bulk_update

Update a Supervisely project's embeddingsInProgress flag by project ID. Returns an opaque success object with no documented fields. The id must be a positive integer (minimum 1) and errorMessage is an optional nullable string for recording any error details. Required: id, embeddingsInProgress.

supervisely_projects_meta_updates_bulk_update

Update a Supervisely project's meta — its annotation classes and tags — by project ID. Returns the updated project meta including classes (id, title, shape, color), tags (id, name, value_type, applicable_type, classes), and projectType. Required: id.

list_all_supervisely_projects_settings_updates

Update Supervisely project settings by project ID, including image grouping, labeling interface, and advanced annotation options. Returns: id, settings, 5XX. Required: id, settings.

list_all_supervisely_projects_versions_cancel_reservations

Cancel a Supervisely project version reservation. Returns an opaque success response with no documented fields. Required: id.

list_all_supervisely_projects_versions_commits

Commit a Supervisely project version using a commit token and exported archive file. Returns a success response object. Required: id, commitToken, teamFileId, projectUpdatedAt.

list_all_supervisely_projects_versions_lists

List project versions for a Supervisely project. Returns: id, version, name, description, status, createdAt, updatedAt, previewProjectId, 5XX. Supports sorting by id, version, createdAt, or updatedAt and filtering by id or version (max 10 filters). Required: projectId.

list_all_supervisely_projects_versions_reserves

Reserve a Supervisely project version for release. Returns: id, status, 5XX. Required: projectId.

list_all_supervisely_projects_versions_updates

Update the name, description, or preview project of a committed Supervisely project version. Returns: id, name, description, previewProjectId, 5XX. Required: id.

create_a_supervisely_remote_storage_providers_add

Add a team storage provider in Supervisely. Returns: id, 5XX. Provider must be one of google, azure, s3, or fs. Required: teamId, provider, endpoint.

supervisely_remote_storages_download

Download a file from Supervisely remote storage by its link. Returns the file content as a binary stream (application/octet-stream). Required: link.

supervisely_remote_storages_exists

Check whether an object exists at a specified path in Supervisely remote storage. Returns an object indicating whether the object exists. Required: path.

supervisely_remote_storages_available_providers

List remote storage providers available to a Supervisely team. Returns an object containing available provider information. No required parameters.

list_all_supervisely_remote_storages

List files and folders at a specified path in Supervisely remote storage. Returns an object containing the file and folder listing. Max 10000 items per page. Required: path.

supervisely_remote_storages_supported_providers

List all supported remote storage provider types in Supervisely. Returns an object containing supported provider information. No required parameters.

supervisely_remote_storages_stat

Get file metadata (stat) for a file in Supervisely Remote Storage. Returns an opaque file stat object. Required: path.

supervisely_remote_storages_upload

Upload a file to Supervisely Remote Storage at the specified path. Returns an upload result object.

list_all_supervisely_remote_storage_bulk_downloads

Download files from Supervisely remote storage by specifying a team ID and file paths. Returns a binary multipart/form-data file download.

create_a_supervisely_remote_storage_providers_remove

Remove a Supervisely remote storage provider by its provider ID. Returns: success, 5XX. Required: id.

create_a_supervisely_remote_storage_providers_edit_info

Add or update a Team Storage Provider in Supervisely with provider configuration, credentials, and bucket settings. Returns: id, 5XX. Required: id, provider, endpoint.

create_a_supervisely_report

Create a report in Supervisely belonging to a specific team. Returns an opaque success object with no documented response fields. Required: teamId, template.

list_all_supervisely_reports

List report entities for a specific report in Supervisely, identified by the report id. Returns report entities with id, teamId, name, template, data, and state. Required: id.

supervisely_reports_run

Run an action or command on a Supervisely report, optionally updating its state. Returns an opaque success object with no documented response fields. Required: reportId.

supervisely_reports_set

Set or append data on a specific field of a Supervisely report. Returns an opaque success object with no documented response fields. Required: reportId, payload, field.

update_a_supervisely_report_by_id

Update an existing report in Supervisely, including its template, data, and state. Returns an opaque success object with no documented response fields. Required: id, template.

get_single_supervisely_report_by_id

Get a Supervisely report by id. Returns: id, createdAt, updatedAt, 5XX. Required: id.

list_all_supervisely_roles

List team roles in Supervisely with optional sorting and filtering. Returns each role's id, role, createdAt, and updatedAt. Supports sorting by id, role, createdAt, or updatedAt and up to 10 filter conditions on the id and role fields.

list_all_supervisely_supervisely_cloud_instance_key_checks

Check whether a Supervisely Cloud Instance Key is valid by supplying its hash. Returns an opaque object with the check result. Required: instanceKeyHash.

create_supervisely_cloud_subscription_stripe_portal

Create a Stripe Billing Portal session for a Supervisely Cloud subscription. Returns a session object; the upstream API does not enumerate specific response fields. Required: teamId.

create_supervisely_cloud_subscription_stripe_setup_intent

Create a Stripe SetupIntent for a Supervisely Cloud subscription. Returns: 5XX. Required: teamId.

create_supervisely_cloud_subscription_stripe_top_up

Charge a saved Stripe payment method for a Supervisely Cloud credits top-up. Returns an opaque success object; the upstream API does not document the response fields. Required: teamId, amountCents.

create_supervisely_cloud_subscription_stripe_create

Create a Supervisely Cloud subscription using a saved Stripe payment method. Returns a generic JSON object whose fields are not documented by the upstream API. Required: teamId, setupIntentId, paymentMethodId.

list_all_supervisely_supervisely_cloud_subscription_infos

Get Supervisely Cloud subscription info for a specified team. Returns the subscription info object whose individual fields are not documented upstream. Required: teamId.

create_a_supervisely_supervisely_cloud_subscription_event

Retrieve Sly Cloud subscription usage events for a team, optionally filtered by a date range and grouped by slug. Returns an opaque object whose individual fields are not documented by the upstream API. Required: teamId.

list_all_supervisely_supervisely_cloud_tasks_lists

List Supervisely Cloud tasks for a team. Returns each task's id, type, status, startedAt, finishedAt, and meta with step, config, output, and preset details. Required: teamId.

create_a_supervisely_image_tags_add_to_image

Add a project tag to an image in Supervisely. Optionally supply a tag value (nullable string or float number) or a two-element video frame range. Returns a success response object. Required: tagId, imageId.

create_a_supervisely_image_tags_bulk_add_to_image

Bulk add a project tag to one or more images in Supervisely. Returns a success object. The ids array accepts up to 1000 unique image IDs. Required: tagId, ids.

create_a_supervisely_object_tags_add_to_object

Add a project tag to an object (figure) in Supervisely. Returns a success object confirming the tag was attached. The optional value field accepts a nullable string or a float number for value-based tags. Required: tagId, figureId.

create_a_supervisely_tags_entities_bulk_add

Add tags to entities (images, videos, etc.) in Supervisely. Returns an array of created entity-tag associations including id, entityId, tagId, value, startFrame, and endFrame. Required: projectId, tags.

create_a_supervisely_images_tags_bulk_add

Add multiple project tags to a single image in Supervisely. Returns a success response object. The tags array must contain at least one item, each with a required tagId and an optional value (string or float). Required: imageId.

supervisely_object_tags_add

Create a new object tag in an existing Supervisely project. Returns: id, name, 5XX. Required: color, name, projectId.

list_all_supervisely_object_tags

List object tags in a Supervisely team with optional filtering and sorting. Returns: id, projectId, name, createdAt, updatedAt, settings, 5XX. Required: teamId.

supervisely_object_tags_edit_info

Update an existing object tag's name, color, and hotkey in Supervisely. Returns: id, name, 5XX. Required: id, color, name.

create_a_supervisely_object_tags_bulk_add

Bulk create new object tags in an existing Supervisely project. Returns an array of created tags, each with id and name. Required: projectId, tags.

create_a_supervisely_tags_bulk_add

Create one or more new tags in an existing Supervisely project. Returns: projectId, tags, 5XX. Required: projectId, tags.

list_all_supervisely_image_tags

List image tags in Supervisely, optionally filtered by project, dataset, image, or name. Returns: id, projectId, name, createdAt, updatedAt, settings, 5XX. Required: teamId.

list_all_supervisely_tags

List tags for a Supervisely project, with optional sorting and filtering. Returns: id, projectId, name, createdAt, updatedAt, settings, 5XX. Required: projectId.

supervisely_image_tags_remove_from_images_bulk_delete

Remove a tag from an image in Supervisely by providing the project tag ID, image ID, and image tag ID. Returns a success response object. Required: tagId, imageId, id.

supervisely_object_tags_remove_from_figures_bulk_delete

Remove a tag from a labeled object (figure) in Supervisely. Returns a generic success response object. Required: tagId, figureId, id.

create_a_supervisely_image_tags_bulk_remove_from_image

Remove image tags from multiple images in Supervisely in a single bulk operation. Returns a success response object. Each array accepts up to 1000 unique integer IDs with a minimum value of 1. Required: tagIds, ids.

supervisely_image_tags_restore_to_images_bulk_update

Restore a previously removed image tag to its image in Supervisely by providing the image tag instance ID. Returns a generic success response. Required: id.

supervisely_object_tags_restore_to_figures_bulk_update

Restore a Figure Tag to an object in Supervisely by providing the tag's id. Returns an opaque success response with no documented fields. Required: id.

create_a_supervisely_image_tags_update_tag_value

Update the value of an existing image tag in Supervisely. Returns a success response object. Required: id.

create_a_supervisely_object_tags_update_tag_value

Update the value of a Figure Tag in Supervisely. Returns a generic success object whose properties the upstream API does not enumerate. Required: id.

supervisely_advanced_tags_edit_infos_bulk_update

Update a Supervisely tag's fields such as name, color, hotkey, and settings. Returns: id, title, color, hotkey, 5XX. Required: color, name, id.

create_a_supervisely_tasks_files_bulk_upload

Bulk upload files to a Supervisely task. Returns a success response object confirming the files were added. The processFiles query parameter controls whether files are processed after upload.

create_a_supervisely_tasks_files_bulk_add_by_hash

Add files to a Supervisely task by their file hash. Returns an opaque success object from Supervisely. Required: task_id, files.

create_a_supervisely_tasks_users_add

Add multiple users to a Supervisely task. Returns a success response on completion. Required: taskId, userIds.

create_a_supervisely_tasks_app_service_set

Attach a Task to an App Service in Supervisely. Returns a success response object with no documented fields. Required: taskId, appServiceId.

create_a_supervisely_tasks_checkpoints_clear

Clear unused train Task checkpoints in Supervisely by providing the Train Task ID. Returns a success response object on completion. Required: id.

list_all_supervisely_tasks_import_download_files

Download a file from a Supervisely import task by task ID and filename. Returns the file content as a binary stream (application/octet-stream). Required: id, filename.

list_all_supervisely_tasks_app_session_files

Get app session template and static files in Supervisely. Returns an opaque app session file object; the upstream schema does not enumerate specific response fields. Required: taskId, filePath.

list_all_supervisely_tasks_import_files_lists

List files imported by a Supervisely task by task ID. Returns an array of file objects including hash, meta (with mime type, size, and media stream metadata), and filename. Required: id.

supervisely_tasks_context

Get the team and workspace context for a Supervisely task by id. Returns: team, workspace, 5XX. Required: id.

list_all_supervisely_tasks

List Supervisely tasks in a workspace. Returns each task with id, type, status, startedAt, finishedAt, meta, teamId, attempt, and agentId. Required: workspaceId.

supervisely_tasks_resume

Resume a Supervisely app task that is in ERROR, FINISHED, or STOPPED status. Returns: success, 5XX. Required: id.

supervisely_tasks_request

Send a request with a command and context to a Supervisely task. Returns a command-specific response (e.g., success, status, or taskId) whose shape depends on the command invoked. Required: taskId.

supervisely_tasks_stop

Stop a running Supervisely task by ID. Returns the task's new status (e.g. 'terminating'). Not all task types can be stopped. Required: id.

get_single_supervisely_task_by_id

Get information about a specific Supervisely task by ID. Returns: id, teamId, workspaceId, type, status, startedAt, finishedAt, meta. Required: id.

create_a_supervisely_tasks_data_get

Retrieve custom task data from a Supervisely task by specifying dot-notation field paths to read. Returns: 5XX. Required: taskId.

list_all_supervisely_tasks_log_downloads

Download logs for a Supervisely task by task ID, optionally filtered to entries since a given timestamp and limited to a maximum number of log lines. Returns the task logs as a JSON object; the upstream API does not enumerate specific response fields. Required: id.

list_all_supervisely_tasks_train_metrics

List Supervisely model training metrics filtered by Model or Task ID. Returns: timestamp, metrics, epoch, type. Provide taskId or modelId to retrieve the corresponding training metrics.

list_all_supervisely_tasks_checkpoints_lists

List checkpoints for a Supervisely training task by task ID. Returns: id, createdAt, updatedAt, 5XX. Required: id.

list_all_supervisely_tasks_users_lists

List all users assigned to a Supervisely task. Returns: id, createdAt, updatedAt, 5XX. Required: taskId.

create_a_supervisely_tasks_users_remove

Remove multiple users from a task in Supervisely. Returns a generic success response object with no documented fields. Required: taskId, userIds.

create_a_supervisely_tasks_bulk_remove

Bulk remove tasks in Supervisely by providing a list of task IDs. Returns an opaque success object with no documented fields. Required: ids.

create_a_supervisely_tasks_run_app

Run an app as a new Task in Supervisely. Returns: taskId, 5XX. The description field accepts up to 255 characters; advancedSettings supports Kubernetes resource limits, mount configuration, and deployment options. Required: agentId, workspaceId.

create_a_supervisely_tasks_run_dtl

Create a DTL (Data Transformation Language) task in Supervisely by submitting a workspace ID and a DTL config array. Returns: taskId, 5XX. The optional `advanced` object lets you pin a specific agent, plugin version, or plugin ID; `pluginId` is required when `version` is supplied. Required: workspaceId, config.

create_a_supervisely_tasks_run_deploy

Create a deploy task in Supervisely to run a model on an agent. Returns: taskId, 5XX. Required: modelId.

create_a_supervisely_tasks_run_plugin

Create and start a plugin task in Supervisely. Returns the created task's taskId. taskType must be one of custom, train, inference, infer_rpc, or smarttool. Required: name, taskType, pluginId.

create_a_supervisely_tasks_run_python

Run a Python script as a new Supervisely task in the specified workspace. Returns: taskId, 5XX. The script can be supplied inline or referenced by name via config; advanced options control which agent and plugin version execute it. Required: workspaceId.

create_a_supervisely_tasks_request_direct

Send a direct request to a Supervisely task, passing a command with optional context and state. Returns a dynamic JSON object whose structure depends on the task and command. Set skipResponse to false to wait for the task's response with a configurable timeout.

create_a_supervisely_tasks_data_set

Set custom task data in Supervisely by replacing or appending field values within a task report. Returns a generic success object. Required: taskId, fields.

create_a_supervisely_tasks_output_set

Set the output of a Supervisely task by providing one of four output variants — project, model, general, or experiment — each with its own required fields. Returns a generic success response. Required: taskId, output.

create_a_supervisely_tasks_restart_policy_set

Set the restart policy for a Supervisely task by task ID. Returns a success response object. Valid restartPolicy values: on_error, never, on_startup. Required: taskId, restartPolicy.

create_a_supervisely_tasks_sharing_set

Set the sharing state of a Supervisely task by toggling its shared flag. Returns a success response object with no documented fields. Required: taskId, shared.

create_a_supervisely_tasks_app_v_2_data_set

Set custom task data for a Supervisely task (app v2). Returns an opaque success object with no documented fields. Required: taskId.

create_a_supervisely_tasks_meta_update

Update a Supervisely task's metadata by task ID. Returns: success, 5XX. The name, templateRootDirectory, and agentStorageFolder fields may optionally be supplied to set new values. Required: id.

create_a_supervisely_tasks_upload_dtl_archive

Upload a DTL archive (tar file) to a Supervisely task. The API returns a generic success object with no documented fields.

supervisely_teams_archive

Archive a Supervisely team by id. Returns: id, name, description, createdAt, updatedAt, role, 5XX. Required: id.

supervisely_teams_activity

Get the activity log for a Supervisely team, showing who created or edited objects and when. Returns: userId, action, date, user, projectId, project, datasetId, dataset, imageId, image, classId, class, figureId, 5XX. Required: teamId.

list_all_supervisely_teams

List teams in Supervisely with optional sorting, filtering, and availability filtering. Returns: id, name, description, createdAt, updatedAt, role. Filter conditions support field, operator, and value with a maximum of 10 conditions.

get_single_supervisely_team_by_id

Get information about a specific team in Supervisely by ID. Returns: id, name, description, createdAt, updatedAt, role. Required: id.

create_a_supervisely_team

Create a new empty team in Supervisely. Returns: id, name. Team name must not contain /, \, or | and max length is 255 characters. Required: name.

supervisely_teams_bulk_update

Update a team's meta information in Supervisely, including name, description, and default workspace. Returns: id, name, description, createdAt, updatedAt, role. Required: id.

create_a_supervisely_teams_entities_filters_custom_presets_add

Create a custom entities filter preset for a Supervisely team. Returns a success response object. The name must be at most 255 characters and cannot contain `/`, `\`, or `|`. Required: teamId, name, filters.

teams_entities_filters_custom_presets_removes_bulk_delete

Delete a custom entities filter preset from a Supervisely team. Returns an opaque success response with no documented fields. Required: id.

list_all_supervisely_teams_entities_filters_custom_presets_lists

List custom entities filter presets for a Supervisely team. Returns: id, teamId, createdAt, updatedAt, 5XX. Required: teamId.

list_all_supervisely_teams_list_stats

List team statistics in Supervisely. Returns: id, name, description, createdAt, updatedAt, role, 5XX. Results can be sorted by team attributes or various annotation, image, and labeling job counts, and filtered by id, name, or description.

teams_entities_filters_custom_presets_edit_infos_bulk_update

Update a custom entities filter preset for a Team in Supervisely. Returns: id, name, filters, 5XX. The name field has a max length of 255 and cannot contain forward slashes, back slashes, or pipe characters. Required: id.

create_a_supervisely_users_ecosystem_favorites_add

Add an ecosystem app to the current user's favorites in Supervisely. Returns a generic success acknowledgment object. Required: moduleId.

create_a_supervisely_users_convert_restricted

Convert a restricted Supervisely user to a regular user by id. Returns: id, createdAt, updatedAt, 5XX.

supervisely_users_me

Get information about the currently authenticated Supervisely user. Returns: id, login, name, email, logins, disabled, lastLogin, createdAt, updatedAt, teams, 5XX.

supervisely_users_online

Get information about the currently online Supervisely user. Returns: id, login, name, email, logins, disabled, lastLogin, createdAt, updatedAt, teams.

create_a_supervisely_users_ecosystem_favorites_remove

Remove an ecosystem app from the current user's favorites in Supervisely. Returns a generic success confirmation object. Required: moduleId.

supervisely_users_reset_authentication_attempts_bulk_delete

Reset authentication attempts for a Supervisely user. Returns an empty 204 response on success. Required: id.

supervisely_users_toolbox_settings_sets_bulk_update

Set user toolbox settings in Supervisely for a given annotation tool, including hotkey configuration. Returns a 200 success response with an opaque object body. Required: toolboxKey, settings.

create_a_supervisely_videos_tags_add

Add a project tag to a video in Supervisely. Returns the created video tag object including its id. Required: tagId, videoId.

create_a_supervisely_videos_tags_bulk_add

Add one or more project tags to a video in Supervisely. Returns an array of created tag objects, each with its id. Required: videoId, tags.

create_a_supervisely_videos_bulk_add

Add already-uploaded videos to an existing Supervisely dataset without uploading new data; use Upload Videos to upload the video file first. Returns: an array of added video objects, each with id and name. Required: datasetId, videos.

list_all_supervisely_videos_download_frames

Download a specific frame from a Supervisely video as binary image data (application/octet-stream). Required: videoId, frame.

list_all_supervisely_videos_bulk_download_frames

Download multiple frames from a Supervisely video by video ID. Returns a binary multipart/form-data file containing the requested frames. Required: videoId, frames.

supervisely_videos_download

Download a Supervisely video file by ID. Returns the raw video file as a binary stream (application/octet-stream). Required: id.

supervisely_videos_annotated_intervals

Get annotated frame intervals of a Supervisely video by ID. Returns a list of [startFrame, endFrame] pairs indicating which frame ranges contain annotations.

list_all_supervisely_videos

List videos in Supervisely with filtering, sorting, and field selection. Returns video records including id, name, description, createdAt, updatedAt, pathOriginal, hash, projectId, datasetId, meta, fileMeta, and tags. Supports filtering by datasetId or projectId and advanced filters by filename, tags, size, objects, annotators, issues, and jobs.

supervisely_videos_stop_figure_tracking

Stop tracking figures for a specific track in a Supervisely video. Returns a success response object on completion. Required: trackId.

get_single_supervisely_video_by_id

Get a Supervisely video by id. Returns: id, parentId, title, description, createdAt, updatedAt, dataId, remoteDataId, meta, pathOriginal, hash, groupId, projectId, datasetId, createdBy, customData, workspaceId, link, fileMeta, tags, name, teamId. Required: id.

supervisely_videos_bulk_update

Update a Supervisely video's editable fields such as name and description. Returns: id, parentId, title, description, createdAt, updatedAt, dataId, remoteDataId, meta, pathOriginal, hash, groupId, projectId, datasetId, createdBy, customData, workspaceId, link, fileMeta. Required: id.

create_a_supervisely_videos_tags_bulk_finish

Finish multiple video tags in bulk by setting each tag's end frame in Supervisely. Returns a success response object. Required: tags.

list_all_supervisely_videos_objects_get_frames

Get the frame indices where specified objects appear in a Supervisely video. Returns an array of arrays of frame indices, with each sub-array corresponding to one object ID in the order supplied. Required: videoId, objectIds.

list_all_supervisely_videos_get_pages

Get a page of a video in Supervisely by video ID, with optional sorting and filtering. Returns: page, 5XX. Required: entityId.

list_all_supervisely_videos_custom_data_gets

Get video custom data by video ID in Supervisely. Returns the video's customData object containing user-defined fields previously set via the custom-data.set endpoint. Required: id.

list_all_supervisely_videos_annotations_bulk_infos

Get annotations for multiple Supervisely videos by their IDs in a single bulk request. Returns an array of video annotation objects including videoId, videoName, createdAt, updatedAt, description, tags, size, framesCount, objects, and frames. Required: videoIds.

create_a_supervisely_videos_notify_annotation_tool

Send a message to the Supervisely Annotation Tool to notify it about video tracking events — figure fetching, tracking errors, or tracking warnings. Returns a generic success object.

supervisely_videos_tags_removes_bulk_delete

Remove a tag from a video in Supervisely by specifying the video tag id. Returns: 5XX.

list_all_supervisely_videos_custom_data_sets

Set custom data on a Supervisely video by its ID. Returns an opaque object confirming the custom data was set. Required: id, customData.

supervisely_videos_track_figures_bulk_update

Track figures on a Supervisely video by specifying figure IDs and optional tracking settings such as tracker engine, frame count (max 200), direction, and overwrite behavior. Returns a success response object. Required: videoId, figureIds.

create_a_supervisely_videos_tags_bulk_unfinish

Bulk unfinish video tags in Supervisely by reverting a list of video tags from their finished state. Returns a success response object. Required: tags.

supervisely_videos_tags_updates_bulk_update

Update a Supervisely video tag's frame range by specifying the tag id and a new two-element frame range. Returns: id, 5XX. Required: id, frameRange.

create_a_supervisely_videos_tags_update_value

Update the value of a Video Tag in Supervisely. Returns: id, value, 5XX. When nonFinalValue is set to true, a default value is assigned based on tag settings and value must be null. Required: id.

supervisely_videos_update_links_bulk_update

Update remote links for Videos in Supervisely — useful when moving files to another server, when a link expires, or moving videos from local storage to remote. Returns a success response object. Required: videos.

create_a_supervisely_videos_bulk_upload

Bulk upload video files to Supervisely. Returns an array of objects, each containing a hash field with the base64-encoded hash of the uploaded video.

create_a_supervisely_volumes_slices_bulk_add

Attach already-uploaded volume slices to an existing Supervisely dataset without uploading new data. Returns an array of created slice objects, each containing an id. Required: volumeId, volumeSlices.

create_a_supervisely_volumes_tags_add

Add a project tag to a volume in Supervisely, optionally with a value. Returns the created volume tag association including its id. Required: tagId, entityId.

create_a_supervisely_volumes_tags_bulk_add

Bulk add project tags to a Supervisely volume. Returns an array of created tag assignment objects, each containing id. Each tag entry in the tags array requires a tagId, and the array must contain at least one item. Required: entityId.

create_a_supervisely_volumes_bulk_add

Add already-uploaded volumes to an existing Supervisely dataset without uploading new data. Returns an array of added volume objects each with id and name. Required: datasetId, volumes.

list_all_supervisely_volumes_slices_downloads

Download a single Supervisely volume slice by its ID. Returns a binary file stream (application/octet-stream) containing the slice data. Required: volumeId, id.

list_all_supervisely_volumes_slices_images_downloads

Download a slice image from a Supervisely volume by volume ID, with optional slice index, normal vector, and windowing parameters. Returns a binary image stream (application/octet-stream). Required: volumeId.

supervisely_volumes_download

Download a Supervisely volume by id. Returns the volume content as a binary file download (application/octet-stream). Required: id.

list_all_supervisely_volumes

List Supervisely volumes with optional filtering, sorting, and field selection. Returns: id, name, title, description, parentId, datasetId, projectId, groupId, workspaceId, createdAt, updatedAt, meta, pathOriginal, hash, createdBy, createdByUser, customData, fileMeta, fullStorageUrl, link, tags, jobs, figuresCount, annotationObjectsCount, labelsCount, size, customSort, collectionItemIndex.…

get_single_supervisely_volume_by_id

Get information about a specific Supervisely volume by id. Returns: id, name, title, description, parentId, datasetId, projectId, groupId, workspaceId, createdAt, updatedAt, meta, pathOriginal, hash, createdBy, createdByUser, customData, fileMeta, fullStorageUrl, link, tags, jobs, figuresCount, annotationObjectsCount, labelsCount, size, customSort, collectionItemIndex. Required: id.

list_all_supervisely_volumes_slices_bulk_downloads

Download Volume Slices from Supervisely by dataset and slice IDs. Returns a binary multipart/form-data response containing the downloaded volume slices. Maximum 1000 slice IDs per request. Required: datasetId, sliceIds.

list_all_supervisely_volumes_annotations_bulk_infos

Retrieve annotations for multiple volumes in Supervisely by their volume IDs. Returns an array of annotation records, each containing imageId, imageName, createdAt, updatedAt, and an annotation object with description, tags, size, and objects. Required: volumeIds.

list_all_supervisely_volumes_slices_lists

List volume slices in Supervisely for a given volume. Returns: id, volumeId, createdAt, 5XX. Required: volumeId.

supervisely_volumes_tags_removes_bulk_delete

Remove a tag from a volume in Supervisely by specifying the volume tag's id. Returns a success response on completion.

create_a_supervisely_volumes_tags_update_value

Update the value of a Volume Tag in Supervisely. Returns the updated volume tag object including id and value. Required: id.

list_all_supervisely_webhooks

List webhooks for a team in Supervisely with optional sorting and filtering. Returns webhook records with id, teamId, url, action, createdAt, updatedAt. Required: teamId.

supervisely_webhooks_test

Test a webhook in Supervisely by triggering a test delivery. Returns an opaque success response. Required: teamId.

update_a_supervisely_webhook_by_id

Update an existing webhook in Supervisely by id. Returns: id, 5XX. Required: id.

get_single_supervisely_webhook_by_id

Get information about a specific Supervisely webhook by ID. Returns: id, teamId, url, action, meta, createdAt, updatedAt. Required: id.

create_a_supervisely_webhook

Create a new webhook in Supervisely for a specific team. Returns: id. Required: teamId, url, action.

supervisely_webhooks_bulk_delete

Remove one or more Supervisely webhooks in bulk by their IDs. Returns a success response. Required: ids.

supervisely_webhooks_bulk_removes_bulk_delete

Remove multiple webhooks in Supervisely by submitting an array of webhook IDs. Returns an opaque success object with no documented fields. Required: ids.

supervisely_workspaces_archive

Archive a workspace in Supervisely by workspace id. Returns an empty response on success. Required: id.

supervisely_workspaces_clone

Clone a Supervisely workspace, creating a copy in a target team. Returns: taskId, 5XX. Required: teamId, name.

list_all_supervisely_workspaces

List workspaces in a Supervisely team. Returns: id, teamId, name, createdAt, updatedAt. Required: teamId.

get_single_supervisely_workspace_by_id

Get information about a specific Supervisely workspace by id. Returns: id, teamId, name, createdAt, updatedAt. Required: id.

create_a_supervisely_workspace

Create a new empty workspace in Supervisely. Returns: id, name. Required: teamId, name.

supervisely_workspaces_bulk_update

Update a Supervisely workspace's name and description by id. Returns: id, teamId, name, createdAt, updatedAt, taskId. Required: id.

list_all_supervisely_workspaces_list_stats

List workspace statistics in Supervisely for a specified team. Returns: id, name, createdAt, updatedAt, 5XX. Required: teamId.

supervisely_workspaces_visibility_sets_bulk_update

Set the visibility (hidden flag) of a workspace in Supervisely. Returns a success response confirming the visibility was updated. Required: id, hidden.

create_a_supervisely_annotation_tool_run_action

Run an action on a Supervisely annotation tool session by dispatching one of 26 supported actions such as setting figures, navigating entities or images, controlling jobs, and showing notifications. Returns an action-specific JSON object whose shape depends on the dispatched action. Required: sessionId, action.

list_all_supervisely_users_ssh_keys

List SSH keys for the current Supervisely user. The upstream API returns a 200 response whose fields are not enumerated in the Supervisely API reference; consult the upstream docs for the field-level breakdown.