/
KA
kareadita
/
Kavita
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 44m ago · Updated 3d ago
View markdown
Account
28
Activity
1
Admin
1
Annotation
12
Book
4
Cbl
14
Chapter
5
Collection
12
ColorScape
3
Device
10
Download
12
Email
1
Filter
12
Font
5
Health
1
Image
15
KavitaPlusAudit
5
Koreader
3
Library
23
post
Creates a new Library. Upon library creation, adds new library to all Admin accounts.
get
Returns a list of directories for a given path. If path is empty, returns root drives.
post
For each root, checks if there are any supported files at root to warn the user during library creation about an invalid setup
get
Return a specific library
get
Return all libraries in the Server
get
Gets libraries for the given user that you also have access to
get
For a given library, generate the jump bar information
post
Grants a user account access to a Library
post
Scans a given library for file changes.
post
Enqueues a bunch of library scans
post
Scans 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
Copy the library settings (adv tab + optional type) to a set of other libraries.
post
Given 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
Deletes the library and all series within it.
delete
Deletes multiple libraries and all series within it.
get
Checks if the library name exists or not
post
Updates an existing Library with new name, folders, and/or type.
get
Return all Kavita.Models.Entities.Enums.MetadataProviders that are supported by the given Kavita.Models.Entities.Enums.LibraryType"/>
get
Kavita.Models.Entities.Enums.LibraryType with KavitaPlus metadata support
get
Kavita.Models.Entities.Enums.LibraryType with KavitaPlus scrobble support
get
Returns the type of the underlying library
License
13
Locale
1
Manage
1
Metadata
14
OAuth
2
Oidc
2
Opds
22
Panels
2
Person
10
Plugin
5
Rating
4
Reader
39
ReadingList
27
ReadingProfile
16
Review
5
Scrobbling
18
Search
4
Series
33
Server
18
Settings
20
Stats
34
Stream
17
Tachiyomi
2
Theme
7
Upload
10
Users
10
Volume
4
WantToRead
4
Library
Given 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
post
/api/Library/scan-folder
Request body
ScanFolderDto
required
apiKey
string
nullable
folderPath
string
nullable
abortOnNoSeriesMatch
boolean
Response
OK