Komga API Documentation

Komga typically passes raw image data to the client if the client can decode the format. However, Komga must decode images internally for the following specific tasks:

• Generating thumbnails
• Detecting ISBN barcodes
• Analyzing page dimensions
• Performing on-the-fly page conversion

Komga's Kobo integration allows a Kobo eReader to sync with a Komga server instead of official Kobo servers.

Supported Features:

• Syncs EPUB books, metadata, and cover images from all libraries.
• Metadata and cover edits in Komga are updated on the Kobo device.
• Deleting books in Komga removes them from the Kobo device.
• Two-way read progress synchronization.
• On-the-fly conversion of EPUB to KEPUB (if Kepubify is configured).
• Optional proxying to official Kobo servers (via Server Settings) to allow access to official Kobo purchases.

Read Progress Caveats:

• Pre-paginated books: Accurate per page.
• Regular EPUBs: Progress is only tracked at the start of chapters; mid-chapter progress is lost when switching between Kobo and Komga.
• KEPUB books: Progress mapping may be off by a few pages due to Kobo's internal tracking mechanism.

KMReader is a native client for Komga providing the following capabilities:

• DIVINA Reader: Supports LTR/RTL/vertical/Webtoon modes, spreads, zoom, and page curl transitions.
• EPUB Reader: Supports custom fonts (.ttf/.otf), theme presets, multi-column layouts, and nested TOC navigation.
• Admin Tools: Provides metadata editing, library scans, task management, and live metrics via SSE.
• Browsing: Deep metadata filters (all/any logic), customizable dashboards, and grid/list layouts.
• Caching: Three-tier caching for pages, books, and thumbnails with auto-cleanup.

Kasane is a modern comic reader for iOS/iPadOS that inherits server-side metadata and organization from Komga. Key features include:

• Multi-instance aggregation: Connect multiple Komga and OPDS sources into a unified home view (requires in-app purchase for more than one remote source).
• Compound filters: Multi-dimensional filtering by authors, genres, tags, and read status.
• Flexible reading modes: Supports single-page, double-page (spreads), webtoon (vertical scroll), and page offset, with settings remembered per series.
• Smart reading tools: Wide-image splitting, spread stitching, and a page-jump slider with thumbnails.
• iCloud sync: Synchronizes app preferences, library settings, and server configurations across devices.

The Webreader provides two primary tools for navigation and assistance:

1. Thumbnails explorer: Provides a visual overview of all pages in a book for quick navigation to a specific page.
2. Help dialog: Displays available keyboard shortcuts. This dialog is context-aware and only shows shortcuts relevant to the active reading mode.

Komga tracks reading progress independently for each user. Progress is visualized on book and series cards as follows:

• Unread Books: An orange tick appears in the top right corner of the book card.
• In Progress Books: A progress bar is displayed at the bottom of the book thumbnail.
• Series: The series card displays the total number of unread books in the top right corner.

Komga uses a 'trash' system to prevent accidental data loss. If a file is moved, deleted, or becomes unavailable (e.g., a network share is offline during a scan), the library item is placed in the trash and marked with an 'Unavailable' indicator rather than being permanently removed.

Items in the trash can be restored to the library simply by making the file available again at its expected location. Once the trash is emptied, items are permanently discarded and cannot be automatically restored.