/
KA
kareadita
Search skmtc…
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
Account
28
Activity
1
Admin
1
Annotation
12
Book
4
Cbl
14
Chapter
6
Collection
12
ColorScape
3
Device
10
Download
12
Email
1
Filter
12
Font
5
Health
1
Image
15
KavitaPlusAudit
6
Kobo
21
get
/Kobo/{apiKey}/v1/initialization
First request when starting the sync flow. Returns all config for the Kobo to make request. We inject some redirect to the Kavita instance Not intended for use beyond Kobo devices
get
/Kobo/{apiKey}/v1/library/sync
Returns changes since last sync Not intended for use beyond Kobo devices
get
/Kobo/{apiKey}/v1/library/{bookId}/metadata
Metadata for the given book. Called when opening information, and sometimes during sync but not always Not intended for use beyond Kobo devices
get
/Kobo/{apiKey}/v1/library/{bookId}/state
Gets progress. Called on book open to sync Not intended for use beyond Kobo devices
put
/Kobo/{apiKey}/v1/library/{bookId}/state
Updates progress. Call on book close and when switching chapters via ToC while connected to the internet. Otherwise, during sync Not intended for use beyond Kobo devices
get
/Kobo/{apiKey}/v1/library/{bookId}/file/epub
Gets the (k)epub file Not intended for use beyond Kobo devices
get
/Kobo/{apiKey}/v1/books/{thumbnailId}/thumbnail/{width}/{height}/{isGreyScale}/image.jpg
Gets the cover. Called during sync, and on extra info when missing Not intended for use beyond Kobo devices
get
/Kobo/{apiKey}/v1/books/{thumbnailId}/thumbnail/{width}/{height}/{quality}/{isGreyScale}/image.jpg
Gets the cover. Called during sync, and on extra info when missing Not intended for use beyond Kobo devices
post
/Kobo/{apiKey}/v1/library/{bookId}
Called when clicking on a recommendation. Adds the series to the Kobo sync collection if enabled Otherwise No-Op Not intended for use beyond Kobo devices
delete
/Kobo/{apiKey}/v1/library/{bookId}
Called when a book is deleted from the Kobo. Will no longer be synced to the Kobo. Can be restored in the UI Not intended for use beyond Kobo devices
get
/Kobo/{apiKey}/v1/products/{bookId}/reviews
Returns reviews for the book. Implemented to reduce upstream bad requests. Not intended for use beyond Kobo devices
put
/Kobo/{apiKey}/v1/products/{bookId}/reviews
Updates review for a book. Doesn't work 100%. Reviews are a bit weird on Kobo, needs more work Not intended for use beyond Kobo devices
get
/Kobo/{apiKey}/v1/products/{bookId}/recommendations
Returns the first books in a series that's recommended to the series the book belongs to Requires Kavita+ and Collection Sync Not intended for use beyond Kobo devices
get
/Kobo/{apiKey}/v1/products/books/{bookId}
Book metadata when viewing recommendations Not intended for use beyond Kobo devices
get
/Kobo/{apiKey}/v1/products/{bookId}/nextread
Implemented to reduce upstream bad requests. Called during sync, and sometimes otherwise Not intended for use beyond Kobo devices
get
/Kobo/{apiKey}/v1/products/books/series/{bookId}
Implemented to reduce upstream bad requests. Called during sync, and sometimes otherwise Not intended for use beyond Kobo devices
get
/Kobo/{apiKey}/v1/products/{bookIds}/prices
Implemented to reduce upstream bad requests. Always returns FREE Not intended for use beyond Kobo devices
get
/Kobo/{apiKey}/v1/user/reviews
Returns a list of reviews Not intended for use beyond Kobo devices
get
/Kobo/{apiKey}/v1/user/wishlist
Dummy implementation to reduce failure when forward is off. Returns an empty pagination response Not intended for use beyond Kobo devices
get
/Kobo/{apiKey}/v1/analytics/gettests
Dummy implementation Not intended for use beyond Kobo devices
post
/Kobo/{apiKey}/v1/analytics/gettests
Dummy implementation Not intended for use beyond Kobo devices
KoboAnnotation
3
Koreader
3
Library
25
License
13
Locale
1
Manage
2
Metadata
14
OAuth
2
Oidc
2
Opds
22
Panels
2
Person
10
Plugin
5
Rating
4
Reader
39
ReadingList
27
ReadingProfile
16
Review
6
Scrobbling
19
Search
4
Series
33
Server
24
Settings
23
Stats
34
Stream
17
Tachiyomi
2
Theme
7
Upload
13
Users
13
Volume
4
WantToRead
4
Kobo
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Called when a book is deleted from the Kobo. Will no longer be synced to the Kobo. Can be restored in the UI Not intended for use beyond Kobo devices
delete
/Kobo/{apiKey}/v1/library/{bookId}
Nov 8, 2026
aa5ebe03d820
Revision changes
info
endpoint added