LazyLibrarian

https://lazylibrarian.gitlab.io
Admin
LazyLibrarian is a program to follow authors, grab metadata, and automate the search and download of...
Tokens:26,219
Snippets:366
Trust Score:7
Update:3 months ago
Show doc for...
Tokens:
Raw
### getModules

Source: https://lazylibrarian.gitlab.io/api

Shows the list of installed modules.

```APIDOC
## getModules

### Description
Shows the list of installed modules.

### Method
GET

### Endpoint
`/api`

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **cmd** (string) - Required - Must be set to `getModules`.
```

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

### LazyLibrarian Startup Command and System Info

Source: https://lazylibrarian.gitlab.io/config_menus

This snippet displays the command used to start LazyLibrarian along with detailed system and version information. It is useful for debugging and understanding the environment in which LazyLibrarian is running.

```text
Startup cmd: ['/usr/bin/python', '/app/lazylibrarian/LazyLibrarian.py', '--datadir', '/config', '--nolaunch']
Interface: bookstrap
Loglevel: 3
Sys_Encoding: UTF-8
git_repo: lazylibrarian
git_user: dobytang
git_branch: master
latest_version: a4fd6e6241cb9cb8427ffd732fa53a6abd13a68b
git_updated: Mon Oct 22 19:49:21 2018
current_version: a4fd6e6241cb9cb8427ffd732fa53a6abd13a68b
commits_behind: 0
install_type: git
auto_update: 1
Python version: ['2.7.15 (default, Aug 16 2018, 14:17:09) ', '[GCC 6.4.0]']
Distribution: ('', '', '')
System: Linux
Machine: x86_64
Platform: Linux-4.18.8-unRAID-x86_64-with
uname: ('Linux', '23c4ed4cd40f', '4.18.8-unRAID', '#1 SMP Sat Sep 15 09:15:50 PDT 2018', 'x86_64', '')
version: #1 SMP Sat Sep 15 09:15:50 PDT 2018
mac_ver: ('', ('', '', ''), '')
urllib3: 1.24
requests: 2.20.0
tls: TLS 1.2
cherrypy: 3.6.0
sqlite3: 3.24.0
unrar: DLL version 8
openssl: LibreSSL 2.7.4
pyOpenSSL: 18.0.0
cryptography: 2.3.1
magic: missing

```

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

### Compile and Install Unrar Library on Linux

Source: https://lazylibrarian.gitlab.io/faq

This snippet shows the commands to download, extract, compile, and install the unrar library from source on a Linux system. Ensure you run 'sudo ldconfig' to update the shared library cache.

```bash
wget https://www.rarlab.com/rar/unrarsrc-5.6.4.tar.gz
tar -xvzf unrarsrc-5.6.4.tar.gz
cd unrar
make lib  
sudo make install-lib  
sudo ldconfig

```

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

### Install LazyLibrarian as a Windows Service using NSSM

Source: https://lazylibrarian.gitlab.io/faq

This command installs LazyLibrarian as a Windows service using the Non-Sucking Service Manager (NSSM). Ensure NSSM is installed and accessible via your system's PATH or in the system32 directory. You may need to run this command from an elevated command prompt.

```powershell
nssm install lazylibrarian

```

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

### showMonths

Source: https://lazylibrarian.gitlab.io/api

Displays the installed month names.

```APIDOC
## showMonths

### Description
Shows installed month names.
```

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

### Download Ghostscript for LazyLibrarian on Synology

Source: https://lazylibrarian.gitlab.io/faq

Use this command to download a specific version of Ghostscript if the system's version is too old or missing. Adjust the path if your LazyLibrarian installation is not in the default location.

```bash
wget https://github.com/ArtifexSoftware/ghostpdl-downloads/releases/download/gs918/ghostscript-9.18-linux-x86_64.tgz
```

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

### dumpMonths

Source: https://lazylibrarian.gitlab.io/api

Saves the installed month names to a file.

```APIDOC
## dumpMonths

### Description
Saves the installed month names to a file.

### Method
GET

### Endpoint
`/api`

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **cmd** (string) - Required - Must be set to `dumpMonths`.
```

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

### Example Monthnames Configuration

Source: https://lazylibrarian.gitlab.io/config_importing

This JSON structure defines month names and their abbreviations for multiple languages, used by LazyLibrarian to parse magazine issue dates. Ensure the language codes match your system's locales.

```json
[["en_GB.UTF-8", "en_GB.UTF-8", "es_ES.utf8", "es_ES.utf8"], ["january", "jan", "enero", "ene"], ["february", "feb", "febrero", "feb"], ["march", "mar", "marzo", "mar"], ["april", "apr", "abril", "abr"], ["may", "may", "mayo", "may"], ["june", "jun", "junio", "jun"], ["july", "jul", "julio", "jul"], ["august", "aug", "agosto", "ago"], ["september", "sep", "septiembre", "sep"], ["october", "oct", "octubre", "oct"], ["november", "nov", "noviembre", "nov"], ["december", "dec", "diciembre", "dic"]]
```

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

### Workaround for LazyLibrarian Upgrade Issues on Freenas

Source: https://lazylibrarian.gitlab.io/faq

This workaround involves manually stopping the service, removing the existing installation, fetching and extracting the latest version, setting ownership, cleaning up, and restarting the service. Ensure you have the necessary permissions to execute these commands.

```bash
service lazylibrarian onestop

rm -r /usr/pbi/lazylibrarian-amd64/share/lazylibrarian/LazyLibrarian

fetch --no-verify-peer "https://gitlab.com/LazyLibrarian/LazyLibrarian/archive/master.tar.gz"

tar xzf master.tar.gz

mv LazyLibrarian-master /usr/pbi/lazylibrarian-amd64/share/lazylibrarian/LazyLibrarian

chown -R media:media /usr/pbi/lazylibrarian-amd64/share/lazylibrarian/LazyLibrarian

rm master.tar.gz

service lazylibrarian start

```

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

### Move and Rename Ghostscript for LazyLibrarian

Source: https://lazylibrarian.gitlab.io/faq

Move the unpacked Ghostscript directory into your LazyLibrarian installation folder and rename the executable to 'gs'. This ensures LazyLibrarian can find and use its private Ghostscript copy.

```bash
mv ghostscript-9.18-linux-x86_64/gs-918-linux_x86_64 gs
```

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

### help

Source: https://lazylibrarian.gitlab.io/api

Lists all available commands and their required parameters.

```APIDOC
## help

### Description
Lists all available commands and their required parameters.

### Method
GET

### Endpoint
`/api`

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **cmd** (string) - Required - Must be set to `help`.
```

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

### Enable Apache Proxy Modules

Source: https://lazylibrarian.gitlab.io/config_rtorrent

Enable necessary Apache modules for SCGI proxying. Restart the web server after changes.

```bash
a2enmod proxy
a2enmod proxy_scgi
```

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

### showCaps

Source: https://lazylibrarian.gitlab.io/api

Retrieves a list of capabilities from a specified provider.

```APIDOC
## showCaps

### Description
Gets a list of capabilities from a provider.

### Parameters
#### Query Parameters
- **provider** (string) - Required - The name of the provider.
```

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

### Create rTorrent Authentication Password File

Source: https://lazylibrarian.gitlab.io/config_rtorrent

Create a password file for basic authentication using the htpasswd utility. This file stores usernames and encrypted passwords.

```bash
htpasswd -c /etc/httpd/conf/rtorrentscgi user_name
```

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

### Test rTorrent Connection via XML-RPC

Source: https://lazylibrarian.gitlab.io/config_rtorrent

Verify the connection to rTorrent from the command line using xmlrpc. This requires the libxmlrpc-core-c3-dev package.

```bash
xmlrpc localhost system.client_version
```

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

### nice

Source: https://lazylibrarian.gitlab.io/api

Displays the current nice level of the program.

```APIDOC
## nice

### Description
Shows the current nice level.
```

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

### API Overview

Source: https://lazylibrarian.gitlab.io/api

The LazyLibrarian API provides a RESTful interface to manage your library. Access the API via `http://host:port/api` and authenticate using an `apikey`. Use the `cmd` parameter to specify the desired action. For detailed usage and available commands, append `?apikey=your_api_key&cmd=help` to the base URL.

```APIDOC
## API Overview

### Description
The LazyLibrarian API allows users to interact with the library management system programmatically. It supports a wide range of commands for managing authors, books, magazines, and library data, with options for background processing and detailed logging.

### Base URL
`http://host:port/api`

### Authentication
`apikey=your_api_key`

### General Usage
`http://host:port/api?apikey=your_api_key&cmd=<command_name>[&parameter=value]...`

### Help Command
To list all available commands and their parameters:
`http://host:port/api?apikey=your_api_key&cmd=help`

### Parameter Encoding
Parameters should be URL-encoded using `urllib.quote_plus` style (e.g., `name=Tom+Holt`).
```

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

### createPlaylist

Source: https://lazylibrarian.gitlab.io/api

Creates a playlist for an audiobook using its ID.

```APIDOC
## createPlaylist

### Description
Creates a playlist for an audiobook using its ID.

### Method
GET

### Endpoint
`/api`

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **cmd** (string) - Required - Must be set to `createPlaylist`.
- **id** (string) - Required - The ID of the audiobook.
```

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

### forceProcess

Source: https://lazylibrarian.gitlab.io/api

Processes books or magazines in a specified directory. Can ignore the 'keep seeding' setting.

```APIDOC
## forceProcess

### Description
Processes books or magazines in a specified directory. Can ignore the 'keep seeding' setting.

### Method
GET

### Endpoint
`/api`

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **cmd** (string) - Required - Must be set to `forceProcess`.
- **dir** (string) - Optional - The directory containing books or magazines to process.
- **ignorekeepseeding** (boolean) - Optional - If set, the 'keep seeding' setting will be ignored.
```

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

### Test rTorrent Basic Authentication

Source: https://lazylibrarian.gitlab.io/config_rtorrent

Test the configured basic authentication for rTorrent by using xmlrpc with username and password.

```bash
xmlrpc -u user_name -p user_passwd localhost system.client_version
```

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

### Configure rTorrent for SCGI

Source: https://lazylibrarian.gitlab.io/config_rtorrent

Open an SCGI port in rTorrent's configuration file to allow communication.

```rtorrent
network.scgi.open_port = 127.0.0.1:5000
```

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

### listProviders

Source: https://lazylibrarian.gitlab.io/api

Lists all available providers across all types.

```APIDOC
## listProviders

### Description
Lists all providers.
```

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

### Configure Apache for rTorrent Basic Authentication

Source: https://lazylibrarian.gitlab.io/config_rtorrent

Set up basic authentication for rTorrent's SCGI endpoint in Apache. This requires creating a password file using htpasswd.

```apache
#rTorrent SCGI
<Location "/RPC2"> 
    AuthType        Basic 
    AuthName        "rtorrentscgi" 
    AuthUserFile    /etc/httpd/conf/rtorrentscgi 
    Require         valid-user 
    BrowserMatch    "MSIE"  AuthDigestEnableQueryStringHack=On 
    Order           allow,deny 
    Allow From      all 
</Location> 

```

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

### Configure Docker for French Locales

Source: https://lazylibrarian.gitlab.io/faq

Set environment variables in your Docker configuration to ensure proper display of accented characters in book titles and magazine names when using French locales.

```yaml
lazylibrarian:
  image: linuxserver/lazylibrarian
  container_name: lazylibrarian
  environment:
    - PUID=1001
    - PGID=1001
    - TZ=Pacific/Noumea
    - PYTHONIOENCODING=utf-8
    - LANG=fr_FR.UTF-8
    - LANGUAGE=fr_FR:fr
    - LC_CTYPE="fr_FR.UTF-8"
    - LC_NUMERIC="fr_FR.UTF-8"
    - LC_TIME="fr_FR.UTF-8"
    - LC_COLLATE="fr_FR.UTF-8"
    - LC_MONETARY="fr_FR.UTF-8"
    - LC_MESSAGES="fr_FR.UTF-8"
    - LC_PAPER="fr_FR.UTF-8"
    - LC_NAME="fr_FR.UTF-8"
    - LC_ADDRESS="fr_FR.UTF-8"
    - LC_TELEPHONE="fr_FR.UTF-8"
    - LC_MEASUREMENT="fr_FR.UTF-8"
    - LC_IDENTIFICATION="fr_FR.UTF-8"
  volumes:
    - /home/lazylibrarian:/config
    - /NFS:/NFS
    - ./.bashrc:/root/.bashrc:ro
  ports:
    - 5299:5299
  restart: unless-stopped
```

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

### listDirectProviders

Source: https://lazylibrarian.gitlab.io/api

Lists all available direct download providers.

```APIDOC
## listDirectProviders

### Description
Lists all direct providers.
```

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

### showThreads

Source: https://lazylibrarian.gitlab.io/api

Displays information about threaded processes.

```APIDOC
## showThreads

### Description
Shows threaded processes.
```

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

### listNabProviders

Source: https://lazylibrarian.gitlab.io/api

Lists all available Newznab and Torznab providers.

```APIDOC
## listNabProviders

### Description
Lists all Newznab/Torznab providers.
```

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

### Configure HTTP Proxy

Source: https://lazylibrarian.gitlab.io/config_interface

Specify proxy host with authentication details for HTTP connections.

```text
http://user:password@host:port
```

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

### addProvider

Source: https://lazylibrarian.gitlab.io/api

Adds a new provider. The type should be newznab, torznab, irc, or rss, gen. Provide optional extra parameters or defaults are used as per the last (empty) entry of each type shown in listProviders.

```APIDOC
## addProvider

### Description
Adds a new provider. The type should be newznab, torznab, irc, or rss, gen. Provide optional extra parameters or defaults are used as per the last (empty) entry of each type shown in listProviders.

### Method
POST

### Endpoint
/addProvider

### Parameters
#### Query Parameters
- **type** (string) - Required - The type of the provider to add (e.g., newznab, torznab, irc, rss, gen).
- **xxx** (string) - Optional - Optional extra parameters or defaults for the provider.
```

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

### writeAllOPF

Source: https://lazylibrarian.gitlab.io/api

Writes out OPF files for all books. Can optionally overwrite existing files and refresh metadata.

```APIDOC
## writeAllOPF

### Description
Writes out OPF files for all books, optionally overwriting existing OPF files.

### Parameters
#### Query Parameters
- **refresh** (boolean) - Optional - Overwrites existing OPF files.
```

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

### preprocessBook

Source: https://lazylibrarian.gitlab.io/api

Preprocesses an ebook folder.

```APIDOC
## preprocessBook

### Description
Preprocesses an ebook folder.

### Parameters
#### Query Parameters
- **dir** (string) - Required - The directory containing the ebook.
```

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

### preprocessAudio

Source: https://lazylibrarian.gitlab.io/api

Preprocesses an audiobook folder, allowing specification of author, title, ID, and optional tagging/merging.

```APIDOC
## preprocessAudio

### Description
Preprocesses an audiobook folder.

### Parameters
#### Query Parameters
- **dir** (string) - Required - The directory containing the audiobook.
- **author** (string) - Required - The author of the audiobook.
- **title** (string) - Required - The title of the audiobook.
- **id** (string) - Optional - The ID of the audiobook.
- **tag** (boolean) - Optional - Tag the audiobook.
- **merge** (boolean) - Optional - Merge the audiobook.
```

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

### getToRead

Source: https://lazylibrarian.gitlab.io/api

Lists books that are marked as 'to read' for the current user.

```APIDOC
## getToRead

### Description
Lists books that are marked as 'to read' for the current user.

### Method
GET

### Endpoint
`/api`

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **cmd** (string) - Required - Must be set to `getToRead`.
```

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

### nicer

Source: https://lazylibrarian.gitlab.io/api

Increases the niceness level of the program slightly.

```APIDOC
## nicer

### Description
Makes the program a little nicer (increases niceness level).
```

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

### grSync

Source: https://lazylibrarian.gitlab.io/api

Syncs books with a specified status to a Goodreads shelf. Supports specifying the library.

```APIDOC
## grSync

### Description
Syncs books with a specified status to a Goodreads shelf. Supports specifying the library.

### Method
GET

### Endpoint
`/api`

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **cmd** (string) - Required - Must be set to `grSync`.
- **status** (string) - Required - The status of books to sync (e.g., 'read', 'currently-reading').
- **shelf** (string) - Required - The name of the Goodreads shelf to sync to.
- **library** (string) - Optional - Specifies the library to sync from.
```

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

### loadCFG

Source: https://lazylibrarian.gitlab.io/api

Reloads the configuration settings.

```APIDOC
## loadCFG

### Description
Reloads the configuration.
```

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

### showStats

Source: https://lazylibrarian.gitlab.io/api

Displays database statistics.

```APIDOC
## showStats

### Description
Shows database statistics.
```

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

### Configure Apache for rTorrent SCGI

Source: https://lazylibrarian.gitlab.io/config_rtorrent

Configure Apache to proxy requests to rTorrent via SCGI. Ensure mod_proxy and mod_proxy_scgi are enabled.

```apache
ProxyPass /RPC2 scgi://127.0.0.1:5000
```

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

### listIRCProviders

Source: https://lazylibrarian.gitlab.io/api

Lists all available IRC providers.

```APIDOC
## listIRCProviders

### Description
Lists all IRC providers.
```

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

### memUse

Source: https://lazylibrarian.gitlab.io/api

Displays the memory usage of the program in kilobytes.

```APIDOC
## memUse

### Description
Shows memory usage of the program in kB.
```

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

### Configure SOCKS Proxy

Source: https://lazylibrarian.gitlab.io/config_interface

Specify proxy host with authentication details for SOCKS connections.

```text
socks5://user:password@host:port
```

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

### queueBook

Source: https://lazylibrarian.gitlab.io/api

Marks a book as 'Wanted', defaulting to eBook type. Can specify type and ID.

```APIDOC
## queueBook

### Description
Marks a book as Wanted, defaulting to eBook.

### Parameters
#### Query Parameters
- **id** (string) - Optional - The ID of the book.
- **type** (string) - Optional - The type of book (eBook/AudioBook). Defaults to eBook.
```

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

### importAlternate

Source: https://lazylibrarian.gitlab.io/api

Imports books from a specified alternate folder and its subfolders. Supports waiting for completion.

```APIDOC
## importAlternate

### Description
Imports books from a named or alternate folder and any subfolders.

### Parameters
#### Query Parameters
- **wait** (boolean) - Optional - Waits for the operation to complete.
- **dir** (string) - Optional - The name or path of the alternate folder.
```

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

### createMagCovers

Source: https://lazylibrarian.gitlab.io/api

Creates covers for magazines. Can optionally refresh existing covers.

```APIDOC
## createMagCovers

### Description
Creates covers for magazines. Can optionally refresh existing covers.

### Method
GET

### Endpoint
`/api`

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **cmd** (string) - Required - Must be set to `createMagCovers`.
- **wait** (boolean) - Optional - If set, the command will wait for the cover creation process to complete.
- **refresh** (boolean) - Optional - If set, existing covers will be refreshed.
```

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

### getLogs

Source: https://lazylibrarian.gitlab.io/api

Displays the current log content.

```APIDOC
## getLogs

### Description
Displays the current log content.

### Method
GET

### Endpoint
`/api`

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **cmd** (string) - Required - Must be set to `getLogs`.
```

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

### Configure LazyLibrarian File Permissions

Source: https://lazylibrarian.gitlab.io/faq

Modify LazyLibrarian's config.ini to set file permissions to 0o666. This allows the Calibre Docker to read and write files, resolving potential permission issues when both run in separate containers.

```ini
file permissions to 0o666
```

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

### restart

Source: https://lazylibrarian.gitlab.io/api

Restarts the LazyLibrarian application.

```APIDOC
## restart

### Description
Restarts LazyLibrarian.
```

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

### forceWishlistSearch

Source: https://lazylibrarian.gitlab.io/api

Initiates a search across all entries in the wishlists. Can optionally wait for completion.

```APIDOC
## forceWishlistSearch

### Description
Initiates a search across all entries in the wishlists. Can optionally wait for completion.

### Method
GET

### Endpoint
`/api`

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **cmd** (string) - Required - Must be set to `forceWishlistSearch`.
- **wait** (boolean) - Optional - If set, the command will wait for the search process to complete.
```

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

### importCSVwishlist

Source: https://lazylibrarian.gitlab.io/api

Imports a CSV wishlist from a specified directory. Supports waiting for completion.

```APIDOC
## importCSVwishlist

### Description
Imports a CSV wishlist from a named or alternate directory.

### Parameters
#### Query Parameters
- **wait** (boolean) - Optional - Waits for the operation to complete.
- **dir** (string) - Optional - The name or path of the directory containing the CSV file.
```

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

### showJobs

Source: https://lazylibrarian.gitlab.io/api

Displays the status of background jobs.

```APIDOC
## showJobs

### Description
Shows the status of background jobs.
```

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

### getBookCovers

Source: https://lazylibrarian.gitlab.io/api

Checks all books for a cached cover and downloads one if missing. Can optionally wait for completion.

```APIDOC
## getBookCovers

### Description
Checks all books for a cached cover and downloads one if missing. Can optionally wait for completion.

### Method
GET

### Endpoint
`/api`

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **cmd** (string) - Required - Must be set to `getBookCovers`.
- **wait** (boolean) - Optional - If set, the command will wait for the cover fetching process to complete.
```

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

### listNoLang

Source: https://lazylibrarian.gitlab.io/api

Lists all books in the database with an unknown language.

```APIDOC
## listNoLang

### Description
Lists all books in the database with an unknown language.
```

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

### listTorrentProviders

Source: https://lazylibrarian.gitlab.io/api

Lists all available torrent providers.

```APIDOC
## listTorrentProviders

### Description
Lists all torrent providers.
```

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

### listRSSProviders

Source: https://lazylibrarian.gitlab.io/api

Lists all available RSS and wishlist providers.

```APIDOC
## listRSSProviders

### Description
Lists all RSS/wishlist providers.
```

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

### checkRunningJobs

Source: https://lazylibrarian.gitlab.io/api

Ensures that all necessary background jobs are running.

```APIDOC
## checkRunningJobs

### Description
Ensures that all necessary background jobs are running.

### Method
GET

### Endpoint
`/api`

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **cmd** (string) - Required - Must be set to `checkRunningJobs`.
```

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

### cpuUse

Source: https://lazylibrarian.gitlab.io/api

Displays the recent CPU usage of the program.

```APIDOC
## cpuUse

### Description
Shows recent CPU usage of the program.
```

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

### syncCalibreList

Source: https://lazylibrarian.gitlab.io/api

Synchronizes the list of read and to-read books with Calibre.

```APIDOC
## syncCalibreList

### Description
Syncs the list of read/to-read books with Calibre.

### Parameters
#### Query Parameters
- **toread** (string) - Optional - List of books to mark as to-read.
- **read** (string) - Optional - List of books to mark as read.
```

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

### Unpack Ghostscript Archive

Source: https://lazylibrarian.gitlab.io/faq

Extract the downloaded Ghostscript tarball to access its contents. This is a necessary step before moving the Ghostscript binaries to the LazyLibrarian directory.

```bash
tar -xvf ghostscript-9.18-linux-x86_64.tgz
```

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

### getHistory

Source: https://lazylibrarian.gitlab.io/api

Lists the history of actions performed.

```APIDOC
## getHistory

### Description
Lists the history of actions performed.

### Method
GET

### Endpoint
`/api`

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **cmd** (string) - Required - Must be set to `getHistory`.
```

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

### getVersion

Source: https://lazylibrarian.gitlab.io/api

Displays the current version of LazyLibrarian, including Git information if available.

```APIDOC
## getVersion

### Description
Displays the current version of LazyLibrarian, including Git information if available.

### Method
GET

### Endpoint
`/api`

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **cmd** (string) - Required - Must be set to `getVersion`.
```

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

### setNoDesc

Source: https://lazylibrarian.gitlab.io/api

Sets descriptions for all books lacking them. Can retry on refresh.

```APIDOC
## setNoDesc

### Description
Sets description for all books in the database without one, retrying "No Description" entries on refresh.

### Parameters
#### Query Parameters
- **refresh** (boolean) - Optional - Retries "No Description" entries on refresh.
```

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

### getAllBooks

Source: https://lazylibrarian.gitlab.io/api

Lists all books currently stored in the database.

```APIDOC
## getAllBooks

### Description
Lists all books currently stored in the database.

### Method
GET

### Endpoint
`/api`

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **cmd** (string) - Required - Must be set to `getAllBooks`.
```

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

### writeCFG

Source: https://lazylibrarian.gitlab.io/api

Sets a configuration variable in a specific section to a given value.

```APIDOC
## writeCFG

### Description
Sets a config variable in a section to a value.

### Parameters
#### Query Parameters
- **name** (string) - Required - The name of the configuration variable.
- **group** (string) - Required - The section the variable belongs to.
- **value** (string) - Required - The new value for the variable.
```

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

### changeProvider

Source: https://lazylibrarian.gitlab.io/api

Changes values for an existing provider. Valid parameters are shown in listProviders for the relevant provider type.

```APIDOC
## changeProvider

### Description
Changes values for an existing provider. Valid parameters are shown in listProviders for the relevant provider type.

### Method
POST

### Endpoint
/changeProvider

### Parameters
#### Query Parameters
- **name** (string) - Required - The name of the provider to change.
- **xxx** (string) - Optional - Additional parameters to change for the provider, as shown in listProviders.
```

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

### saveTable

Source: https://lazylibrarian.gitlab.io/api

Saves a specified database table to a file.

```APIDOC
## saveTable

### Description
Saves a database table to a file.

### Parameters
#### Query Parameters
- **table** (string) - Required - The name of the table to save.
```

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

### nameVars

Source: https://lazylibrarian.gitlab.io/api

Displays the name variables that would be used for a specific book ID.

```APIDOC
## nameVars

### Description
Shows the name variables that would be used for a bookid.

### Parameters
#### Query Parameters
- **id** (string) - Required - The ID of the book.
```

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

### includeAlternate

Source: https://lazylibrarian.gitlab.io/api

Includes books from a specified alternate folder and its subfolders. Supports waiting for completion.

```APIDOC
## includeAlternate

### Description
Includes books from named or alternate folders and any subfolders.

### Parameters
#### Query Parameters
- **wait** (boolean) - Optional - Waits for the operation to complete.
- **dir** (string) - Optional - The name or path of the alternate folder.
```

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

### getWanted

Source: https://lazylibrarian.gitlab.io/api

Lists books that are currently marked as wanted.

```APIDOC
## getWanted

### Description
Lists books that are currently marked as wanted.

### Method
GET

### Endpoint
`/api`

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **cmd** (string) - Required - Must be set to `getWanted`.
```

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

### setBookImage

Source: https://lazylibrarian.gitlab.io/api

Sets a new image for a book using its ID and the image URL.

```APIDOC
## setBookImage

### Description
Sets a new image for a book.

### Parameters
#### Query Parameters
- **id** (string) - Required - The ID of the book.
- **img** (string) - Required - The URL of the new image.
```

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

### exportCSVwishlist

Source: https://lazylibrarian.gitlab.io/api

Exports the wishlist to a CSV file. Can specify a directory and optionally wait for completion.

```APIDOC
## exportCSVwishlist

### Description
Exports the wishlist to a CSV file. Can specify a directory and optionally wait for completion.

### Method
GET

### Endpoint
`/api`

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **cmd** (string) - Required - Must be set to `exportCSVwishlist`.
- **wait** (boolean) - Optional - If set, the command will wait for the export process to complete.
- **dir** (string) - Optional - The directory where the CSV file will be saved. If not specified, the default directory is used.
```

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

### getSnatched

Source: https://lazylibrarian.gitlab.io/api

Lists books that have been marked as snatched.

```APIDOC
## getSnatched

### Description
Lists books that have been marked as snatched.

### Method
GET

### Endpoint
`/api`

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **cmd** (string) - Required - Must be set to `getSnatched`.
```

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

### forceBookSearch

Source: https://lazylibrarian.gitlab.io/api

Initiates a search for all wanted books, with an option to specify the type (eBook or AudioBook).

```APIDOC
## forceBookSearch

### Description
Initiates a search for all wanted books, with an option to specify the type (eBook or AudioBook).

### Method
GET

### Endpoint
`/api`

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **cmd** (string) - Required - Must be set to `forceBookSearch`.
- **wait** (boolean) - Optional - If set, the command will wait for the search process to complete.
- **type** (string) - Optional - Specifies the type of book to search for. Accepted values are `eBook` or `AudioBook`.
```

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

### restartJobs

Source: https://lazylibrarian.gitlab.io/api

Restarts the background jobs.

```APIDOC
## restartJobs

### Description
Restarts background jobs.
```

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

### vacuum

Source: https://lazylibrarian.gitlab.io/api

Performs a vacuum operation on the database.

```APIDOC
## vacuum

### Description
Vacuums the database.
```

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

### Alternative Apache 2.4 SCGI Mount

Source: https://lazylibrarian.gitlab.io/config_rtorrent

On some systems, particularly with Apache 2.4, SCGIMount may be required instead of ProxyPass for SCGI connections.

```apache
SCGIMount /RPC2 127.0.0.1:5000
```

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

### writeOPF

Source: https://lazylibrarian.gitlab.io/api

Writes out an OPF file for a specific book ID. Can optionally overwrite existing files and refresh metadata.

```APIDOC
## writeOPF

### Description
Writes out an OPF file for a bookid, optionally overwriting existing OPF files.

### Parameters
#### Query Parameters
- **id** (string) - Required - The ID of the book.
- **refresh** (boolean) - Optional - Overwrites existing OPF files.
```

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

### clearLogs

Source: https://lazylibrarian.gitlab.io/api

Clears the current log file.

```APIDOC
## clearLogs

### Description
Clears the current log file.

### Method
GET

### Endpoint
`/api`

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **cmd** (string) - Required - Must be set to `clearLogs`.
```

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

### unqueueBook

Source: https://lazylibrarian.gitlab.io/api

Marks a book as 'Skipped', defaulting to eBook type. Can specify type and ID.

```APIDOC
## unqueueBook

### Description
Marks a book as Skipped, defaulting to eBook.

### Parameters
#### Query Parameters
- **id** (string) - Required - The ID of the book to unqueue.
- **type** (string) - Optional - The type of book (eBook/AudioBook). Defaults to eBook.
```

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

### checkModules

Source: https://lazylibrarian.gitlab.io/api

Checks which library modules LazyLibrarian is currently using.

```APIDOC
## checkModules

### Description
Checks which library modules LazyLibrarian is currently using.

### Method
GET

### Endpoint
`/api`

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **cmd** (string) - Required - Must be set to `checkModules`.
```

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

### renameAudio

Source: https://lazylibrarian.gitlab.io/api

Renames an audiobook using the configured pattern.

```APIDOC
## renameAudio

### Description
Renames an audiobook using the configured pattern.

### Parameters
#### Query Parameters
- **id** (string) - Required - The ID of the audiobook to rename.
```

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

### getRead

Source: https://lazylibrarian.gitlab.io/api

Lists books that have been marked as read for the current user.

```APIDOC
## getRead

### Description
Lists books that have been marked as read for the current user.

### Method
GET

### Endpoint
`/api`

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **cmd** (string) - Required - Must be set to `getRead`.
```

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

### getIndex

Source: https://lazylibrarian.gitlab.io/api

Lists all authors currently in the database.

```APIDOC
## getIndex

### Description
Lists all authors currently in the database.

### Method
GET

### Endpoint
`/api`

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **cmd** (string) - Required - Must be set to `getIndex`.
```

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

### preprocessMagazine

Source: https://lazylibrarian.gitlab.io/api

Preprocesses a magazine folder, allowing specification of directory and cover image.

```APIDOC
## preprocessMagazine

### Description
Preprocesses a magazine folder.

### Parameters
#### Query Parameters
- **dir** (string) - Required - The directory containing the magazine.
- **cover** (string) - Required - The cover image for the magazine.
```

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

### createMagCover

Source: https://lazylibrarian.gitlab.io/api

Creates a cover for a specific magazine issue. Optionally specifies the page number and can refresh existing covers.

```APIDOC
## createMagCover

### Description
Creates a cover for a specific magazine issue. Optionally specifies the page number and can refresh existing covers.

### Method
GET

### Endpoint
`/api`

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **cmd** (string) - Required - Must be set to `createMagCover`.
- **file** (string) - Required - The file path of the magazine issue.
- **refresh** (boolean) - Optional - If set, the existing cover will be refreshed.
- **page** (integer) - Optional - The page number to use for the cover.
```

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

### listNoISBN

Source: https://lazylibrarian.gitlab.io/api

Lists all books in the database that do not have an ISBN.

```APIDOC
## listNoISBN

### Description
Lists all books in the database with no ISBN.
```

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

### findBook

Source: https://lazylibrarian.gitlab.io/api

Searches Goodreads and Google Books for a book by name.

```APIDOC
## findBook

### Description
Searches Goodreads and Google Books for a book by name.

### Method
GET

### Endpoint
`/api`

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **cmd** (string) - Required - Must be set to `findBook`.
- **name** (string) - Required - The name of the book to search for.
```

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

### listNoDesc

Source: https://lazylibrarian.gitlab.io/api

Lists all books in the database that are missing a description.

```APIDOC
## listNoDesc

### Description
Lists all books in the database with no description.
```

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

### getDebug

Source: https://lazylibrarian.gitlab.io/api

Displays the header of the debug log.

```APIDOC
## getDebug

### Description
Displays the header of the debug log.

### Method
GET

### Endpoint
`/api`

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **cmd** (string) - Required - Must be set to `getDebug`.
```

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

### forceAudioBookScan

Source: https://lazylibrarian.gitlab.io/api

Rescans the audiobook library, either fully or partially. Supports removing entries and specifying a directory or ID.

```APIDOC
## forceAudioBookScan

### Description
Rescans the audiobook library, either fully or partially. Supports removing entries and specifying a directory or ID.

### Method
GET

### Endpoint
`/api`

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **cmd** (string) - Required - Must be set to `forceAudioBookScan`.
- **wait** (boolean) - Optional - If set, the command will wait for the scan process to complete.
- **remove** (boolean) - Optional - If set, entries found during the scan will be removed.
- **dir** (string) - Optional - The directory to scan within the audiobook library.
- **id** (string) - Optional - The ID of a specific audiobook to scan.
```
Tokens:
Raw