KAkareadita
Reader

Returns various information about a Chapter. Side effect: This will cache the chapter images for reading.

Changed on

This is generally the first call when attempting to read to allow pre-generation of assets needed for reading

get/api/Reader/chapter-info

Request

  • Base URL
    http://localhost:5000
  • URL
    http://localhost:5000/api/Reader/chapter-info
  • Auth
    API key in header x-api-key

Query parameters

chapterIdinteger
extractPdfboolean

Should Kavita extract pdf into images. Defaults to false.

includeDimensionsboolean

Include file dimensions. Only useful for image-based reading

Response

OK

chapterNumberstring nullable
volumeNumberstring nullable
volumeIdinteger
seriesNamestring nullable
seriesFormat0 | 1 | 2 | 3 | 4

Members:

  • 0 — Image
  • 1 — Archive
  • 2 — Unknown
  • 3 — EPUB (Epub)
  • 4 — PDF (Pdf)
seriesIdinteger
libraryIdinteger
libraryType0 | 1 | 2 | 3 | 4 | 5

Members:

  • 0 — Manga
  • 1 — Comic (Flexible) (Comic)
  • 2 — Book
  • 3 — Image
  • 4 — Light Novel (LightNovel)
  • 5 — Comic (ComicVine)
chapterTitlestring nullable
pagesinteger
fileNamestring nullable
isSpecialboolean
subtitlestring nullable
titlestring nullable
seriesTotalPagesinteger
seriesTotalPagesReadinteger
seriesPublicationStatus0 | 1 | 2 | 3 | 4

Members:

  • 0 — Ongoing (OnGoing)
  • 1 — Hiatus
  • 2 — Completed
  • 3 — Cancelled
  • 4 — Ended
doublePairsobject nullable

Changes

  • ec3a6f1eae66Revision changes
    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)