Skip to main content
POST
/
api
/
v1
/
libraries
Create a library
curl --request POST \
  --url https://demo.komga.org/api/v1/libraries \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "analyzeDimensions": true,
  "convertToCbz": true,
  "emptyTrashAfterScan": true,
  "hashFiles": true,
  "hashKoreader": true,
  "hashPages": true,
  "importBarcodeIsbn": true,
  "importComicInfoBook": true,
  "importComicInfoCollection": true,
  "importComicInfoReadList": true,
  "importComicInfoSeries": true,
  "importComicInfoSeriesAppendVolume": true,
  "importEpubBook": true,
  "importEpubSeries": true,
  "importLocalArtwork": true,
  "importMylarSeries": true,
  "name": "<string>",
  "repairExtensions": true,
  "root": "<string>",
  "scanCbx": true,
  "scanDirectoryExclusions": [
    "<string>"
  ],
  "scanEpub": true,
  "scanForceModifiedTime": true,
  "scanInterval": "DISABLED",
  "scanOnStartup": true,
  "scanPdf": true,
  "seriesCover": "FIRST",
  "oneshotsDirectory": "<string>"
}
'
{
  "analyzeDimensions": true,
  "convertToCbz": true,
  "emptyTrashAfterScan": true,
  "hashFiles": true,
  "hashKoreader": true,
  "hashPages": true,
  "id": "<string>",
  "importBarcodeIsbn": true,
  "importComicInfoBook": true,
  "importComicInfoCollection": true,
  "importComicInfoReadList": true,
  "importComicInfoSeries": true,
  "importComicInfoSeriesAppendVolume": true,
  "importEpubBook": true,
  "importEpubSeries": true,
  "importLocalArtwork": true,
  "importMylarSeries": true,
  "name": "<string>",
  "repairExtensions": true,
  "root": "<string>",
  "scanCbx": true,
  "scanDirectoryExclusions": [
    "<string>"
  ],
  "scanEpub": true,
  "scanForceModifiedTime": true,
  "scanInterval": "DISABLED",
  "scanOnStartup": true,
  "scanPdf": true,
  "seriesCover": "FIRST",
  "unavailable": true,
  "oneshotsDirectory": "<string>"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
analyzeDimensions
boolean
required
​
convertToCbz
boolean
required
​
emptyTrashAfterScan
boolean
required
​
hashFiles
boolean
required
​
hashKoreader
boolean
required
​
hashPages
boolean
required
​
importBarcodeIsbn
boolean
required
​
importComicInfoBook
boolean
required
​
importComicInfoCollection
boolean
required
​
importComicInfoReadList
boolean
required
​
importComicInfoSeries
boolean
required
​
importComicInfoSeriesAppendVolume
boolean
required
​
importEpubBook
boolean
required
​
importEpubSeries
boolean
required
​
importLocalArtwork
boolean
required
​
importMylarSeries
boolean
required
​
name
string
required
Minimum string length: 1
​
repairExtensions
boolean
required
​
root
string
required
Minimum string length: 1
​
scanCbx
boolean
required
​
scanDirectoryExclusions
string[]
required
​
scanEpub
boolean
required
​
scanForceModifiedTime
boolean
required
​
scanInterval
enum<string>
required
Available options:
DISABLED,
HOURLY,
EVERY_6H,
EVERY_12H,
DAILY,
WEEKLY
​
scanOnStartup
boolean
required
​
scanPdf
boolean
required
​
seriesCover
enum<string>
required
Available options:
FIRST,
FIRST_UNREAD_OR_FIRST,
FIRST_UNREAD_OR_LAST,
LAST
​
oneshotsDirectory
string

Response

OK

​
analyzeDimensions
boolean
required
​
convertToCbz
boolean
required
​
emptyTrashAfterScan
boolean
required
​
hashFiles
boolean
required
​
hashKoreader
boolean
required
​
hashPages
boolean
required
​
id
string
required
​
importBarcodeIsbn
boolean
required
​
importComicInfoBook
boolean
required
​
importComicInfoCollection
boolean
required
​
importComicInfoReadList
boolean
required
​
importComicInfoSeries
boolean
required
​
importComicInfoSeriesAppendVolume
boolean
required
​
importEpubBook
boolean
required
​
importEpubSeries
boolean
required
​
importLocalArtwork
boolean
required
​
importMylarSeries
boolean
required
​
name
string
required
​
repairExtensions
boolean
required
​
root
string
required
​
scanCbx
boolean
required
​
scanDirectoryExclusions
string[]
required
​
scanEpub
boolean
required
​
scanForceModifiedTime
boolean
required
​
scanInterval
enum<string>
required
Available options:
DISABLED,
HOURLY,
EVERY_6H,
EVERY_12H,
DAILY,
WEEKLY
​
scanOnStartup
boolean
required
​
scanPdf
boolean
required
​
seriesCover
enum<string>
required
Available options:
FIRST,
FIRST_UNREAD_OR_FIRST,
FIRST_UNREAD_OR_LAST,
LAST
​
unavailable
boolean
required
​
oneshotsDirectory
string