Search images

To get a project’s list of images:

sa.search_images(project = "Project Name")

To get the list of images whose names include a specific prefix:

sa.search_images(
    project = "Project Name", 
    image_name_prefix = "Image Name Prefix")

To get a list of images that have a specific annotation status:

sa.search_images(
    project = "Project Name", 
    image_name_prefix = "Image Name Prefix",
    annotation_status = "Completed")

📘
The annotation_status field can have one of the following values: NotStarted, InProgress, QualityCheck, Returned, Completed, and Skipped.

Assign images

To assign images to a project contributor:

sa.assign_images(
    project = "Project Name",
    image_names = ["image1.png", "image2.png"],
    user = "[email protected]")

📘
The assignment role, QA or Annotator, will be automatically generated based on the contributor’s role in the project.

Set annotation status of images

To set the annotation status of a list of images:

sa.set_images_annotation_statuses(
    project = "Project Name",
    image_names = ["image1.png", "image2.png"],
    annotation_status = "Returned")

Copy images

To copy images between folders in a project:

sa.copy_images(
    source_project = "Project Name/Source Folder",
    image_names = ["image1.png", "image2.png"],
    destination_project = "Project Name/Destination Folder")

The image annotations and corresponding metadata are copied to the destination project by default. To disable this:

sa.copy_images(
    source_project = "Project Name/Source Folder",
    image_names = ["image1.png", "image2.png"],
    destination_project = "Project Name/Destination Folder",
    include_annotations = False,  
    copy_pin = False)

Move images

To move images from one folder to another:

sa.move_images(
    source_project = "Project Name/Source Folder",
    image_names = ["image1.png", "image2.png"],
    destination_project = "Project Name/Destination Folder")

Delete images

To delete a list of images from a project:

sa.delete_images(
    project = "Project Name",
    image_names = ["image1.png", "image2.png"])