filter images by board_id

invokeai/app/api/routers/images.py

@@ -221,6 +221,9 @@ async def list_images_with_metadata(
     is_intermediate: Optional[bool] = Query(
         default=None, description="Whether to list intermediate images"
     ),
+    board_id: Optional[str] = Query(
+        default=None, description="The board of images to include"
+    ),
     offset: int = Query(default=0, description="The page offset"),
     limit: int = Query(default=10, description="The number of images per page"),
 ) -> OffsetPaginatedResults[ImageDTO]:
@@ -232,6 +235,7 @@ async def list_images_with_metadata(
         image_origin,
         categories,
         is_intermediate,
+        board_id
     )
 
     return image_dtos

invokeai/app/services/image_record_storage.py

@@ -286,6 +286,7 @@ class SqliteImageRecordStorage(ImageRecordStorageBase):
         image_origin: Optional[ResourceOrigin] = None,
         categories: Optional[list[ImageCategory]] = None,
         is_intermediate: Optional[bool] = None,
+        board_id: Optional[str] = None,
     ) -> OffsetPaginatedResults[ImageRecord]:
         try:
             self._lock.acquire()
@@ -317,6 +318,10 @@ class SqliteImageRecordStorage(ImageRecordStorageBase):
                 query_conditions += f"""AND is_intermediate = ?\n"""
                 query_params.append(is_intermediate)
 
+            if board_id is not None:
+                query_conditions += f"""AND board_id = ?\n"""
+                query_params.append(board_id)
+
             query_pagination = f"""ORDER BY created_at DESC LIMIT ? OFFSET ?\n"""
 
             # Final images query with pagination

invokeai/app/services/images.py

@@ -322,6 +322,7 @@ class ImageService(ImageServiceABC):
         image_origin: Optional[ResourceOrigin] = None,
         categories: Optional[list[ImageCategory]] = None,
         is_intermediate: Optional[bool] = None,
+        board_id: Optional[str] = None,
     ) -> OffsetPaginatedResults[ImageDTO]:
         try:
             results = self._services.records.get_many(
@@ -330,6 +331,7 @@ class ImageService(ImageServiceABC):
                 image_origin,
                 categories,
                 is_intermediate,
+                board_id
             )
 
             image_dtos = list(