/

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

License13

Locale1

Manage2

Metadata14

OAuth2

Oidc2

Opds22

Panels2

Person10

Plugin5

Rating4

Reader39

get/api/Reader/pdfReturns the PDF for the chapterId.
get/api/Reader/imageReturns an image for a given chapter. Will perform bounding checks
get/api/Reader/thumbnailReturns a thumbnail for the given page number
get/api/Reader/bookmark-imageReturns an image for a given bookmark series. Side effect: This will cache the bookmark images for reading.
get/api/Reader/file-dimensionsReturns the file dimensions for all pages in a chapter. If the underlying chapter is PDF, use extractPDF to unpack as images.
get/api/Reader/chapter-infoReturns various information about a Chapter. Side effect: This will cache the chapter images for reading.
get/api/Reader/bookmark-infoReturns various information about all bookmark files for a Series. Side effect: This will cache the bookmark images for reading.
post/api/Reader/mark-chapter-readMark a single chapter as read
post/api/Reader/mark-readMarks a Series as read. All volumes and chapters will be marked as read during this process.
post/api/Reader/mark-unreadMarks a Series as Unread. All volumes and chapters will be marked as unread during this process.
post/api/Reader/mark-volume-unreadMarks all chapters within a volume as unread
post/api/Reader/mark-volume-readMarks all chapters within a volume as Read
post/api/Reader/mark-multiple-readMarks all chapters within a list of volumes as Read. All volumes must belong to the same Series.
post/api/Reader/mark-multiple-unreadMarks all chapters within a list of volumes as Unread. All volumes must belong to the same Series.
post/api/Reader/mark-multiple-series-readMarks all chapters within a list of series as Read.
post/api/Reader/mark-multiple-series-unreadMarks all chapters within a list of series as Unread.
get/api/Reader/get-progressReturns Progress (page number) for a chapter for the logged in user
post/api/Reader/progressSave page against Chapter for authenticated user
get/api/Reader/continue-pointContinue 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/api/Reader/has-progressReturns if the user has reading progress on the Series
get/api/Reader/chapter-bookmarksReturns a list of bookmarked pages for a given Chapter
post/api/Reader/all-bookmarksReturns a list of all bookmarked pages for a User
post/api/Reader/remove-bookmarksRemoves all bookmarks for all chapters linked to a Series
post/api/Reader/bulk-remove-bookmarksRemoves all bookmarks for all chapters linked to a Series
get/api/Reader/volume-bookmarksReturns all bookmarked pages for a given volume
get/api/Reader/series-bookmarksReturns all bookmarked pages for a given series
post/api/Reader/bookmarkBookmarks a page against a Chapter
post/api/Reader/unbookmarkRemoves a bookmarked page for a Chapter
get/api/Reader/next-chapterReturns the next logical chapter from the series.
get/api/Reader/prev-chapterReturns the previous logical chapter from the series.
get/api/Reader/time-leftFor the current user, returns an estimate on how long it would take to finish reading the series.
get/api/Reader/time-left-for-chapterFor the current user, returns an estimate on how long it would take to finish reading the chapter.
get/api/Reader/ptocReturns the user's personal table of contents for the given chapter
delete/api/Reader/ptocDeletes the user's personal table of content for the given chapter
post/api/Reader/create-ptocCreate a new personal table of content entry for a given chapter
get/api/Reader/prompt-reread/seriesCheck if we should prompt the user for rereads for the given series
get/api/Reader/prompt-reread/volumeCheck if we should prompt the user for rereads for the given volume
get/api/Reader/prompt-reread/chapterCheck if we should prompt the user for rereads for the given chapter
get/api/Reader/first-progress-date

ReadingList27

ReadingProfile16

Review6

Scrobbling19

Search4

Series33

Server24

Settings20

Stats34

Stream17

Tachiyomi2

Theme7

Upload13

Users10

Volume4

WantToRead4

Reader

Changes to Mark a single chapter as read

post/api/Reader/mark-chapter-read

Mar 19, 20261acacd51149a Revision changes
- info
  endpoint added