Skip to content
Grimmory
Search
Ctrl
K
Cancel
GitHub
Discord
Select theme
Dark
Light
Auto
Docs
API
Getting Started
Installation
Setup Admin User
Dashboard
Library
Setup First Library
Edit Library
Organization Modes
Physical Books
Duplicate Detection
Bookdrop
Bookdrop Basics
Advanced Features
Books & Collections
Notebook
Library Statistics
Reading Statistics
Magic Shelf
Shelf
Series
Authors
Grid View
Table View
Metadata
Metadata Center
Metadata Settings
Fetch Configuration
File Naming Patterns
Metadata Manager
Sidecar Files
Amazon Cookie
Hardcover API
LubimyCzytac
RanobeDB
Reader & Display
EPUB Reader
PDF Reader
Comic Reader
Audiobook Player
Reader Preferences
View Preferences
Integrations
Kobo
KOReader
OPDS
Komga API
Authentication
Overview
OIDC Settings
OIDC Identity Providers
Authentik
Pocket ID
Authelia
Administration
Content Restrictions
User Management
Email Setup
System Task Manager
Audit Logs
Global Preferences
Devices
Customization
Custom Icons
Custom Fonts
Cover Art Settings
Overview
Bookdrop
Overview
Rescan bookdrop folder
POST
Finalize bookdrop import
POST
Extract metadata from filenames using pattern
POST
Discard selected bookdrop files
POST
Bulk edit metadata for selected files
POST
Get bookdrop notification summary
GET
Get bookdrop files by status
GET
App Authors
Overview
List app authors
GET
Get app author details
GET
OIDC Authentication
Overview
Handle OIDC mobile callback
POST
Handle OIDC callback
POST
Handle OIDC backchannel logout
POST
Generate OIDC state
GET
Handle OIDC redirect callback
GET
Bookmarks
Overview
Get a specific bookmark
GET
Update a bookmark
PUT
Delete a bookmark
DELETE
Create a bookmark
POST
Get bookmarks for a book
GET
Library Paths
Overview
Get folders at a path
GET
OIDC Group Mappings
Overview
Update OIDC group mapping
PUT
Delete OIDC group mapping
DELETE
List OIDC group mappings
GET
Create OIDC group mapping
POST
Book Notes
Overview
Create or update a note
POST
Get notes for a book
GET
Delete a note
DELETE
Metadata Tasks
Overview
Update proposal status
POST
Get metadata task with proposals
GET
Delete a metadata task
DELETE
Get active metadata tasks
GET
Authors
Overview
Get author details
GET
Update author
PUT
Quick-match author
POST
Upload author photo from URL
POST
Upload author photo
POST
Match author metadata
POST
Unmatch authors
POST
Auto-match authors
POST
Get all authors
GET
Delete authors
DELETE
Search author photos
GET
Search author metadata
GET
Find author by name
GET
Get authors by book ID
GET
Books
Overview
Get viewer settings
GET
Update viewer settings
PUT
Get book content
GET
Replace book content
PUT
Update personal rating
PUT
Attach book files
POST
Update read status
POST
Assign books to shelves
POST
Reset reading progress
POST
Reset personal rating
POST
Update read progress
POST
Create a physical book
POST
Find duplicate books
POST
Toggle physical book flag
PATCH
Get all books
GET
Delete books
DELETE
Get book recommendations
GET
Get a book by ID
GET
Get file metadata
GET
Download book
GET
Download all book files
GET
Get ComicInfo metadata
GET
Get books (paginated)
GET
Get books by IDs
GET
Healthcheck
Overview
Get a ping response
GET
Kobo Settings
Overview
Get Kobo sync settings
GET
Update Kobo settings
PUT
Create or update Kobo token
PUT
PDF Reader
Overview
List pages in a PDF book
GET
Get book info for a PDF book
GET
Hardcover Sync Settings
Overview
Get Hardcover sync settings
GET
Update Hardcover sync settings
PUT
KoReader
Overview
Update KoReader progress
PUT
Create KoReader user (disabled)
POST
Authorize KoReader user
GET
Get KoReader progress
GET
Notebook
Overview
Get paginated notebook entries
GET
Get all notebook entries for export
GET
Get books that have annotations
GET
Magic Shelves
Overview
Get all magic shelves for user
GET
Create or update a magic shelf
POST
Get a magic shelf by ID
GET
Delete a magic shelf
DELETE
Book Metadata
Overview
Update book metadata
PUT
Toggle field locks for metadata
PUT
Toggle all metadata locks
PUT
Bulk edit book metadata
PUT
Regenerate cover for a book
POST
Regenerate audiobook cover for a book
POST
Get prospective metadata for a book
POST
Get cover images for a book
POST
Upload cover image from file
POST
Upload cover image from URL
POST
Upload audiobook cover image from file
POST
Upload audiobook cover image from URL
POST
Generate custom cover for a book
POST
Generate custom audiobook cover for a book
POST
Regenerate all covers
POST
Recalculate metadata match scores
POST
Delete metadata values
POST
Consolidate metadata
POST
Lookup metadata by ISBN
POST
Upload cover image for multiple books
POST
Regenerate covers for selected books
POST
Generate custom covers for selected books
POST
Get detailed metadata from provider
GET
Send Email
Overview
Send book by email
POST
Quick send book by email
POST
Book Reviews
Overview
Refresh reviews for a book
POST
List reviews for a book
GET
Delete all reviews for a book
DELETE
Delete a review
DELETE
File Move
Overview
Move files
POST
Authentication
Overview
Register a new user
POST
Refresh JWT token
POST
Logout user
POST
Login user
POST
Remote login
GET
File Upload
Overview
Upload a file
POST
Upload a book via BookDrop
POST
Kobo Integration
Overview
Catch-all for Kobo API
GET
Catch-all for Kobo API
PUT
Catch-all for Kobo API
POST
Catch-all for Kobo API
DELETE
Catch-all for Kobo API
PATCH
Get reading state
GET
Update reading state
PUT
Update Rating
POST
Get Kobo Next to Read
POST
Authenticate Kobo device
POST
Get Kobo test analytics
POST
Publish analytics event
POST
Get user profile
GET
Get book metadata
GET
Sync Kobo library
GET
Initialize Kobo resources
GET
Get Kobo Deals
GET
Get book thumbnail
GET
Get book thumbnail
GET
Get book thumbnail
GET
Get book thumbnail
GET
Download Kobo book
GET
Delete book from Kobo library
DELETE
Annotations
Overview
Get a specific annotation
GET
Update an annotation
PUT
Delete an annotation
DELETE
Create an annotation
POST
Get annotations for a book
GET
Email Recipients
Overview
Get an email recipient by ID
GET
Update an email recipient
PUT
Delete an email recipient
DELETE
Get all email recipients
GET
Create an email recipient
POST
Set default email recipient
PATCH
App Series
Overview
List app series
GET
List books in app series
GET
Setup
Overview
Setup first user
POST
Get setup status
GET
Users
Overview
Get user by ID
GET
Update user
PUT
Delete user
DELETE
Update user settings
PUT
Update user profile
PUT
Change another user's password
PUT
Change password
PUT
Get all users
GET
Get current user
GET
OPDS Users
Overview
Get all OPDS users
GET
Create OPDS user
POST
Delete OPDS user
DELETE
Update OPDS user
PATCH
Custom Fonts
Overview
Upload a custom font
POST
Get all user's custom fonts
GET
Get font file
GET
Delete a custom font
DELETE
Audit Logs
Overview
Get audit logs
GET
Get distinct usernames
GET
App Settings
Overview
Get application settings
GET
Update application settings
PUT
testOidcConnection
POST
CBX Reader
Overview
List pages in a CBX book
GET
Get page info for a CBX book
GET
Get page dimensions for a CBX book
GET
EPUB Reader
Overview
Get EPUB book info
GET
Get file from EPUB
GET
Libraries
Overview
Get a library by ID
GET
Update a library
PUT
Delete a library
DELETE
Rescan a library
PUT
Get all libraries
GET
Create a library
POST
Scan library paths
POST
Set file naming pattern
PATCH
Get book counts by format
GET
Get all books from a library
GET
Get a book from a library
GET
Get library health
GET
Audiobook Reader
Overview
Stream specific track
GET
Stream audiobook audio
GET
Get audiobook info
GET
Get embedded cover art
GET
App Libraries
Overview
List app libraries
GET
Version
Overview
Get application version
GET
Get changelog since current version
GET
Icons
Overview
Get paginated icon names
GET
Save an SVG icon
POST
Save multiple SVG icons
POST
Get SVG icon content
GET
Get all icon contents
GET
Delete an SVG icon
DELETE
Tasks
Overview
Start task
POST
Update task cron configuration
PATCH
List available tasks
GET
Get latest tasks by type
GET
Cancel task
DELETE
App Users
Overview
Get current app user
GET
Komga API
Overview
Get current user details
GET
List series
GET
Get series details
GET
Get series thumbnail
GET
List books in series
GET
List all libraries
GET
Get library details
GET
List collections
GET
List books
GET
Get book details
GET
Get book thumbnail
GET
Get book pages metadata
GET
Get book page image
GET
Download book file
GET
Email Providers
Overview
Get an email provider by ID
GET
Update an email provider
PUT
Delete an email provider
DELETE
Get all email providers
GET
Create an email provider
POST
Set default email provider
PATCH
App Filters
Overview
Get app filter options
GET
User Stats
Overview
Get reading session timeline for a week
GET
Get reading streak
GET
Get reading speed analysis
GET
Get session scatter data
GET
Get peak reading hours
GET
Get page turner scores
GET
Get reading session heatmap for a year
GET
Get reading session heatmap for a month
GET
Get genre statistics
GET
Get favorite reading days
GET
Get all reading dates
GET
Get completion timeline
GET
Get completion race data
GET
Get book timeline for a year
GET
Get book distribution statistics
GET
Get book completion heatmap
GET
Get weekly listening trend
GET
Get listening session scatter data
GET
Get listening peak hours
GET
Get monthly audiobook pace
GET
Get longest listened audiobooks
GET
Get listening heatmap for a month
GET
Get listening genre statistics
GET
Get audiobook finish rate funnel
GET
Get listening favorite days
GET
Get audiobook completion progress
GET
Get listening author statistics
GET
App Shelves
Overview
List app shelves
GET
List app magic shelves
GET
List books in app magic shelf
GET
App Notebook
Overview
Update notebook entry
PUT
Delete notebook entry
DELETE
List notebook books
GET
List notebook entries for book
GET
KoReader Users
Overview
Get current KoReader user
GET
Upsert current KoReader user
PUT
Toggle KoReader sync
PATCH
Toggle sync progress with web reader
PATCH
[Deprecated] Toggle sync progress with web reader
PATCH
Content Restrictions
Overview
Get user content restrictions
GET
Update all content restrictions
PUT
Add content restriction
POST
Delete all user content restrictions
DELETE
Delete content restriction
DELETE
Reading Sessions
Overview
Record a reading session
POST
Get reading sessions for a book
GET
Shelves
Overview
Get a shelf by ID
GET
Update a shelf
PUT
Delete a shelf
DELETE
Get all shelves
GET
Create a shelf
POST
Get books on a shelf
GET
Book Files
Overview
List additional files by type
GET
Upload additional book file
POST
Detach additional book file
POST
Download additional book file
GET
Delete additional book file
DELETE
PDF Annotations
Overview
Get PDF annotations for a book
GET
Save PDF annotations for a book
PUT
Delete PDF annotations for a book
DELETE
OPDS
Overview
Get OPDS root catalog
GET
Download book file
GET
Get book cover image
GET
Get surprise feed
GET
Get OPDS shelves navigation
GET
Get OPDS series navigation
GET
Get OPDS search description
GET
Get recent books feed
GET
Get OPDS magic shelves navigation
GET
Get OPDS libraries navigation
GET
Get OPDS catalog feed
GET
Get OPDS authors navigation
GET
Book Notes V2
Overview
Get a specific note
GET
Update a note
PUT
Delete a note
DELETE
Create a note
POST
Get notes for a book
GET
Sidecar Metadata
Overview
Bulk import sidecar for library
POST
Bulk export sidecar for library
POST
Import metadata from sidecar
POST
Export metadata to sidecar
POST
Get sidecar content
GET
Get sidecar sync status
GET
Public App Settings
Overview
Get public app settings
GET
App Books
Overview
Update app book read status
PUT
Update app book rating
PUT
getBookProgress
GET
updateBookProgress
PUT
List app books
GET
Get app book details
GET
Search app books
GET
Get recently scanned books
GET
Get recently added books
GET
Get random app books
GET
Get all book IDs matching filters
GET
Get continue reading books
GET
Get continue listening books
GET
Book Media
Overview
Get bookdrop cover
GET
Get book thumbnail
GET
Get book cover
GET
Get CBX page as image
GET
Get audiobook thumbnail
GET
Get audiobook cover
GET
Get author thumbnail
GET
Get author photo
GET
GitHub
Discord
Select theme
Dark
Light
Auto
Overview
App Users
Section titled “App Users”
Endpoints for retrieving app user capabilities and profile information
Operations
Section titled “ Operations ”
GET
/api/v1/app/users/me