Hydrus Network

https://hydrusnetwork.github.io/hydrus
Admin
Hydrus Network is a file-management application designed for users with large file collections,...
Tokens:99,431
Snippets:1,086
Trust Score:8.3
Update:3 months ago
Show doc for...
Tokens:
Raw
### Automated multi-version setup

Source: https://hydrusnetwork.github.io/hydrus/running_from_source.html

Example script for setting up multiple virtual environments using pyenv.

```bash
#!/bin/bash

pyenv shell 3.10
./setup_venv.py -v=~/hyvenvs/venv310 -i=s
pyenv shell 3.11
./setup_venv.py -v=~/hyvenvs/venv311 -i=s
pyenv shell 3.12
./setup_venv.py -v=~/hyvenvs/venv312 -i=a
pyenv shell 3.13
./setup_venv.py -v=~/hyvenvs/venv313 -i=a
pyenv shell 3.14
./setup_venv.py -v=~/hyvenvs/venv314 -i=a
```

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

### Install PyQt6

Source: https://hydrusnetwork.github.io/hydrus/running_from_source.html

Install PyQt6 and its charts module into the activated virtual environment.

```bash
python -m pip install pyqt6 pyqt6-charts
```

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

### Execute setup script

Source: https://hydrusnetwork.github.io/hydrus/running_from_source.html

Commands to run the setup script on Unix-like systems.

```bash
./setup_venv.py
```

```bash
python setup_venv.py
```

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

### Example Launch Command

Source: https://hydrusnetwork.github.io/hydrus/launch_arguments.html

A standard example of launching the client executable with database and temporary file arguments.

```bash
C:\Hydrus Network\hydrus_client.exe -d="E:\hydrus db" --no_db_temp_files
```

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

### Install MkDocs Material

Source: https://hydrusnetwork.github.io/hydrus/about_docs.html

Install the required documentation theme using pip.

```bash
pip install mkdocs-material
```

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

### Install Git on macOS

Source: https://hydrusnetwork.github.io/hydrus/running_from_source.html

Install git using Homebrew.

```bash
brew install git
```

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

### Install libmpv

Source: https://hydrusnetwork.github.io/hydrus/getting_started_installing.html

Commands to install the required mpv library for media playback.

```bash
sudo apt install libmpv1
```

```bash
sudo apt install libmpv2
```

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

### Install Dependencies

Source: https://hydrusnetwork.github.io/hydrus/running_from_source.html

Install project dependencies from the pyproject.toml file.

```bash
python -m pip install .
```

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

### Install libicu-dev dependency

Source: https://hydrusnetwork.github.io/hydrus/running_from_source.html

Install the libicu-dev package to resolve Qt6 dependency errors.

```bash
sudo apt install libicu-dev
```

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

### Install Python tools on Debian-based systems

Source: https://hydrusnetwork.github.io/hydrus/running_from_source.html

Install pip and venv packages using apt.

```bash
sudo apt install python3-pip
```

```bash
sudo apt install python3-venv
```

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

### Construct full GET request URL

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Example of a complete URL path for searching files with encoded parameters.

```text
/get_files/search_files?file_sort_type=6&file_sort_asc=false&tags=%5B%22character%3Aspace%20bounty%20hunter%22%2C%20%22creator%3A%5Cu9752%5Cu3044%5Cu685c%22%2C%20%22system%3Aheight%20%3E%202000%22%5D
```

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

### Install Git on Linux

Source: https://hydrusnetwork.github.io/hydrus/running_from_source.html

Commands to install Git using common package managers on Linux distributions.

```bash
sudo apt install git
```

```bash
sudo pacman -S git
```

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

### Get File Relationships Response

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Example JSON response mapping file hashes to their relationship data.

```json
{
    "file_relationships" : {
        "ac940bb9026c430ea9530b4f4f6980a12d9432c2af8d9d39dfc67b05d91df11d" : {
            "is_king" : false,
            "king" : "8784afbfd8b59de3dcf2c13dc1be9d7cb0b3d376803c8a7a8b710c7c191bb657",
            "king_is_on_file_domain" : true,
            "king_is_local" : true,
            "0" : [
            ],
            "1" : [],
            "3" : [
                "8bf267c4c021ae4fd7c4b90b0a381044539519f80d148359b0ce61ce1684fefe"
            ],
            "8" : [
                "8784afbfd8b59de3dcf2c13dc1be9d7cb0b3d376803c8a7a8b710c7c191bb657",
                "3fa8ef54811ec8c2d1892f4f08da01e7fc17eed863acae897eb30461b051d5c3"
            ]
        }
    }
}
```

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

### Install Linux Qt Dependencies

Source: https://hydrusnetwork.github.io/hydrus/getting_started_installing.html

Install required system packages for Qt6 compatibility on Debian-based distributions.

```shell
sudo apt install libicu-dev
```

```shell
sudo apt install libxcb-cursor-dev
```

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

### Install libxcb-cursor-dev dependency

Source: https://hydrusnetwork.github.io/hydrus/running_from_source.html

Install the libxcb-cursor-dev package to resolve Qt6 xcb platform plugin errors.

```bash
sudo apt install libxcb-cursor-dev
```

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

### Get File Relationships Request

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Example request for retrieving relationships for a specific file hash.

```http
/manage_file_relationships/get_file_relationships?hash=ac940bb9026c430ea9530b4f4f6980a12d9432c2af8d9d39dfc67b05d91df11d
```

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

### Get UI Page Structure Response

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Example JSON response for the /manage_pages/get_pages endpoint, detailing the hierarchy of the current UI session.

```json
{
  "pages" : {
    "name" : "top pages notebook",
    "page_key" : "3b28d8a59ec61834325eb6275d9df012860a1ecfd9e1246423059bc47fb6d5bd",
    "page_state" : 0,
    "page_type" : 10,
    "is_media_page" : false,
    "selected" : true,
    "pages" : [
      {
        "name" : "files",
        "page_key" : "d436ff5109215199913705eb9a7669d8a6b67c52e41c3b42904db083255ca84d",
        "page_state" : 0,
        "page_type" : 6,
        "is_media_page" : true,
        "selected" : false
      },
      {
        "name" : "thread watcher",
        "page_key" : "40887fa327edca01e1d69b533dddba4681b2c43e0b4ebee0576177852e8c32e7",
        "page_state" : 0,
        "page_type" : 9,
        "is_media_page" : true,
        "selected" : false
      },
      {
        "name" : "pages",
        "page_key" : "2ee7fa4058e1e23f2bd9e915cdf9347ae90902a8622d6559ba019a83a785c4dc",
        "page_state" : 0,
        "page_type" : 10,
        "is_media_page" : false,
        "selected" : true,
        "pages" : [
          {
            "name" : "urls",
            "page_key" : "9fe22cb760d9ee6de32575ed9f27b76b4c215179cf843d3f9044efeeca98411f",
        "page_state" : 0,
            "page_type" : 7,
            "is_media_page" : true,
            "selected" : true
          },
          {
            "name" : "files",
            "page_key" : "2977d57fc9c588be783727bcd54225d577b44e8aa2f91e365a3eb3c3f580dc4e",
            "page_state" : 0,
            "page_type" : 6,
            "is_media_page" : true,
            "selected" : false
          }
        ]
      }
    ]
  }
}
```

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

### Advanced setup options

Source: https://hydrusnetwork.github.io/hydrus/running_from_source.html

Commands for custom Python paths, virtual environment destinations, and non-interactive automation.

```bash
/path/to/my/python setup_venv.py
```

```bash
/path/to/my/314/python setup_venv.py -v=venv314
```

```bash
/path/to/my/python setup_venv.py -i=a
```

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

### GET /client_info

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Retrieves current boot and status information for the client.

```APIDOC
## GET /client_info

### Description
Ask the client about its current boot and status.

### Method
GET

### Endpoint
/client_info

### Response
#### Success Response (200)
- **boot_id** (string) - Random hex string generated on start
- **boot_time** (float) - Timestamp of when the controller started
- **currently_idle** (bool) - Whether the API is currently idle

#### Response Example
{
    "boot_id": "df59ca0100536e89afbbc8d66ac382464a3119013f0b96c90848a48de545117f",
    "boot_time": 1779118174.24,
    "currently_idle": false
}
```

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

### Set file permissions

Source: https://hydrusnetwork.github.io/hydrus/running_from_source.html

Grant execution permissions to the setup script.

```bash
chmod +x setup_venv.py
```

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

### Run Live Preview Server

Source: https://hydrusnetwork.github.io/hydrus/about_docs.html

Start a local development server that automatically rebuilds and reloads when files are modified.

```bash
mkdocs serve
```

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

### Launch Hydrus Client

Source: https://hydrusnetwork.github.io/hydrus/running_from_source.html

Standard commands to activate the virtual environment and start the client.

```bash
source venv/bin/activate
python hydrus_client.py
```

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

### Default Temporary Directory Paths

Source: https://hydrusnetwork.github.io/hydrus/launch_arguments.html

Examples of default system temporary directory paths.

```text
C:\Users\You\AppData\Local\Temp
/tmp
```

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

### POST /edit_times/set_time Response Example

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Example JSON response structure for the set_time endpoint.

```json
{
  "notes" : {
    "note name" : "content of note",
    "another note (1)" : "asdf"
  }
}
```

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

### Install build dependencies for pyenv

Source: https://hydrusnetwork.github.io/hydrus/running_from_source.html

Install necessary system libraries to compile Python versions via pyenv.

```bash
sudo apt update
```

```bash
sudo apt install build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev curl git libncursesw5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev
```

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

### Get Client Info

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Retrieves the current boot status and idle state of the client.

```json
{
    "boot_id": "df59ca0100536e89afbbc8d66ac382464a3119013f0b96c90848a48de545117f",
    "boot_time": 1779118174.24,
    "currently_idle": false
}
```

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

### Create a new page of pages

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Example request body for creating a sub-notebook page.

```json
{
  "page_type" : 10,
  "page_name" : "my sub-notebook",
  "focus_page" : false
}
```

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

### Install Hydrus via Winget

Source: https://hydrusnetwork.github.io/hydrus/getting_started_installing.html

Use the Windows Package Manager to install Hydrus Network to a specific directory.

```shell
winget install --id=HydrusNetwork.HydrusNetwork  -e --location "\PATH\TO\INSTALL\HERE"
```

```shell
winget install --id=HydrusNetwork.HydrusNetwork  -e --location "."
```

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

### Missing file_id response example

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Example of the JSON response structure when querying a hash that the client has not previously encountered.

```json
{
    "metadata" : [
        {
            "file_id" : null,
            "hash" : "766da61f81323629f982bc1b71b5c1f9bba3f3ed61caf99906f7f26881c3ae93"
        }
    ]
}
```

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

### Ancestor Traversal Example

Source: https://hydrusnetwork.github.io/hydrus/downloader_parsers_formulae.html

Example showing a structure where finding the parent element requires walking up the tree from a child node.

```html
<span>
  <a href="(link to post url)">
    <img class="thumb" src="(thumbnail image)" />
  </a>
</span>
```

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

### Update Source Repository

Source: https://hydrusnetwork.github.io/hydrus/getting_started_installing.html

Standard command for updating a source-based installation.

```bash
git pull
```

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

### Verify Python Installation

Source: https://hydrusnetwork.github.io/hydrus/running_from_source.html

Check if Python is installed and accessible in the current terminal environment.

```bash
python --version
```

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

### Verify Git Installation

Source: https://hydrusnetwork.github.io/hydrus/running_from_source.html

Check if the git command is available in the terminal.

```bash
git --version
```

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

### Configure Wine for ToDoList

Source: https://hydrusnetwork.github.io/hydrus/getting_started_installing.html

Commands to set up a dedicated Wine prefix and install necessary dependencies for running ToDoList on Linux.

```bash
wine winecfg
```

```bash
WINEPREFIX=/home/you/.local/share/wineprefixes/wine_todo/ winecfg
```

```bash
WINEPREFIX=/home/you/.local/share/wineprefixes/wine_todo/ winetricks mfc42
```

```bash
WINEPREFIX=/home/you/.local/share/wineprefixes/wine_todo/ winetricks mfc140
```

```bash
WINEPREFIX=/home/you/.local/share/wineprefixes/wine_todo/ winetricks dotnet48
```

```bash
WINEPREFIX=/home/you/.local/share/wineprefixes/wine_todo/ wine /home/you/.local/share/wineprefixes/wine_todo/drive_c/todolist/ToDoList.exe
```

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

### Refresh Virtual Environment

Source: https://hydrusnetwork.github.io/hydrus/getting_started_installing.html

Re-run the setup script to ensure dependencies like OpenCV are updated for the current version.

```bash
setup_venv
```

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

### POST /add_notes/delete_notes Request Body Example

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Example JSON request body for deleting specific notes from a file using its hash.

```json
{
  "note_names" : ["note name", "another note"],
  "hash" : "3b820114f658d768550e4e3d4f1dced3ff8db77443472b5ad93700647ad2d3ba"
}
```

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

### Response for new page creation

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Example JSON response containing the details of the newly created page.

```json
{
  "page_key" : "af98318b6eece15fef3cf0378385ce759bfe056916f6e12157cd928eb56c1f18",
  "page_type" : 6,
  "page_name" : "my search"
}
```

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

### GET /get_services

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Retrieves a list of the client's services.

```APIDOC
## GET /get_services

### Description
Ask the client about its services.

### Method
GET

### Endpoint
/get_services

### Response
#### Success Response (200)
- **services** (object) - The Services Object containing client service information.

#### Response Example
{
  "services" : "The Services Object"
}
```

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

### Search Predicate Syntax Example

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Demonstrates the structure for tag-based searches, including nested lists for OR logic and system predicates.

```json
[ "skirt", [ "space bounty hunter", "jane raider" ], "system:height > 1000" ]
```

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

### Provide access key via GET URL parameter

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Include the access key directly in the URL query string for GET requests.

```http
/get_files/thumbnail?file_id=452158&Hydrus-Client-API-Access-Key=0150d9c4f6a6d2082534a997f4588dcf0c56dffe1d03ffbf98472236112236ae
```

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

### Create a new hard drive import page

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Example request body for creating a hard drive import page with a specified path.

```json
{
  "page_type" : 3,
  "page_name" : "my import",
  "paths" : ["E:\\to_import"],
  "delete_after_success" : true,
  "focus_page" : false
}
```

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

### HTML Tag Instance Selection

Source: https://hydrusnetwork.github.io/hydrus/downloader_parsers_formulae.html

Example demonstrating how to target a specific instance of a tag when multiple identical tags exist.

```html
<span class="generaltag">
  <a href="(add tag)">+</a>
  <a href="(remove tag)">-</a>
  <a href="(search page)">blonde hair</a> (3456)
</span>
```

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

### Clean Tags Request

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Example of a percent-encoded GET request to clean a list of tags.

```http
/add_tags/clean_tags?tags=%5B%22%20bikini%20%22%2C%20%22blue%20%20%20%20eyes%22%2C%20%22%20character%20%3A%20space%20bounty%20hunter%20%22%2C%20%22%3A%29%22%2C%20%22%20%20%20%22%2C%20%22%22%2C%20%2210%22%2C%20%2211%22%2C%20%229%22%2C%20%22system%3Awew%22%2C%20%22-flower%22%5D
```

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

### GET /get_service

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Retrieves information about a specific service by name or key.

```APIDOC
## GET /get_service

### Description
Ask the client about a specific service.

### Method
GET

### Endpoint
/get_service

### Parameters
#### Query Parameters
- **service_name** (string) - Optional - The name of the service
- **service_key** (string) - Optional - The service key of the service

### Response
#### Success Response (200)
- **service** (object) - Object containing service details

#### Response Example
{
  "service" : {
    "name" : "my tags",
    "service_key" : "6c6f63616c2074616773",
    "type" : 5,
    "type_pretty" : "local tag domain"
  }
}
```

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

### Build Documentation

Source: https://hydrusnetwork.github.io/hydrus/about_docs.html

Generate the static HTML files in the help directory using the offline configuration.

```bash
mkdocs build -d help -f mkdocs-offline.yml
```

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

### Database Directory Argument

Source: https://hydrusnetwork.github.io/hydrus/launch_arguments.html

Example of specifying a custom database directory path containing spaces using quotes.

```bash
-d="E:\my hydrus\hydrus db"
```

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

### Debug libmpv Loading Error

Source: https://hydrusnetwork.github.io/hydrus/getting_started_installing.html

Example of an OSError traceback when the application fails to load the libmpv library.

```text
OSError: /lib/x86_64-linux-gnu/libgio-2.0.so.0: undefined symbol: g_module_open_full
(traceback)
pyimod04_ctypes.install.<locals>.PyInstallerImportError: Failed to load dynlib/dll 'libmpv.so.1'. Most likely this dynlib/dll was not found when the application was frozen.
```

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

### Set File Notes

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Example request body for adding or updating notes associated with a file using its hash.

```json
{
  "notes" : {
      "note name" : "content of note",
      "another note" : "asdf"
  },
  "hash" : "3b820114f658d768550e4e3d4f1dced3ff8db77443472b5ad93700647ad2d3ba"
}
```

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

### Get Potential Duplicate Count Request

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Example request for the /manage_file_relationships/get_potentials_count endpoint using URL-encoded JSON arguments.

```http
/manage_file_relationships/get_potentials_count?tag_service_key_1=c1ba23c60cda1051349647a151321d43ef5894aacdfb4b4e333d6c4259d56c5f&tags_1=%5B%22dupes_to_process%22%2C%20%22system%3Awidth%3C400%22%5D&potentials_search_type=1&pixel_duplicates=2&max_hamming_distance=0&max_num_pairs=50
```

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

### Lookup File Hashes

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Example request and response for converting between different hash types like MD5 and SHA256.

```http
/get_files/file_hashes?hash=ec5c5a4d7da4be154597e283f0b6663c&source_hash_type=md5&desired_hash_type=sha256
```

```json
{
  "hashes" : {
    "ec5c5a4d7da4be154597e283f0b6663c" : "2a0174970defa6f147f2eabba829c5b05aba1f1aea8b978611a07b7bb9cf9399"
  }
}
```

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

### Create a new URL downloader page

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Example request body for creating a URL downloader page with initial seed URLs.

```json
{
  "page_type" : 7,
  "page_name" : "my urls",
  "urls" : ["https://example.com/image1.png", "https://example.com/image2.png"],
  "focus_page" : false
}
```

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

### Create a new file search page

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Example request body for creating a file search page with specific tags and service keys.

```json
{
  "page_type" : 6,
  "page_name" : "my search",
  "tags" : ["blue eyes", "blonde hair"],
  "file_service_key" : "6c6f63616c2066696c6573",
  "tag_service_key" : "6c6f63616c2074616773",
  "focus_page" : true
}
```

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

### Request Page Information

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Example request to retrieve information about a specific page using its page_key.

```http
/manage_pages/get_page_info?page_key=aebbf4b594e6986bddf1eeb0b5846a1e6bc4e07088e517aff166f1aeb1c3c9da&simple=true
```

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

### Retrieve URL Information

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Example JSON response from the /add_urls/get_url_info endpoint describing how the client interprets a specific URL.

```json
{
  "request_url" : "https://someimageboard.org/cool/thread/123456.json",
  "normalised_url" : "https://someimageboard.org/cool/thread/123456",
  "url_type" : 4,
  "url_type_string" : "watchable url",
  "match_name" : "Some Imageboard thread",
  "can_parse" : true
}
```

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

### Perform Sequential Version Updates

Source: https://hydrusnetwork.github.io/hydrus/running_from_source.html

Example workflow for upgrading through multiple versions by checking out specific tags and launching the client to trigger database migrations.

```bash
MAKE A BACKUP
git checkout v558
./hydrus_client.sh
(wait for it to boot and update, close it down)
git checkout v571
./hydrus_client.sh
(wait for it to boot and update, close it down)
git checkout v603
./hydrus_client.sh
(wait for it to boot and update, close it down)
git checkout v652
./hydrus_client.sh
(wait for it to boot and update, close it down)
git checkout v662
./hydrus_client.sh
(have fun)
```

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

### Query URL information via GET

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Requests metadata information for a given URL.

```text
/add_urls/get_url_info?url=https%3A%2F%2Fsomeimageboard.org%2Fcool%2Fthread%2F123456%2Frobots
```

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

### POST /manage_services/commit_pending

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Starts the job to upload a service's pending content.

```APIDOC
## POST /manage_services/commit_pending

### Description
Starts the job to upload a service's pending content, similar to clicking 'commit' in the GUI menu.

### Method
POST

### Endpoint
/manage_services/commit_pending

### Parameters
#### Request Body
- **service_key** (string) - Required - The service key to commit.

### Request Example
{
    "service_key" : "ae91919b0ea95c9e636f877f57a69728403b65098238c1a121e5ebf85df3b87e"
}
```

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

### Initialize Virtual Environment

Source: https://hydrusnetwork.github.io/hydrus/running_from_source.html

Commands to set up and activate a Python virtual environment for dependency isolation.

```bash
python3 -m pip install virtualenv
python3 -m venv venv
source venv/bin/activate
```

```batch
CALL venv\Scripts\activate.bat
```

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

### Example Import Response

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

The JSON response returned after a file import request, indicating status and file hash.

```json
{
  "status" : 1,
  "hash" : "29a15ad0c035c0a0e86e2591660207db64b10777ced76565a695102a481c3dd1",
  "note" : ""
}
```

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

### Example .txt sidecar file content

Source: https://hydrusnetwork.github.io/hydrus/advanced_sidecars.html

A simple newline-separated text file containing tags for a corresponding image file.

```text
flowers
landscape
blue sky
```

```text
fast car
anime girl
night sky
```

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

### POST /add_files/delete_files Request Body

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Example JSON body for requesting a file deletion.

```json
{
  "hash" : "78f92ba4a786225ee2a1236efa6b7dc81dd729faf4af99f96f3e20bad6d8b538"
}
```

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

### Zipper Formula Substitution Example

Source: https://hydrusnetwork.github.io/hydrus/downloader_parsers_formulae.html

Demonstrates how the Zipper formula combines results from multiple parsers using a substitution phrase.

```text
If parser 1 gives:
  a
  b
  c

And parser 2 gives:
  1
  2
  3

Using a substitution phrase of "\1-\2" will give:
  a-1
  b-2
  c-3
```

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

### Create a new thread watcher page

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Example request body for creating a thread watcher page for a specific URL.

```json
{
  "page_type" : 9,
  "page_name" : "my watcher",
  "url" : "https://example.com/gallery/page/1",
  "focus_page" : false
}
```

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

### GET /manage_database/get_client_options

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Retrieves the current client options. Note that this response is unstable and subject to change.

```APIDOC
## GET /manage_database/get_client_options

### Description
Gets the current options from the client. This response is unstable and subject to change without warning.

### Method
GET

### Endpoint
/manage_database/get_client_options

### Parameters
- **Restricted access**: Yes (Manage Database permission required)

### Response
#### Success Response (200)
- **Response**: A JSON dump of client options based on internal structures.
```

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

### Request a file by ID or hash

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Examples of requesting a file using either a numerical file_id or a SHA256 hash.

```text
/get_files/file?file_id=452158
```

```text
/get_files/file?hash=7f30c113810985b69014957c93bc25e8eb4cf3355dae36d8b9d011d8b0cf623a&download=true
```

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

### Query URL files via GET

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Retrieves file mappings associated with a specific URL.

```text
/add_urls/get_url_files?url=http%3A%2F%2Fsomebooru.org%2Findex.php%3Fpage%3Dpost%26s%3Dview%26id%3D2753608
```

```json
{
  "normalised_url" : "https://somebooru.org/index.php?id=123456&page=post&s=view",
  "url_file_statuses" : [
    {
      "status" : 2,
      "hash" : "529af82eee3660008a51823ee4ca0c40d1b4d59b6e2f7418e8b23f2d9c01b1fb",
      "note" : "url recognised: Imported at 2015/10/18 10:58:01, which was 3 years 4 months ago (before this check)."
    }
  ]
}
```

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

### Configure Virtual Environment for System Qt

Source: https://hydrusnetwork.github.io/hydrus/running_from_source.html

Use this command to create a virtual environment that includes system-site-packages, which may be necessary to resolve Qt style visibility issues.

```bash
python -m venv venv --system-site-packages
```

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

### Create and Enable Swap File

Source: https://hydrusnetwork.github.io/hydrus/Fixing_Hydrus_Random_Crashes_Under_Linux.html

Commands to allocate, secure, and initialize a new swap file.

```bash
sudo fallocate -l 16G /swapfile #make 16GiB of swap
sudo chmod 600 /swapfile
sudo mkswap /swapfile
```

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

### Page Information Response

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Example JSON response for a page information request with simple set to true.

```json
{
  "page_info" : {
    "name" : "threads",
    "page_key" : "aebbf4b594e6986bddf1eeb0b5846a1e6bc4e07088e517aff166f1aeb1c3c9da",
    "page_state" : 0,
    "page_type" : 3,
    "is_media_page" : true,
    "management" : {
      "multiple_watcher_import" : {
        "watcher_imports" : [
          {
            "url" : "https://someimageboard.net/m/123456",
            "watcher_key" : "cf8c3525c57a46b0e5c2625812964364a2e801f8c49841c216b8f8d7a4d06d85",
            "created" : 1566164269,
            "last_check_time" : 1566164272,
            "next_check_time" : 1566174272,
            "files_paused" : false,
            "checking_paused" : false,
            "checking_status" : 0,
            "subject" : "gundam pictures",
            "imports" : {
              "status" : "4 successful (2 already in db)",
              "simple_status" : "4",
              "total_processed" : 4,
              "total_to_process" : 4
            },
            "gallery_log" : {
              "status" : "1 successful",
              "simple_status" : "1",
              "total_processed" : 1,
              "total_to_process" : 1
            }
          },
          {
            "url" : "https://someimageboard.net/a/1234",
            "watcher_key" : "6bc17555b76da5bde2dcceedc382cf7d23281aee6477c41b643cd144ec168510",
            "created" : 1566063125,
            "last_check_time" : 1566063133,
            "next_check_time" : 1566104272,
            "files_paused" : false,
            "checking_paused" : true,
            "checking_status" : 1,
            "subject" : "anime pictures",
            "imports" : {
              "status" : "124 successful (22 already in db), 2 previously deleted",
              "simple_status" : "124",
              "total_processed" : 124,
              "total_to_process" : 124
            },
            "gallery_log" : {
              "status" : "3 successful",
              "simple_status" : "3",
              "total_processed" : 3,
              "total_to_process" : 3
            }
          }
        ]
      },
      "highlight" : "cf8c3525c57a46b0e5c2625812964364a2e801f8c49841c216b8f8d7a4d06d85"
    }
  },
  "media" : {
    "num_files" : 4,
    "hash_ids" : [ 12345, 12346, 88754, 23 ]
  }
}
```

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

### GET /verify_access_key

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Validates the provided access or session key and returns permission information.

```APIDOC
## GET /verify_access_key

### Description
Check your access key is valid. Returns basic permission info if valid.

### Method
GET

### Endpoint
/verify_access_key

### Response
#### Success Response (200)
- **name** (string) - Name of the access
- **permits_everything** (bool) - Whether all permissions are granted
- **basic_permissions** (list) - List of granted permission IDs
- **human_description** (string) - Human readable description of permissions

#### Response Example
{
  "name" : "autotagger",
  "permits_everything" : false,
  "basic_permissions" : [0, 1, 3],
  "human_description" : "API Permissions (autotagger): add tags to files, import files, search for files: Can search: only autotag this"
}
```

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

### Node Content Extraction

Source: https://hydrusnetwork.github.io/hydrus/downloader_parsers_formulae.html

Example demonstrating different ways to extract data from a specific HTML node.

```html
<a href="(URL A)" class="thumb_title">Forest Glade</a>
```

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

### HTML Document Structure Example

Source: https://hydrusnetwork.github.io/hydrus/downloader_parsers_formulae.html

A sample HTML structure containing various tag types used to demonstrate parsing rules.

```html
<html>
  <body>
    <div class="media_taglist">
      <span class="generaltag"><a href="(search page)">blonde hair</a> (3456)</span>
      <span class="generaltag"><a href="(search page)">blue eyes</a> (4567)</span>
      <span class="generaltag"><a href="(search page)">skirt</a> (5678)</span>
      <span class="charactertag"><a href="(search page)">cool lady</a> (2345)</span>
      <span class="artisttag"><a href="(search page)">cool artist</a> (123)</span>
    </div>
    <div class="content">
      <span class="media">(a whole bunch of content that doesn't have any tag data)</span>
    </div>
  </body>
</html>
```

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

### Example JSON Export Structure

Source: https://hydrusnetwork.github.io/hydrus/advanced_sidecars.html

A basic JSON structure showing metadata URLs exported from Hydrus.

```json
{
    "metadata" : {
        "urls" : [
            "http://example.com/123456",
            "https://site.org/post/45678"
        ]
    }
}
```

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

### Set File Timestamps

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Examples of request bodies for setting or deleting file timestamps using different parameters.

```json
{
  "file_id" : 123456,
  "timestamp" : "1641044491",
  "timestamp_type" : 5
}
```

```json
{
  "file_id" : 123456,
  "timestamp" : "1641044491.458",
  "timestamp_type" : 6,
  "canvas_type" : 1
}
```

```json
{
  "file_id" : 123456,
  "timestamp_ms" : null,
  "timestamp_type" : 0,
  "domain" : "blahbooru.org"
}
```

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

### Example header response

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

The JSON structure returned by the get_headers endpoint, detailing the network context and header values.

```json
{
  "network_context" : {
    "type" : 2,
    "data" : "somebooru.org"
  },
  "headers" : {
    "User-Agent" : {
      "value" : "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:56.0) Gecko/20100101 Firefox/56.0",
      "approved" : "approved",
      "reason" : "Set by Client API"
    },
    "DNT" : {
      "value" : "1",
      "approved" : "approved",
      "reason" : "Set by Client API"
    }
  }
}
```

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

### GET /request_new_permissions

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Registers a new external program with the client. Requires the 'add from api request' dialog to be open in the client UI.

```APIDOC
## GET /request_new_permissions

### Description
Registers a new external program with the client. This requires the 'add from api request' mini-dialog under services->review services to be open, otherwise it will 403.

### Method
GET

### Endpoint
/request_new_permissions

### Parameters
#### Query Parameters
- **name** (string) - Required - Descriptive name of your access
- **permits_everything** (bool) - Optional - Whether to permit all tasks now and in future
- **basic_permissions** (list) - Optional - JSON-encoded list of numerical permission identifiers

### Response
#### Success Response (200)
- **access_key** (string) - 64 characters of hex access key

#### Response Example
{
    "access_key" : "73c9ab12751dcf3368f028d3abbe1d8e2a3a48d0de25e64f3a8f00f3a1424c57"
}
```

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

### Retrieve File Metadata

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Examples for fetching file metadata using file IDs or hashes, with options to filter the returned information.

```http
/get_files/file_metadata?file_ids=%5B123%2C%204567%5D
```

```http
/get_files/file_metadata?file_ids=%5B123%2C%204567%5D&only_return_identifiers=true
```

```http
/get_files/file_metadata?hashes=%5B%224c77267f93415de0bc33b7725b8c331a809a924084bee03ab2f5fae1c6019eb2%22%2C%20%223e7cb9044fe81bda0d7a84b5cb781cba4e255e4871cba6ae8ecd8207850d5b82%22%5D
```

```json
{
  "services" : "The Services Object",
  "metadata" : [
    {
      "file_id" : 123,
      "hash" : "4c77267f93415de0bc33b7725b8c331a809a924084bee03ab2f5fae1c6019eb2",
      "size" : 63405,
      "mime" : "image/jpeg",
      "filetype_forced" : false,
      "filetype_human" : "jpeg",
      "filetype_enum" : 1,
      "ext" : ".jpg",
      "width" : 640,
      "height" : 480,
      "thumbnail_width" : 200,
      "thumbnail_height" : 150,
      "duration" : null,
      "time_modified" : null,
      "time_modified_details" : {},
      "file_services" : {
        "current" : {},
        "deleted" : {}
      },
      "ipfs_multihashes" : {},
      "has_audio" : false,
      "blurhash" : "U6PZfSi_.AyE_3t7t7R**0o#DgR4_3R*D%xt",
      "pixel_hash" : "2519e40f8105599fcb26187d39656b1b46f651786d0e32fff2dc5a9bc277b5bb",
      "num_frames" : null,
      "num_words" : null,
      "is_inbox" : false,
      "is_local" : false,
      "is_trashed" : false
```

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

### Encode CBOR for GET requests

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Encodes parameters for GET requests using base64 URL-safe encoding.

```python
base64.urlsafe_b64encode( cbor2.dumps( argument ) )
```

```python
str( base64.urlsafe_b64encode( cbor2.dumps( argument ) ), 'ascii' )
```

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

### GET /get_files/file_path Response

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

The JSON response containing the local system path, file type, and size.

```json
{
    "path" : "D:\hydrus_files\f7f\7f30c113810985b69014957c93bc25e8eb4cf3355dae36d8b9d011d8b0cf623a.jpg",
    "filetype" : "image/jpeg",
    "size" : 95237
}
```

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

### Get Client Services

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Retrieves a list of services configured in the client. Note that the response may contain legacy data fields.

```json
{
  "services" : "The Services Object"
}
```

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

### Request a thumbnail by ID or hash

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Examples of requesting a file thumbnail using either a numerical file_id or a SHA256 hash.

```text
/get_files/thumbnail?file_id=452158
```

```text
/get_files/thumbnail?hash=7f30c113810985b69014957c93bc25e8eb4cf3355dae36d8b9d011d8b0cf623a
```

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

### Checkout Specific Version

Source: https://hydrusnetwork.github.io/hydrus/running_from_source.html

Switch the local repository to a specific release tag.

```bash
git checkout v615
```

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

### Search Response Formats

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Examples of the JSON response structure for file searches, including the default file ID list and the hash-enabled response.

```json
{
    "file_ids" : [125462, 4852415, 123, 591415]
}
```

```json
{
  "hashes" : [
    "1b04c4df7accd5a61c5d02b36658295686b0abfebdc863110e7d7249bba3f9ad",
    "fe416723c731d679aa4d20e9fd36727f4a38cd0ac6d035431f0f452fad54563f",
    "b53505929c502848375fbc4dab2f40ad4ae649d34ef72802319a348f81b52bad"
  ],
  "file_ids" : [125462, 4852415, 123]
}
```

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

### Format tag list for GET requests

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Demonstrates the transformation of a tag list into a URL-encoded string for API GET parameters.

```text
[ 'character:space bounty hunter', 'creator:青い桜', 'system:height > 2000' ]
```

```json
["character:space bounty hunter", "creator:\u9752\u3044\u685c", "system:height > 2000"]
```

```text
%5B%22character%3Aspace%20bounty%20hunter%22%2C%20%22creator%3A%5Cu9752%5Cu3044%5Cu685c%22%2C%20%22system%3Aheight%20%3E%202000%22%5D
```

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

### Get Media Viewers Information

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Retrieves a list of currently open media viewer windows and their associated media metadata.

```json
{
    "media_viewers": [
        {
            "canvas_type": 0,
            "canvas_key": "f0bfad96c34f91d457f32baa30592957873ece1f3f6639458d52bf72a8fe0868",
            "current_media": {
                "file_id": 2732536,
                "hash": "8d1c40c73d6f6bf0c33fe010d28c9eacdb4c010bfac1eebe8303810e5abc226d",
                "size": 645363,
                "mime": "image/jpeg",
                "filetype_human": "jpeg",
                "filetype_enum": 1,
                "ext": ".jpg",
                "width": 2000,
                "height": 2000,
                "duration": null,
                "num_frames": null,
                "num_words": null,
                "has_audio": false,
                "blurhash": "UCL.@[}N8zKr*^7|B4I0}?G09G-mKgVr+~os",
                "pixel_hash": "886e4f0102efde11cc0307bb431eb2c628c327485e61c9ce2b0ee5180238cd67",
                "filetype_forced": false,
                "thumbnail_width": 119,
                "thumbnail_height": 120,
                "notes": {},
                "file_services": {
                    "current": {
                        "6c6f63616c2066696c6573": {
                            "name": "muh files",
                            "type": 2,
                            "type_pretty": "local file domain",
                            "time_imported": 1768168342.422
                        }
```

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

### GET /get_services

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Retrieves a list of all services currently configured in the Hydrus client, including their keys, types, and metadata.

```APIDOC
## GET /get_services

### Description
Retrieves the list of services available in the client. This returns the service structure including keys, types, and specific metadata for rating services.

### Method
GET

### Endpoint
/get_services
```

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

### Combined JSON Export Structure

Source: https://hydrusnetwork.github.io/hydrus/advanced_sidecars.html

An example of a JSON file updated by multiple routers to include both tags and URLs.

```json
{
    "metadata" : {
        "tags" : [
            "blonde hair",
            "blue eyes",
            "skirt"
        ],
        "urls" : [
            "http://example.com/123456",
            "https://site.org/post/45678"
        ]
    }
}
```

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

### GET /get_files/render

Source: https://hydrusnetwork.github.io/hydrus/developer_api.html

Retrieves an image or ugoira file as rendered by the Hydrus client. Requires Search for Files permission.

```APIDOC
## GET /get_files/render

### Description
Get an image or ugoira file as rendered by Hydrus. This request uses the client image cache for images.

### Method
GET

### Endpoint
/get_files/render

### Parameters
#### Query Parameters
- **file_id** (integer) - Selective - Numerical file id for the file.
- **hash** (string) - Selective - A hexadecimal SHA256 hash for the file.
- **download** (boolean) - Optional - Default false.
- **render_format** (integer) - Optional - The filetype enum value to render the file to.
- **render_quality** (integer) - Optional - The quality or PNG compression level to use for encoding.
- **width** (integer) - Optional - The width to scale the image to (must provide height if used).
- **height** (integer) - Optional - The height to scale the image to (must provide width if used).

### Request Example
/get_files/render?file_id=452158
```
Tokens:
Raw