# Kavita Reader API

**Canonical:** https://apis.io/apis/kavita/kavita-reader-api/  
**Provider:** Kavita — https://apis.io/providers/kavita/  
**Documentation:** https://wiki.kavitareader.com/

Kavita Reader API is one of 48 APIs that [Kavita](https://apis.io/providers/kavita/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Reader. The published artifact set on APIs.io includes an OpenAPI specification.

For all things regarding reading, mainly focusing on non-Book related entities

## Operations (39)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/Reader/pdf` | Returns the PDF for the chapterId |
| GET | `/api/Reader/image` | Returns an image for a given chapter. Will perform bounding checks |
| GET | `/api/Reader/thumbnail` | Returns a thumbnail for the given page number |
| GET | `/api/Reader/bookmark-image` | Returns an image for a given bookmark series. |
| GET | `/api/Reader/file-dimensions` | Returns the file dimensions for all pages in a chapter. |
| GET | `/api/Reader/chapter-info` | Returns various information about a Chapter. |
| GET | `/api/Reader/bookmark-info` | Returns various information about all bookmark files for a Series. |
| POST | `/api/Reader/mark-chapter-read` | Mark a single chapter as read |
| POST | `/api/Reader/mark-read` | Marks a Series as read. |
| POST | `/api/Reader/mark-unread` | Marks a Series as Unread. |
| POST | `/api/Reader/mark-volume-unread` | Marks all chapters within a volume as unread |
| POST | `/api/Reader/mark-volume-read` | Marks all chapters within a volume as Read |
| POST | `/api/Reader/mark-multiple-read` | Marks all chapters within a list of volumes as Read. |
| POST | `/api/Reader/mark-multiple-unread` | Marks all chapters within a list of volumes as Unread. |
| POST | `/api/Reader/mark-multiple-series-read` | Marks all chapters within a list of series as Read |
| POST | `/api/Reader/mark-multiple-series-unread` | Marks all chapters within a list of series as Unread |
| GET | `/api/Reader/get-progress` | Returns Progress (page number) for a chapter for the logged in user |
| POST | `/api/Reader/progress` | Save page against Chapter for authenticated user |
| GET | `/api/Reader/continue-point` | Continue point is the chapter which you should start reading again from. |
| GET | `/api/Reader/has-progress` | Returns if the user has reading progress on the Series |
| GET | `/api/Reader/chapter-bookmarks` | Returns a list of bookmarked pages for a given Chapter |
| POST | `/api/Reader/all-bookmarks` | Returns a list of all bookmarked pages for a User |
| POST | `/api/Reader/remove-bookmarks` | Removes all bookmarks for all chapters linked to a Series |
| POST | `/api/Reader/bulk-remove-bookmarks` | Removes all bookmarks for all chapters linked to a Series |
| GET | `/api/Reader/volume-bookmarks` | Returns all bookmarked pages for a given volume |
| GET | `/api/Reader/series-bookmarks` | Returns all bookmarked pages for a given series |
| POST | `/api/Reader/bookmark` | Bookmarks a page against a Chapter |
| POST | `/api/Reader/unbookmark` | Removes a bookmarked page for a Chapter |
| GET | `/api/Reader/next-chapter` | Returns the next logical chapter from the series |
| GET | `/api/Reader/prev-chapter` | Returns the previous logical chapter from the series |
| GET | `/api/Reader/time-left` | For the current user, returns an estimate on how long it would take to finish… |
| GET | `/api/Reader/time-left-for-chapter` | For the current user, returns an estimate on how long it would take to finish… |
| GET | `/api/Reader/ptoc` | Returns the user's personal table of contents for the given chapter |
| DELETE | `/api/Reader/ptoc` | Deletes the user's personal table of content for the given chapter |
| POST | `/api/Reader/create-ptoc` | Create a new personal table of content entry for a given chapter |
| GET | `/api/Reader/prompt-reread/series` | Check if we should prompt the user for rereads for the given series |
| GET | `/api/Reader/prompt-reread/volume` | Check if we should prompt the user for rereads for the given volume |
| GET | `/api/Reader/prompt-reread/chapter` | Check if we should prompt the user for rereads for the given chapter |
| GET | `/api/Reader/first-progress-date` | Get api reader first progress date |

## Machine-readable artifacts (1)

- **OpenAPI** — https://artifacts.apis.io/kavita/openapi/kavita-reader-api-openapi.yml

## Other Kavita APIs (12)

- [Kavita API](https://apis.io/apis/kavita/kavita-api/)
- [Kavita Account API](https://apis.io/apis/kavita/kavita-account-api/)
- [Kavita Activity API](https://apis.io/apis/kavita/kavita-activity-api/)
- [Kavita Admin API](https://apis.io/apis/kavita/kavita-admin-api/)
- [Kavita Annotation API](https://apis.io/apis/kavita/kavita-annotation-api/)
- [Kavita Book API](https://apis.io/apis/kavita/kavita-book-api/)
- [Kavita Cbl API](https://apis.io/apis/kavita/kavita-cbl-api/)
- [Kavita Chapter API](https://apis.io/apis/kavita/kavita-chapter-api/)
- [Kavita Collection API](https://apis.io/apis/kavita/kavita-collection-api/)
- [Kavita Color Scape API](https://apis.io/apis/kavita/kavita-colorscape-api/)
- [Kavita Device API](https://apis.io/apis/kavita/kavita-device-api/)
- [Kavita Download API](https://apis.io/apis/kavita/kavita-download-api/)

## Tags

Reader

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/kavita/kavita-reader-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/kavita/.
