/

Docs
History
Schema
Generate

Filter operations

Account28

Activity1

Admin1

Annotation12

Book4

Cbl14

Chapter5

Collection12

ColorScape3

Device10

Download12

Email1

Filter12

Font5

Health1

Image15

KavitaPlusAudit6

Koreader3

Library25

post/api/Library/createCreates a new Library. Upon library creation, adds new library to all Admin accounts.
get/api/Library/listReturns a list of directories for a given path. If path is empty, returns root drives.
post/api/Library/has-files-at-rootFor each root, checks if there are any supported files at root to warn the user during library creation about an invalid setup
get/api/LibraryReturn a specific library
get/api/Library/librariesReturn all libraries in the Server
get/api/Library/user-librariesGets libraries for the given user that you also have access to
get/api/Library/jump-barFor a given library, generate the jump bar information
post/api/Library/grant-accessGrants a user account access to a Library
post/api/Library/scanScans a given library for file changes.
post/api/Library/folder-watch/retryWatches the library again after its watcher missed a change or kept failing
get/api/Library/watch-statusHow the library notices changes now and why
post/api/Library/scan-multipleEnqueues a bunch of library scans
post/api/Library/scan-allScans a given library for file changes. If another scan task is in progress, will reschedule the invocation for 3 hours in future.
post/api/Library/refresh-metadata
post/api/Library/refresh-metadata-multiple
post/api/Library/copy-settings-fromCopy the library settings (adv tab + optional type) to a set of other libraries.
post/api/Library/scan-folderGiven a valid path, will invoke either a Scan Series or Scan Library. If the folder does not exist within Kavita, the request will be ignored
delete/api/Library/deleteDeletes the library and all series within it.
delete/api/Library/delete-multipleDeletes multiple libraries and all series within it.
get/api/Library/name-existsChecks if the library name exists or not
post/api/Library/updateUpdates an existing Library with new name, folders, and/or type.
get/api/Library/metadata-providersReturn all Kavita.Models.Entities.Enums.MetadataProviders that are supported by the given Kavita.Models.Entities.Enums.LibraryType"/>
get/api/Library/metadata-enabled-librariesKavita.Models.Entities.Enums.LibraryType with KavitaPlus metadata support
get/api/Library/scrobble-enabled-librariesKavita.Models.Entities.Enums.LibraryType with KavitaPlus scrobble support
get/api/Library/typeReturns the type of the underlying library

License13

Locale1

Manage2

Metadata14

OAuth2

Oidc2

Opds22

Panels2

Person10

Plugin5

Rating4

Reader39

ReadingList27

ReadingProfile16

Review6

Scrobbling19

Search4

Series33

Server24

Settings20

Stats34

Stream17

Tachiyomi2

Theme7

Upload13

Users10

Volume4

WantToRead4

Library

Changes to How the library notices changes now and why

get/api/Library/watch-status

Oct 22, 20267de671750636 Revision changes
- info
  endpoint added