/
KA
kareadita
/
Kavita
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 50m 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
License
13
Locale
1
Manage
1
Metadata
14
OAuth
2
Oidc
2
Opds
22
Panels
2
Person
10
Plugin
5
Rating
4
Reader
39
get
Returns the PDF for the chapterId.
get
Returns an image for a given chapter. Will perform bounding checks
get
Returns a thumbnail for the given page number
get
Returns an image for a given bookmark series. Side effect: This will cache the bookmark images for reading.
get
Returns the file dimensions for all pages in a chapter. If the underlying chapter is PDF, use extractPDF to unpack as images.
get
Returns various information about a Chapter. Side effect: This will cache the chapter images for reading.
get
Returns various information about all bookmark files for a Series. Side effect: This will cache the bookmark images for reading.
post
Mark a single chapter as read
post
Marks a Series as read. All volumes and chapters will be marked as read during this process.
post
Marks a Series as Unread. All volumes and chapters will be marked as unread during this process.
post
Marks all chapters within a volume as unread
post
Marks all chapters within a volume as Read
post
Marks all chapters within a list of volumes as Read. All volumes must belong to the same Series.
post
Marks all chapters within a list of volumes as Unread. All volumes must belong to the same Series.
post
Marks all chapters within a list of series as Read.
post
Marks all chapters within a list of series as Unread.
get
Returns Progress (page number) for a chapter for the logged in user
post
Save page against Chapter for authenticated user
get
Continue point is the chapter which you should start reading again from. If there is no progress on a series, then the first chapter will be returned (non-special unless only specials). Otherwise, loop through the chapters and volumes in order to find the next chapter which has progress.
get
Returns if the user has reading progress on the Series
get
Returns a list of bookmarked pages for a given Chapter
post
Returns a list of all bookmarked pages for a User
post
Removes all bookmarks for all chapters linked to a Series
post
Removes all bookmarks for all chapters linked to a Series
get
Returns all bookmarked pages for a given volume
get
Returns all bookmarked pages for a given series
post
Bookmarks a page against a Chapter
post
Removes a bookmarked page for a Chapter
get
Returns the next logical chapter from the series.
get
Returns the previous logical chapter from the series.
get
For the current user, returns an estimate on how long it would take to finish reading the series.
get
For the current user, returns an estimate on how long it would take to finish reading the chapter.
get
Returns the user's personal table of contents for the given chapter
delete
Deletes the user's personal table of content for the given chapter
post
Create a new personal table of content entry for a given chapter
get
Check if we should prompt the user for rereads for the given series
get
Check if we should prompt the user for rereads for the given volume
get
Check if we should prompt the user for rereads for the given chapter
get
/api/Reader/first-progress-date
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
Reader
Marks a Series as Unread. All volumes and chapters will be marked as unread during this process.
post
/api/Reader/mark-unread
Request body
MarkReadDto
required
seriesId
integer
generateReadingSession
boolean
Response
OK