Skip to main content

CreateLibraryRequest

Create library request

allowedFormatsstring[]nullable

Allowed file formats (e.g., ["CBZ", "CBR", "EPUB"])

Example: ["CBZ","CBR","EPUB"]
autoMatchConditions

Auto-match conditions (JSON object with mode and rules) Controls when auto-matching runs for this library

bookConfig

Book strategy-specific configuration (JSON, mutable after creation)

bookStrategy object
oneOf
null
defaultReadingDirectionstring | nullnullable

Default reading direction for books in this library (ltr, rtl, ttb or webtoon)

Example: ltr
descriptionstring | nullnullable

Optional description

Example: My comic book collection
excludedPatternsstring | nullnullable

Excluded path patterns (newline-separated, e.g., ".DS_Store\nThumbs.db")

Example: .DS_Store Thumbs.db
namestringrequired

Library name

Example: Comics
numberConfig

Number strategy-specific configuration (JSON, mutable after creation)

numberStrategy object
oneOf
null
pathstringrequired

Filesystem path to the library

Example: /media/comics
scanImmediatelyboolean

Scan immediately after creation (not stored in DB)

Example: true
scanningConfig object
oneOf
null
seriesConfig

Strategy-specific configuration (JSON, immutable after creation)

seriesStrategy object
oneOf
null
titlePreprocessingRules

Title preprocessing rules (JSON array of regex rules) Applied during scan to clean series titles before metadata search

CreateLibraryRequest
{
  "allowedFormats": [
    "CBZ",
    "CBR",
    "EPUB"
  ],
  "bookStrategy": "null",
  "defaultReadingDirection": "ltr",
  "description": "My comic book collection",
  "excludedPatterns": ".DS_Store\nThumbs.db",
  "name": "Comics",
  "numberStrategy": "null",
  "path": "/media/comics",
  "scanImmediately": true,
  "scanningConfig": "null",
  "seriesStrategy": "null"
}