Books

List, search, and manage books

This guide covers common book workflows using BookService.

List books

import { BookService } from 'komga-sdk';

const service = new BookService(client);
const page = await service.list({ page: 0, size: 20 });

console.log(page.totalElements);

Search books

const page = await service.list({
  search: { fullTextSearch: 'manga' },
  page: 0,
  size: 20,
  sort: ['metadata.title,asc'],
});

Get a book by ID

const book = await service.getById('book-123');
console.log(book.metadata.title);

Update metadata

await service.updateMetadata('book-123', {
  title: 'New Title',
  summary: 'Updated summary',
});

Get pages

const pages = await service.getPages('book-123');
console.log(pages.length);

Delete read progress

await service.deleteReadProgress('book-123');

Thumbnails

const url = service.getThumbnailUrl('book-123');
// /api/v1/books/book-123/thumbnail

Next steps

• Series guide: Series
• Pagination details: Pagination