Books
Book details and metadata endpoints
List books with pagination
List books with pagination
List books with errors (grouped by error type)
Returns books with errors grouped by error type, with counts and pagination.
List books with reading progress (in-progress books)
List books with reading progress (in-progress books)
List books with advanced filtering
Supports complex filter conditions including nested AllOf/AnyOf logic,
List on-deck books (next unread book in series where user has completed at least one book)
List on-deck books (next unread book in series where user has completed at least one book)
List recently added books
List recently added books
List recently read books (ordered by last read activity)
List recently read books (ordered by last read activity)
Retry all failed operations across all books
Enqueues appropriate tasks for all books with errors.
Get book by ID
Get book by ID
Update book core fields (title, number)
Partially updates book_metadata fields. Only provided fields will be updated.
Get adjacent books in the same series
Returns the previous and next books relative to the requested book,
Upload a custom cover image for a book
Accepts a multipart form with an image file. The image will be stored
List all covers for a book
List all covers for a book
Reset book cover to default (deselect all custom covers)
Reset book cover to default (deselect all custom covers)
Delete a specific cover for a book
Delete a specific cover for a book
Get a specific cover image for a book
Get a specific cover image for a book
Select a cover as the primary cover for a book
Select a cover as the primary cover for a book
List all external IDs for a book
List all external IDs for a book
Create or update an external ID for a book
Upserts by book_id + source: if an external ID with the same source already exists,
Delete an external ID by ID
Delete an external ID by ID
List all external links for a book
List all external links for a book
Create or update an external link for a book
Upserts by book_id + source_name: if a link with the same source already exists,
Delete an external link by source name
Delete an external link by source name
Download book file
Streams the original book file (CBZ, CBR, EPUB, PDF) for download.
Get a book with its metadata, genres and tags in one response
The same book `GET /api/v1/books/{book_id}` returns, plus the related data a
Replace all book metadata (PUT)
Completely replaces all metadata fields. Omitted or null fields will be cleared.
Partially update book metadata (PATCH)
Only provided fields will be updated. Absent fields are unchanged.
Get book metadata lock states
Returns which metadata fields are locked (protected from automatic updates).
Update book metadata lock states
Updates which metadata fields are locked. Only provided fields will be updated.
List pages for a book
Returns page metadata including dimensions for analyzed books.
Retry failed operations for a specific book
Enqueues appropriate tasks based on the error types present or specified.
List books in a specific library
List books in a specific library
List books with reading progress in a specific library (in-progress books)
List books with reading progress in a specific library (in-progress books)
List on-deck books in a specific library
List on-deck books in a specific library
List recently added books in a specific library
List recently added books in a specific library
List recently read books in a specific library
List recently read books in a specific library