Infinite Image Browsing

https://github.com/zanllp/infinite-image-browsing
Admin
Infinite Image Browsing is a high-performance image and video browser with advanced search, tagging,...
Tokens:37,734
Snippets:344
Trust Score:8.5
License:MIT
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install Project Dependencies

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/vue/README.md

Run this command to install all the necessary project dependencies after cloning the repository.

```sh
yarn
```

--------------------------------

### Connectivity and Setup

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/SKILL.md

Before using the API, ensure the IIB service is running and test connectivity. Instructions for starting the service are also provided.

```APIDOC
## Test Connectivity

### Description
Tests if the IIB service is running by sending a hello request.

### Method
GET

### Endpoint
`/infinite_image_browsing/hello`

### Parameters
None

### Request Example
```bash
curl --noproxy "*" -s http://127.0.0.1:<PORT>/infinite_image_browsing/hello
```

### Response
#### Success Response (200)
- **message** (string) - "hello" if the service is running.

#### Response Example
```json
"hello"
```

## Start Service

### Description
Instructions to start the IIB service, either as a foreground or background process.

### Command
```bash
cd /path/to/sd-webui-infinite-image-browsing
python app.py --port <port>
```

### Background Daemon
```bash
nohup python app.py --port <port> > iib.log 2>&1 &
```
```

--------------------------------

### List directory files response

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/references/api-reference.md

Example JSON response for the GET /files endpoint.

```json
{
  "files": [{
    "type": "file|dir",
    "date": 1234567890.0,
    "created_time": 1234567890.0,
    "size": "1.2 MB",
    "bytes": 1258291,
    "name": "image.png",
    "fullpath": "/path/to/image.png",
    "is_under_scanned_path": true
  }]
}
```

--------------------------------

### Start Organization Job

Source: https://context7.com/zanllp/infinite-image-browsing/llms.txt

Starts an AI-powered file organization job that clusters images by semantic similarity.

```bash
curl -X POST "http://127.0.0.1:7866/infinite_image_browsing/db/organize_files_start" \
  -H "Content-Type: application/json" \
  -d '{
    "folder_paths": ["/path/to/messy/images"],
    "dest_folder": "/path/to/organized",
    "threshold": 0.90,
    "min_cluster_size": 3,
    "lang": "en",
    "recursive": true,
    "folder_naming": "title",
    "action": "move",
    "handle_noise": "unsorted",
    "noise_folder_name": "Unsorted"
  }'

# Response: {"job_id": "abc123def456"}
```

--------------------------------

### Start IIB Service

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/docs/ai-agents.md

Run this command to start the Infinite Image Browsing service. Replace <port> with your desired port number.

```bash
python app.py --port <port>
```

--------------------------------

### POST /db/organize_files_start

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/references/api-reference.md

Starts a file organization job.

```APIDOC
## POST /db/organize_files_start

### Description
Start file organization job.

### Method
POST

### Endpoint
/db/organize_files_start

### Request Body
- **folder_paths** (array) - Required - Source paths
- **dest_folder** (string) - Required - Destination path
- **threshold** (number) - Required - Clustering threshold
- **min_cluster_size** (number) - Required - Minimum cluster size
- **lang** (string) - Required - Language
- **recursive** (boolean) - Optional - Recursive processing
- **folder_naming** (string) - Required - Naming strategy (title|keywords|id)
- **action** (string) - Required - Action (move|copy)
- **handle_noise** (string) - Required - Noise handling (skip|unsorted|leave)
- **noise_folder_name** (string) - Optional - Name for noise folder
```

--------------------------------

### POST /infinite_image_browsing/db/organize_files_start

Source: https://context7.com/zanllp/infinite-image-browsing/llms.txt

Starts an AI-powered file organization job.

```APIDOC
## POST /infinite_image_browsing/db/organize_files_start

### Description
Starts an AI-powered file organization job that clusters images by semantic similarity.

### Method
POST

### Endpoint
/infinite_image_browsing/db/organize_files_start

### Request Body
- **folder_paths** (array) - Required - Paths to organize
- **dest_folder** (string) - Required - Destination folder
- **threshold** (float) - Optional - Similarity threshold
- **min_cluster_size** (integer) - Optional - Minimum images per cluster

### Response Example
{"job_id": "abc123def456"}
```

--------------------------------

### Database basic info response

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/references/api-reference.md

Example JSON response for the GET /db/basic_info endpoint.

```json
{
  "img_count": 10000,
  "tags": [{"id": 1, "name": "tag1", "type": "custom", "color": "#ff0000"}],
  "expired": false,
  "expired_dirs": []
}
```

--------------------------------

### Start Clustering Job

Source: https://context7.com/zanllp/infinite-image-browsing/llms.txt

Starts a background job to cluster images by semantic similarity of their prompts using AI embeddings.

```bash
curl -X POST "http://127.0.0.1:7866/infinite_image_browsing/db/cluster_iib_output_job_start" \
  -H "Content-Type: application/json" \
  -d '{
    "folder_paths": ["/path/to/images"],
    "model": "text-embedding-3-small",
    "threshold": 0.85,
    "min_cluster_size": 3,
    "title_model": "gpt-4o-mini",
    "lang": "en",
    "recursive": false
  }'

# Response: {"job_id": "cluster_job_123"}
```

--------------------------------

### Install IIB Skill for AI Agent

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/docs/ai-agents.md

Use this command to add the IIB skill to your AI agent. Ensure you have npx installed.

```bash
npx skills add https://github.com/zanllp/infinite-image-browsing --skill iib
```

--------------------------------

### Quick View URL Example

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/docs/ai-agents.md

This URL format is used for a fullscreen preview of a single image. Adjust the path to your image.

```url
?action=view&path=/path/to/img.png
```

--------------------------------

### Start IIB Service

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/SKILL.md

Commands to launch the application directly or as a background daemon.

```bash
cd /path/to/sd-webui-infinite-image-browsing
python app.py --port <port>
```

```bash
nohup python app.py --port <port> > iib.log 2>&1 &
```

--------------------------------

### Get Global Settings

Source: https://context7.com/zanllp/infinite-image-browsing/llms.txt

Retrieves current global configuration settings.

```bash
curl "http://127.0.0.1:7866/infinite_image_browsing/global_setting"

# Response:
{
  "global_setting": {...},
  "cwd": "/app",
  "is_win": false,
  "home": "/home/user",
  "all_custom_tags": [...],
  "extra_paths": [...],
  "enable_access_control": false,
  "launch_mode": "standalone",
  "is_readonly": false
}
```

--------------------------------

### Frontend URL Parameters

Source: https://context7.com/zanllp/infinite-image-browsing/llms.txt

Examples of URL parameters for deep linking to specific views and searches.

```bash
# Quick view single image
http://127.0.0.1:7866/infinite_image_browsing?action=view&path=/path/to/image.png

# Open keyword search page
http://127.0.0.1:7866/infinite_image_browsing?action=pane&type=fuzzy-search

# Pre-filled keyword search
http://127.0.0.1:7866/infinite_image_browsing?action=pane&type=fuzzy-search&props=%7B%22substr%22%3A%22sunset%22%7D

# Regex search (sunset OR sunrise)
http://127.0.0.1:7866/infinite_image_browsing?action=pane&type=fuzzy-search&props=%7B%22substr%22%3A%22(sunset%7Csunrise)%22%2C%22isRegex%22%3Atrue%7D

# Tag search page
http://127.0.0.1:7866/infinite_image_browsing?action=pane&type=tag-search

# Browse specific folder
http://127.0.0.1:7866/infinite_image_browsing?action=pane&type=local&props=%7B%22path%22%3A%22%2Fpath%2Fto%2Ffolder%22%7D

# Random images
http://127.0.0.1:7866/infinite_image_browsing?action=pane&type=random-image

# Image comparison
http://127.0.0.1:7866/infinite_image_browsing?action=pane&type=img-sli&props=%7B%22paths%22%3A%5B%22%2Fpath%2Fto%2Fimg1.png%22%2C%22%2Fpath%2Fto%2Fimg2.png%22%5D%7D
```

--------------------------------

### POST /db/cluster_iib_output_job_start

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/references/api-reference.md

Starts a background job to cluster images.

```APIDOC
## POST /db/cluster_iib_output_job_start

### Description
Start clustering background job.

### Method
POST

### Endpoint
/db/cluster_iib_output_job_start

### Request Body
- **folder** (string) - Required - Path to folder
- **folder_paths** (array) - Optional - List of folder paths
- **model** (string) - Required - Embedding model
- **threshold** (number) - Required - Clustering threshold
- **min_cluster_size** (number) - Required - Minimum size for a cluster
- **title_model** (string) - Required - Model for generating titles
- **lang** (string) - Required - Language code
- **recursive** (boolean) - Optional - Whether to process recursively

### Response
#### Success Response (200)
- **job_id** (string) - The ID of the started job
```

--------------------------------

### Start Development Server

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/vue/README.md

Use this command to compile and run the project in development mode with hot-reloading enabled. This allows for quick feedback during development.

```sh
yarn dev
```

--------------------------------

### Start Clustering Job Request Body

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/references/api-reference.md

Start a background job for clustering image embeddings. Configure clustering parameters like threshold and model.

```json
{
  "folder": "/path/to/folder",
  "folder_paths": [],
  "model": "text-embedding-3-small",
  "threshold": 0.85,
  "min_cluster_size": 3,
  "title_model": "gpt-4o-mini",
  "lang": "en",
  "recursive": false
}
```

--------------------------------

### Clustering Job Start Response

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/references/api-reference.md

Response upon starting a clustering job, providing the job ID for status tracking.

```json
{ "job_id": "uuid-string" }
```

--------------------------------

### Pre-filled Keyword Search URL Example

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/docs/ai-agents.md

This URL allows for a keyword search with a pre-filled search term. The 'sunset' keyword is used as an example.

```url
?action=pane&type=fuzzy-search&props={"substr":"sunset"}
```

--------------------------------

### Folder Browse URL Example

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/docs/ai-agents.md

Browse a specific local folder using this URL. The 'props' parameter should contain the folder path.

```url
?action=pane&type=local&props=...
```

--------------------------------

### POST /infinite_image_browsing/db/cluster_iib_output_job_start

Source: https://context7.com/zanllp/infinite-image-browsing/llms.txt

Starts a background job to cluster images by semantic similarity.

```APIDOC
## POST /infinite_image_browsing/db/cluster_iib_output_job_start

### Description
Starts a background job to cluster images by semantic similarity of their prompts using AI embeddings.

### Method
POST

### Endpoint
/infinite_image_browsing/db/cluster_iib_output_job_start

### Request Body
- **folder_paths** (array) - Required - Paths to cluster
- **model** (string) - Optional - Embedding model

### Response Example
{"job_id": "cluster_job_123"}
```

--------------------------------

### GET /infinite_image_browsing/version

Source: https://context7.com/zanllp/infinite-image-browsing/llms.txt

Returns detailed version information about the application and its dependencies.

```APIDOC
## GET /infinite_image_browsing/version

### Description
Returns detailed version information about the application and its dependencies.

### Method
GET

### Endpoint
/infinite_image_browsing/version

### Response
#### Success Response (200)
- **python_version** (string) - The Python version used.
- **platform** (string) - The operating system platform.
- **hash** (string) - The git commit hash of the application.
- **tag** (string) - The application version tag.
- **pillow** (string) - The Pillow library version.
- **numpy** (string) - The NumPy library version.

#### Response Example
```json
{
  "python_version": "3.10.12",
  "platform": "Linux-5.15.0-x86_64",
  "hash": "abc123",
  "tag": "v1.2.0",
  "pillow": "10.0.0",
  "numpy": "1.24.0"
}
```
```

--------------------------------

### Image Search Results Example

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/SKILL.md

Example markdown for displaying image search results, including a summary, a link to the first image, and a link to all results. The search results page link includes URL-encoded parameters.

```markdown
Found 150+ images matching "sunset":

[View First Image](http://127.0.0.1:<port>/infinite_image_browsing?action=view&path=/first/image.png)

[View All Results in IIB](http://127.0.0.1:<port>/infinite_image_browsing?action=pane&type=fuzzy-search&props=%7B%22substr%22%3A%22sunset%22%7D)

| # | Name | Path | Size |
|---|------|------|------|
| 1 | image1.png | /folder | 1.2 MB |
| 2 | image2.png | /folder | 1.1 MB |
...
```

--------------------------------

### GET /infinite_image_browsing/global_setting

Source: https://context7.com/zanllp/infinite-image-browsing/llms.txt

Returns all global settings including SD-WebUI configuration paths, custom tags, extra paths, and frontend settings.

```APIDOC
## GET /infinite_image_browsing/global_setting

### Description
Returns all global settings, including SD-WebUI configuration paths, custom tags, extra paths, and frontend settings.

### Method
GET

### Endpoint
/infinite_image_browsing/global_setting

### Response
#### Success Response (200)
- **global_setting** (object) - Contains various global configuration settings.
- **cwd** (string) - The current working directory.
- **is_win** (boolean) - Indicates if the operating system is Windows.
- **home** (string) - The user's home directory path.
- **all_custom_tags** (array) - A list of all custom tags.
- **extra_paths** (array) - A list of extra configured paths.
- **enable_access_control** (boolean) - Whether access control is enabled.
- **launch_mode** (string) - The launch mode of the application (e.g., "standalone").
- **is_readonly** (boolean) - Indicates if the application is in read-only mode.

#### Response Example
```json
{
  "global_setting": {...},
  "cwd": "/app",
  "is_win": false,
  "home": "/home/user",
  "all_custom_tags": [...],
  "extra_paths": [...],
  "enable_access_control": false,
  "launch_mode": "standalone",
  "is_readonly": false
}
```
```

--------------------------------

### Start File Organization Job Request Body

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/references/api-reference.md

Initiate a file organization job. Specify source and destination folders, clustering parameters, and actions.

```json
{
  "folder_paths": ["/path/to/source"],
  "dest_folder": "/path/to/destination",
  "threshold": 0.90,
  "min_cluster_size": 2,
  "lang": "en",
  "recursive": false,
  "folder_naming": "title",
  "action": "move",
  "handle_noise": "unsorted",
  "noise_folder_name": "Unsorted"
}
```

--------------------------------

### GET /file

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/references/api-reference.md

Retrieve the original file.

```APIDOC
## GET /file

### Description
Get original file.

### Method
GET

### Endpoint
/infinite_image_browsing/file

### Parameters
#### Query Parameters
- **path** (string) - Required - File path
- **t** (string) - Optional - Timestamp
- **disposition** (string) - Optional - Download filename
```

--------------------------------

### GET /files

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/references/api-reference.md

List files and directories within a specified path.

```APIDOC
## GET /files

### Description
List directory files.

### Method
GET

### Endpoint
/infinite_image_browsing/files

### Parameters
#### Query Parameters
- **folder_path** (string) - Required - Directory path

### Response
#### Success Response (200)
- **files** (array) - List of file objects
```

--------------------------------

### GET /infinite_image_browsing/hello

Source: https://context7.com/zanllp/infinite-image-browsing/llms.txt

Simple health check endpoint to verify the service is running.

```APIDOC
## GET /infinite_image_browsing/hello

### Description
Provides a simple health check endpoint to verify if the service is running.

### Method
GET

### Endpoint
/infinite_image_browsing/hello

### Response
#### Success Response (200)
- **response** (string) - A simple string indicating the service is active, typically "hello".

#### Response Example
"hello"
```

--------------------------------

### Image Compare URL Example

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/docs/ai-agents.md

Use this URL to enable the side-by-side image comparison view. The 'props' parameter will contain image identifiers.

```url
?action=pane&type=img-sli&props=...
```

--------------------------------

### Start Smart File Organization Job

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/SKILL.md

Initiates an automatic image organization job. Specify source folders, destination, and action. Returns a job ID for status tracking. Replace `<port>` with the actual server port.

```bash
# Start organization job
curl -X POST http://127.0.0.1:<port>/infinite_image_browsing/db/organize_files_start \
  -H "Content-Type: application/json" \
  -d '{
    "folder_paths": ["/messy/folder"],
    "dest_folder": "/organized/folder",
    "threshold": 0.85,
    "lang": "en",
    "action": "move"
  }'
# Returns: {"job_id": "uuid"}

# Check status
curl "http://127.0.0.1:<port>/infinite_image_browsing/db/organize_files_status?job_id=<job_id>"

# Confirm and execute
curl -X POST http://127.0.0.1:<port>/infinite_image_browsing/db/organize_files_confirm \
  -H "Content-Type: application/json" \
  -d '{"job_id": "<job_id>"}'
```

--------------------------------

### GET /db/basic_info

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/references/api-reference.md

Retrieve basic database information.

```APIDOC
## GET /db/basic_info

### Description
Get database basic info.

### Method
GET

### Endpoint
/infinite_image_browsing/db/basic_info
```

--------------------------------

### GET /infinite_image_browsing/db/extra_paths

Source: https://context7.com/zanllp/infinite-image-browsing/llms.txt

Retrieves all configured extra paths.

```APIDOC
## GET /infinite_image_browsing/db/extra_paths

### Description
Returns all configured extra paths.

### Method
GET

### Endpoint
/infinite_image_browsing/db/extra_paths

### Response
#### Success Response (200)
- **path** (string) - The directory path
- **types** (array) - List of path types
- **alias** (string) - Display name for the path

### Response Example
[
  {"path": "/path/to/folder1", "types": ["scan"], "alias": "My Collection"},
  {"path": "/path/to/folder2", "types": ["scan", "walk"], "alias": ""}
]
```

--------------------------------

### Start Image Clustering Job

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/SKILL.md

Initiates an image clustering job based on semantic similarity. Specify source folders, similarity threshold, and minimum cluster size. Replace `<port>` with the actual server port.

```bash
curl -X POST http://127.0.0.1:<port>/infinite_image_browsing/db/cluster_iib_output_job_start \
  -H "Content-Type: application/json" \
  -d '{
    "folder_paths": ["/path/to/images"],
    "threshold": 0.85,
    "min_cluster_size": 3,
    "lang": "en",
    "recursive": true
  }'
```

--------------------------------

### Get Database Statistics

Source: https://context7.com/zanllp/infinite-image-browsing/llms.txt

Retrieves general database info including image counts and tag lists.

```bash
curl "http://127.0.0.1:7866/infinite_image_browsing/db/basic_info"
```

--------------------------------

### Get Video Cover

Source: https://context7.com/zanllp/infinite-image-browsing/llms.txt

Generates and returns a WebP thumbnail from the 16th frame of a video file. The thumbnail is cached for subsequent requests.

```bash
# Get video thumbnail
curl "http://127.0.0.1:7866/infinite_image_browsing/video_cover?path=/path/to/video.mp4&mt=1703980800"
```

--------------------------------

### Keyword Search URL Example

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/docs/ai-agents.md

Use this URL to access the keyword search page for filtering images.

```url
?action=pane&type=fuzzy-search
```

--------------------------------

### Random Images URL Example

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/docs/ai-agents.md

Display a selection of random images from your collection using this URL.

```url
?action=pane&type=random-image
```

--------------------------------

### GET /infinite_image_browsing

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/SKILL.md

The main entry point for navigating to specific application states, including searches, single image views, and comparisons, using URL-encoded JSON props.

```APIDOC
## GET /infinite_image_browsing

### Description
Constructs a shareable URL to open specific application views. The `props` parameter must be a URL-encoded JSON string.

### Method
GET

### Endpoint
/infinite_image_browsing

### Parameters
#### Query Parameters
- **action** (string) - Required - The action to perform (e.g., 'pane', 'view')
- **type** (string) - Optional - The type of pane to open (e.g., 'fuzzy-search', 'tag-search', 'img-sli')
- **path** (string) - Optional - File path for 'view' action
- **props** (string) - Optional - URL-encoded JSON object containing configuration for the action

### Request Example
?action=pane&type=fuzzy-search&props=%7B%22substr%22%3A%22sunset%22%7D

### Response
#### Success Response (200)
- **HTML/UI** - Returns the application interface rendered with the specified parameters.
```

--------------------------------

### Get Image Generation Info

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/SKILL.md

Retrieves generation parameters (prompt, seed, model, etc.) for a specific image. Replace `<port>` with the actual server port.

```bash
curl "http://127.0.0.1:<port>/infinite_image_browsing/image_geninfo?path=/path/to/image.png"
```

--------------------------------

### List Directory Files with IIB

Source: https://context7.com/zanllp/infinite-image-browsing/llms.txt

Retrieves all files and subdirectories in a specified folder path. Returns detailed metadata including file type, size, timestamps, and path information. Use this to get an overview of a directory's contents.

```bash
# List files in a directory
curl "http://127.0.0.1:7866/infinite_image_browsing/files?folder_path=/path/to/images"
```

```json
{
  "files": [
    {
      "type": "file",
      "date": 1703980800.0,
      "created_time": 1703980700.0,
      "size": "2.4 MB",
      "bytes": 2516582,
      "name": "sunset_landscape.png",
      "fullpath": "/path/to/images/sunset_landscape.png",
      "is_under_scanned_path": true
    },
    {
      "type": "dir",
      "date": 1703980500.0,
      "created_time": 1703980400.0,
      "size": "-",
      "name": "portraits",
      "fullpath": "/path/to/images/portraits",
      "is_under_scanned_path": true
    }
  ]
}
```

--------------------------------

### Get Original File

Source: https://context7.com/zanllp/infinite-image-browsing/llms.txt

Returns the original media file with caching headers. Allows specifying a custom filename for download.

```bash
# Get original image
curl "http://127.0.0.1:7866/infinite_image_browsing/file?path=/path/to/image.png&t=1703980800"
```

```bash
# Download with custom filename
curl "http://127.0.0.1:7866/infinite_image_browsing/file?path=/path/to/image.png&t=1703980800&disposition=my_download.png" -o my_download.png
```

--------------------------------

### Organize messy folder workflow

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/references/agent-patterns.md

Automated file organization process involving starting a job, polling for status, and confirming the final execution.

```bash
# 1. Start AI organization
curl -X POST http://127.0.0.1:<port>/infinite_image_browsing/db/organize_files_start \
  -H "Content-Type: application/json" \
  -d '{
    "folder_paths": ["/Downloads/ai-images"],
    "dest_folder": "/Pictures/organized",
    "threshold": 0.85,
    "lang": "en",
    "action": "move"
  }'
# Returns: {"job_id": "abc123"}

# 2. Poll for completion
curl "http://127.0.0.1:<port>/infinite_image_browsing/db/organize_files_status?job_id=abc123"
# Wait until status is "completed"

# 3. Confirm and execute
curl -X POST http://127.0.0.1:<port>/infinite_image_browsing/db/organize_files_confirm \
  -H "Content-Type: application/json" \
  -d '{"job_id": "abc123"}'
```

--------------------------------

### Tag Results URL Example

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/docs/ai-agents.md

This URL displays pre-filtered tag search results, showing images matched by specific tags. The 'props' parameter will contain tag details.

```url
?action=pane&type=tag-search-matched-image-grid&props=...
```

--------------------------------

### Initialize IIB Application

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/vue/usage.md

Wraps the application with IIB utilities using a specified base path.

```python
AppUtils(base = "/foo", export_fn_fe=True).wrap_app(app)
```

--------------------------------

### Retrieve Version Information

Source: https://context7.com/zanllp/infinite-image-browsing/llms.txt

Returns application and dependency version details.

```bash
curl "http://127.0.0.1:7866/infinite_image_browsing/version"

# Response:
{
  "python_version": "3.10.12",
  "platform": "Linux-5.15.0-x86_64",
  "hash": "abc123",
  "tag": "v1.2.0",
  "pillow": "10.0.0",
  "numpy": "1.24.0"
}
```

--------------------------------

### GET /image-thumbnail

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/references/api-reference.md

Retrieve an image thumbnail.

```APIDOC
## GET /image-thumbnail

### Description
Get image thumbnail.

### Method
GET

### Endpoint
/infinite_image_browsing/image-thumbnail

### Parameters
#### Query Parameters
- **path** (string) - Required - Image path
- **t** (string) - Optional - Timestamp
- **size** (string) - Optional - Thumbnail size (default 256x256)
```

--------------------------------

### Open File with Default App

Source: https://context7.com/zanllp/infinite-image-browsing/llms.txt

Opens the specified file using the system's default application.

```bash
curl -X POST "http://127.0.0.1:7866/infinite_image_browsing/open_with_default_app" \
  -H "Content-Type: application/json" \
  -d '{"path": "/path/to/image.png"}'
```

--------------------------------

### GET /infinite_image_browsing/db/cluster_iib_output_job_status

Source: https://context7.com/zanllp/infinite-image-browsing/llms.txt

Polls the clustering job status.

```APIDOC
## GET /infinite_image_browsing/db/cluster_iib_output_job_status

### Description
Polls the clustering job status until completion.

### Method
GET

### Endpoint
/infinite_image_browsing/db/cluster_iib_output_job_status

### Query Parameters
- **job_id** (string) - Required - The job ID

### Response Example
{
  "job_id": "cluster_job_123",
  "status": "done"
}
```

--------------------------------

### GET /infinite_image_browsing/db/organize_files_status

Source: https://context7.com/zanllp/infinite-image-browsing/llms.txt

Polls the status of an organization job.

```APIDOC
## GET /infinite_image_browsing/db/organize_files_status

### Description
Polls the organization job status.

### Method
GET

### Endpoint
/infinite_image_browsing/db/organize_files_status

### Query Parameters
- **job_id** (string) - Required - The ID of the job

### Response Example
{
  "job_id": "abc123def456",
  "status": "preview_ready"
}
```

--------------------------------

### GET /db/cluster_iib_output_job_status

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/references/api-reference.md

Queries the status of a clustering job.

```APIDOC
## GET /db/cluster_iib_output_job_status

### Description
Query clustering job status.

### Method
GET

### Endpoint
/db/cluster_iib_output_job_status

### Parameters
#### Query Parameters
- **job_id** (string) - Required - Job ID

### Response
#### Success Response (200)
- **job_id** (string) - Job ID
- **status** (string) - Current status (running|completed|failed)
- **progress** (number) - Progress percentage
- **result** (object) - Clustering results
```

--------------------------------

### List Registered Library Paths

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/SKILL.md

Lists all folders currently registered in the library. Replace `<port>` with the actual server port.

```bash
curl http://127.0.0.1:<port>/infinite_image_browsing/db/extra_paths
```

--------------------------------

### GET /image_exif

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/references/api-reference.md

Retrieve EXIF data for an image.

```APIDOC
## GET /image_exif

### Description
Get image EXIF data.

### Method
GET

### Endpoint
/infinite_image_browsing/image_exif

### Parameters
#### Query Parameters
- **path** (string) - Required - Image path
```

--------------------------------

### GET /image_geninfo

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/references/api-reference.md

Retrieve image generation information.

```APIDOC
## GET /image_geninfo

### Description
Get image generation info (SD prompt, etc.).

### Method
GET

### Endpoint
/infinite_image_browsing/image_geninfo

### Parameters
#### Query Parameters
- **path** (string) - Required - Image path
```

--------------------------------

### Build for Production

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/vue/README.md

This command compiles and minifies the project for production, preparing it for deployment. It generates optimized resources for the production environment.

```sh
yarn build
```

--------------------------------

### GET /video_cover

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/references/api-reference.md

Retrieve a video cover thumbnail.

```APIDOC
## GET /video_cover

### Description
Get video cover thumbnail.

### Method
GET

### Endpoint
/infinite_image_browsing/video_cover

### Parameters
#### Query Parameters
- **path** (string) - Required - Video path
- **mt** (string) - Optional - Modified time
```

--------------------------------

### POST /mkdirs

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/references/api-reference.md

Create a new directory.

```APIDOC
## POST /mkdirs

### Description
Create directory.

### Method
POST

### Endpoint
/infinite_image_browsing/mkdirs

### Parameters
#### Request Body
- **dest_folder** (string) - Required - Path of the new folder
```

--------------------------------

### Create Directory with IIB

Source: https://context7.com/zanllp/infinite-image-browsing/llms.txt

Creates a new directory at the specified path. The API will create any necessary parent directories if they do not exist.

```bash
# Create new folder
curl -X POST "http://127.0.0.1:7866/infinite_image_browsing/mkdirs" \
  -H "Content-Type: application/json" \
  -d '{"dest_folder": "/path/to/images/new_collection"}'
```

--------------------------------

### GET /db/img_selected_custom_tag

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/references/api-reference.md

Retrieve custom tags for a specific image.

```APIDOC
## GET /db/img_selected_custom_tag

### Description
Get image's custom tags.

### Method
GET

### Endpoint
/infinite_image_browsing/db/img_selected_custom_tag

### Parameters
#### Query Parameters
- **path** (string) - Required - Image path
```

--------------------------------

### POST /infinite_image_browsing/open_with_default_app

Source: https://context7.com/zanllp/infinite-image-browsing/llms.txt

Opens a file with the system's default application associated with its file type.

```APIDOC
## POST /infinite_image_browsing/open_with_default_app

### Description
Opens a file with the system's default application associated with its file type.

### Method
POST

### Endpoint
/infinite_image_browsing/open_with_default_app

### Parameters
#### Request Body
- **path** (string) - Required - The path to the file to open.

### Request Example
```json
{"path": "/path/to/image.png"}
```
```

--------------------------------

### GET /db/random_images

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/references/api-reference.md

Retrieve a list of 128 random images.

```APIDOC
## GET /db/random_images

### Description
Get random images (128 images).

### Method
GET

### Endpoint
/infinite_image_browsing/db/random_images
```

--------------------------------

### GET /infinite_image_browsing/image-thumbnail

Source: https://context7.com/zanllp/infinite-image-browsing/llms.txt

Retrieves a cached WebP thumbnail for a specified image.

```APIDOC
## GET /infinite_image_browsing/image-thumbnail

### Description
Returns a cached WebP thumbnail for an image. Thumbnails are generated on first request.

### Method
GET

### Endpoint
/infinite_image_browsing/image-thumbnail

### Parameters
#### Query Parameters
- **path** (string) - Required - Path to the image file
- **t** (integer) - Required - Timestamp for cache busting
- **size** (string) - Optional - Thumbnail dimensions (e.g., 512x512)
```

--------------------------------

### GET /stream_video

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/references/api-reference.md

Stream a video file with HTTP Range support.

```APIDOC
## GET /stream_video

### Description
Stream video with HTTP Range support.

### Method
GET

### Endpoint
/infinite_image_browsing/stream_video

### Parameters
#### Query Parameters
- **path** (string) - Required - Video path
```

--------------------------------

### List Scan Paths

Source: https://context7.com/zanllp/infinite-image-browsing/llms.txt

Returns all configured extra paths.

```bash
curl "http://127.0.0.1:7866/infinite_image_browsing/db/extra_paths"

# Response:
[
  {"path": "/path/to/folder1", "types": ["scan"], "alias": "My Collection"},
  {"path": "/path/to/folder2", "types": ["scan", "walk"], "alias": ""}
]
```

--------------------------------

### POST /infinite_image_browsing/zip

Source: https://context7.com/zanllp/infinite-image-browsing/llms.txt

Creates a ZIP archive from a list of file paths.

```APIDOC
## POST /infinite_image_browsing/zip

### Description
Creates a ZIP archive from a list of provided file paths.

### Method
POST

### Endpoint
/infinite_image_browsing/zip

### Request Body
- **paths** (array) - Required - List of file paths to include in the archive
- **compress** (boolean) - Optional - Whether to compress the files
- **pack_only** (boolean) - Optional - Whether to only pack files without compression

### Request Example
{
  "paths": ["/path/to/img1.png", "/path/to/img2.png"],
  "compress": true,
  "pack_only": false
}
```

--------------------------------

### AI Features - Image Clustering

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/SKILL.md

Endpoint for starting an image clustering job.

```APIDOC
## POST /infinite_image_browsing/db/cluster_iib_output_job_start

### Description
Starts a job to analyze images and group them by semantic similarity.

### Method
POST

### Endpoint
`/infinite_image_browsing/db/cluster_iib_output_job_start`

### Request Body
- **folder_paths** (array of strings) - Required - Paths to the folders containing images to cluster.
- **threshold** (number) - Optional - Similarity threshold for clustering (default: 0.85).
- **min_cluster_size** (integer) - Optional - Minimum number of images in a cluster (default: 3).
- **lang** (string) - Optional - Language for analysis (default: "en").
- **recursive** (boolean) - Optional - Whether to include subfolders (default: true).

### Request Example
{
  "folder_paths": ["/path/to/images"],
  "threshold": 0.85,
  "min_cluster_size": 3,
  "lang": "en",
  "recursive": true
}

### Response Example
(Response format not specified in source, assumed to be a job ID or status)
```

--------------------------------

### POST /infinite_image_browsing/mkdirs

Source: https://context7.com/zanllp/infinite-image-browsing/llms.txt

Creates a new directory at the specified path.

```APIDOC
## POST /infinite_image_browsing/mkdirs

### Description
Creates a new directory at the specified path, including any necessary parent directories.

### Method
POST

### Endpoint
/infinite_image_browsing/mkdirs

### Parameters
#### Request Body
- **dest_folder** (string) - Required - The path of the directory to create.

### Response
#### Success Response (200)
- Status code 200 indicates success.
```

--------------------------------

### Create Custom Tag

Source: https://context7.com/zanllp/infinite-image-browsing/llms.txt

Registers a new custom tag in the system.

```bash
curl -X POST "http://127.0.0.1:7866/infinite_image_browsing/db/add_custom_tag" \
  -H "Content-Type: application/json" \
  -d '{"tag_name": "favorites"}'
```

--------------------------------

### POST /zip

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/references/api-reference.md

Create a ZIP archive of specified files.

```APIDOC
## POST /zip

### Description
Create ZIP archive.

### Method
POST

### Endpoint
/infinite_image_browsing/zip

### Parameters
#### Request Body
- **paths** (array) - Required - List of files to archive
- **compress** (boolean) - Optional - Enable compression
- **pack_only** (boolean) - Optional - Pack only
```

--------------------------------

### Retrieve Image Tags

Source: https://context7.com/zanllp/infinite-image-browsing/llms.txt

Gets tags for a single image or a batch of images.

```bash
curl "http://127.0.0.1:7866/infinite_image_browsing/db/img_selected_custom_tag?path=/path/to/image.png"
```

```bash
curl -X POST "http://127.0.0.1:7866/infinite_image_browsing/db/get_image_tags" \
  -H "Content-Type: application/json" \
  -d '{"paths": ["/path/to/img1.png", "/path/to/img2.png"]}'
```

--------------------------------

### Search Result Format

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/SKILL.md

Example of the JSON response structure returned by search operations.

```json
{
  "files": [{"fullpath": "/path/to/image.png", "name": "image.png", "size": "1.2 MB", ...}],
  "cursor": {"has_next": true, "next": "cursor_string"}
}
```

--------------------------------

### Get Random Images

Source: https://context7.com/zanllp/infinite-image-browsing/llms.txt

Returns a random selection of indexed images for exploration purposes.

```APIDOC
## GET /infinite_image_browsing/db/random_images

### Description
Returns a random selection of indexed images for exploration.

### Method
GET

### Endpoint
/infinite_image_browsing/db/random_images

### Response
#### Success Response (200)
- Returns an array of random images.
```

--------------------------------

### Test IIB Service Connectivity

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/SKILL.md

Verify the service is running by sending a hello request to the base endpoint.

```bash
curl --noproxy "*" -s http://127.0.0.1:<PORT>/infinite_image_browsing/hello
# Returns: "hello" if service is running
```

--------------------------------

### Batch get image tags request

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/references/api-reference.md

Request body for the POST /db/get_image_tags endpoint.

```json
{ "paths": ["/path/to/img1.png"] }
```

--------------------------------

### Batch get generation info request

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/references/api-reference.md

Request body for the POST /image_geninfo_batch endpoint.

```json
{ "paths": ["/path/to/img1.png", "/path/to/img2.png"] }
```

--------------------------------

### Batch get file information request

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/references/api-reference.md

Request body for the POST /batch_get_files_info endpoint.

```json
{ "paths": ["/path/to/file1", "/path/to/file2"] }
```

--------------------------------

### POST /infinite_image_browsing/db/build_iib_output_embeddings

Source: https://context7.com/zanllp/infinite-image-browsing/llms.txt

Pre-builds embeddings for images in a folder (useful for preparing semantic search).

```APIDOC
## POST /infinite_image_browsing/db/build_iib_output_embeddings

### Description
Pre-builds embeddings for images in a folder, which is useful for preparing data for semantic search.

### Method
POST

### Endpoint
/infinite_image_browsing/db/build_iib_output_embeddings

### Parameters
#### Request Body
- **folder** (string) - Required - The path to the folder containing images for which to build embeddings.
- **model** (string) - Optional - The embedding model to use. Defaults to "text-embedding-3-small".
- **force** (boolean) - Optional - If true, forces re-embedding even if embeddings already exist. Defaults to false.
- **batch_size** (integer) - Optional - The number of images to process in each batch. Defaults to 100.
- **recursive** (boolean) - Optional - If true, recursively searches subfolders for images. Defaults to true.

### Request Example
```json
{
  "folder": "/path/to/images",
  "model": "text-embedding-3-small",
  "force": false,
  "batch_size": 100,
  "recursive": true
}
```
```

--------------------------------

### Create directory request

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/references/api-reference.md

Request body for the POST /mkdirs endpoint.

```json
{ "dest_folder": "/path/to/new/folder" }
```

--------------------------------

### Add new folder to library workflow

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/references/agent-patterns.md

Procedure for registering a new directory, triggering an index update, and verifying the contents.

```bash
# 1. Add path
curl -X POST http://127.0.0.1:<port>/infinite_image_browsing/db/extra_paths \
  -H "Content-Type: application/json" \
  -d '{"path": "/new/image/folder", "types": ["scanned"]}'

# 2. Trigger index update
curl -X POST http://127.0.0.1:<port>/infinite_image_browsing/db/update_image_data \
  -H "Content-Type: application/json" \
  -d '{"path": "/new/image/folder"}'

# 3. Verify images are indexed
curl -X POST http://127.0.0.1:<port>/infinite_image_browsing/db/search_by_substr \
  -H "Content-Type: application/json" \
  -d '{"surstr": "", "folder_paths": ["/new/image/folder"], "cursor": "", "size": 10}'
```

--------------------------------

### Load IIB Client Script

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/vue/usage.md

Fetches and executes the IIB index script with custom configuration replacements.

```javascript
const jscodeResp = await fetch("/file?path=/path/to/your/submodue-iib/index.js") // fake api
const jsText = await jscodeResp.text()
const js = jsText
  .replace("__iib_root_container__", "'#bar_iib_container'")
  .replace("__iib_should_maximize__", "false")
  .replace(/\/infinite_image_browsing/g, "/foo")
eval(js)
```

--------------------------------

### Python Standalone Usage

Source: https://context7.com/zanllp/infinite-image-browsing/llms.txt

Instructions for running IIB as a standalone Python application.

```APIDOC
## Python Standalone Usage

### Description
Instructions for running IIB as a standalone Python application without SD-WebUI.

### Starting the server
```bash
python app.py --port 7866
```

### With SD-WebUI config
To use SD-WebUI's configured paths:
```bash
python app.py --port 7866 --sd_webui_config=/path/to/config.json
```

### With extra image paths
To specify additional directories for image browsing:
```bash
python app.py --port 7866 --extra_paths /path/to/images1 /path/to/images2
```

### Pre-generating caches
To pre-generate image and video cover caches:
```bash
python app.py --port 7866 --generate_image_cache --generate_video_cover
```

### Environment variables for AI features
Set these variables to configure AI-related functionalities:
- **OPENAI_API_KEY**: Your OpenAI API key.
- **OPENAI_BASE_URL**: The base URL for the OpenAI-compatible API.
- **AI_MODEL**: The specific AI model to use (e.g., "gpt-4o-mini").

Example:
```bash
export OPENAI_API_KEY=sk-xxx
export OPENAI_BASE_URL=https://api.openai.com/v1
export AI_MODEL=gpt-4o-mini
python app.py
```
```

--------------------------------

### GET /infinite_image_browsing/files

Source: https://context7.com/zanllp/infinite-image-browsing/llms.txt

Retrieves a list of files and subdirectories within a specified folder path, including metadata.

```APIDOC
## GET /infinite_image_browsing/files

### Description
Retrieves all files and subdirectories in a specified folder path, returning detailed metadata including file type, size, timestamps, and path information.

### Method
GET

### Endpoint
/infinite_image_browsing/files

### Parameters
#### Query Parameters
- **folder_path** (string) - Required - The path of the directory to list.

### Response
#### Success Response (200)
- **files** (array) - List of file and directory objects.

#### Response Example
{
  "files": [
    {
      "type": "file",
      "date": 1703980800.0,
      "created_time": 1703980700.0,
      "size": "2.4 MB",
      "bytes": 2516582,
      "name": "sunset_landscape.png",
      "fullpath": "/path/to/images/sunset_landscape.png",
      "is_under_scanned_path": true
    }
  ]
}
```

--------------------------------

### Tag Search URL Example

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/docs/ai-agents.md

Access the tag search interface using this URL to filter images by their tags.

```url
?action=pane&type=tag-search
```

--------------------------------

### POST /infinite_image_browsing/db/organize_files_confirm

Source: https://context7.com/zanllp/infinite-image-browsing/llms.txt

Confirms and executes the organization job.

```APIDOC
## POST /infinite_image_browsing/db/organize_files_confirm

### Description
Confirms and executes the organization after reviewing the preview.

### Method
POST

### Endpoint
/infinite_image_browsing/db/organize_files_confirm

### Request Body
- **job_id** (string) - Required - The job ID
- **folder_edits** (array) - Optional - Modifications to folder names
- **skip_cluster_ids** (array) - Optional - Clusters to skip

### Response Example
{"ok": true, "job_id": "abc123def456"}
```

--------------------------------

### List Folder Contents

Source: https://github.com/zanllp/infinite-image-browsing/blob/main/skills/iib/SKILL.md

Use this endpoint to list the contents of a specified folder. Replace `<port>` with the actual server port.

```bash
curl "http://127.0.0.1:<port>/infinite_image_browsing/files?folder_path=/path/to/images"
```
Tokens:
Raw