BookDetailResponse

Detailed book response with metadata

book objectrequired

Book data transfer object

analysisErrorstring | nullnullable

Error message if book analysis failed

Example: Failed to parse CBZ: invalid archive

createdAtstring<date-time>required

When the book was added to the library

Example: 2024-01-01T00:00:00Z

deletedbooleanrequired

Whether the book has been soft-deleted

Example: false

fileFormatstringrequired

File format (cbz, cbr, epub, pdf)

Example: cbz

fileHashstringrequired

File hash for deduplication

Example: a1b2c3d4e5f6g7h8i9j0

filePathstringrequired

Filesystem path to the book file

Example: /media/comics/Batman/Batman - Year One 001.cbz

fileSizeinteger<int64>required

File size in bytes

Example: 52428800

idstring<uuid>required

Book unique identifier

Example: 550e8400-e29b-41d4-a716-446655440001

libraryIdstring<uuid>required

Library this book belongs to

Example: 550e8400-e29b-41d4-a716-446655440000

libraryNamestringrequired

Name of the library

Example: Comics

numberinteger,null<int32>nullable

Book number within the series

Example: 1

pageCountinteger<int32>required

Number of pages in the book

Example: 32

readProgress object

oneOf

null

null

ReadProgressResponse

book_idstring<uuid>required

Book ID

Example: 550e8400-e29b-41d4-a716-446655440002

completedbooleanrequired

Whether the book is completed

Example: false

completed_atstring,null<date-time>nullable

When the book was completed (if completed)

Example: 2024-01-20T20:00:00Z

current_pageinteger<int32>required

Current page (1-indexed)

Example: 42

idstring<uuid>required

Progress record ID

Example: 550e8400-e29b-41d4-a716-446655440000

progress_percentagenumber,null<double>nullable

Progress as a percentage (0.0-1.0) For EPUBs, this is the stored percentage from reflowable content For other formats, this is calculated from current_page / total_pages

Example: 0.45

started_atstring<date-time>required

When reading started

Example: 2024-01-10T14:30:00Z

updated_atstring<date-time>required

When progress was last updated

Example: 2024-01-15T18:45:00Z

user_idstring<uuid>required

User ID

Example: 550e8400-e29b-41d4-a716-446655440001

readingDirectionstring | nullnullable

Effective reading direction (from series metadata, or library default if not set) Values: ltr, rtl, ttb or webtoon

Example: ltr

seriesIdstring<uuid>required

Series this book belongs to

Example: 550e8400-e29b-41d4-a716-446655440002

seriesNamestringrequired

Name of the series

Example: Batman: Year One

sortTitlestring | nullnullable

Sort title for ordering

Example: batman year one 001

titlestringrequired

Book title

Example: Batman: Year One #1

updatedAtstring<date-time>required

When the book was last updated

Example: 2024-01-15T10:30:00Z

metadata object

oneOf

null

null

BookMetadataDto

bookIdstring<uuid>required

Associated book ID

Example: 550e8400-e29b-41d4-a716-446655440001

coloristsstring[]required

Colorists

Example: ["Richmond Lewis"]

coverArtistsstring[]required

Cover artists

Example: ["David Mazzucchelli"]

editorsstring[]required

Editors

Example: ["Dennis O'Neil"]

genrestring | nullnullable

Genre

Example: Superhero

idstring<uuid>required

Metadata record ID

Example: 550e8400-e29b-41d4-a716-446655440003

imprintstring | nullnullable

Imprint name

Example: DC Black Label

inkersstring[]required

Inkers

Example: ["David Mazzucchelli"]

languageIsostring | nullnullable

ISO language code

Example: en

letterersstring[]required

Letterers

Example: ["Todd Klein"]

numberstring | nullnullable

Issue/chapter number from metadata

Example: 1

pageCountinteger,null<int32>nullable

Page count from metadata

Example: 32

pencillersstring[]required

Pencillers (line artists)

Example: ["David Mazzucchelli"]

publisherstring | nullnullable

Publisher name

Example: DC Comics

releaseDatestring,null<date-time>nullable

Release/publication date

Example: 1987-02-01T00:00:00Z

seriesstring | nullnullable

Series name from metadata

Example: Batman: Year One

summarystring | nullnullable

Book summary/description

Example: Bruce Wayne returns to Gotham City after years abroad to begin his war on crime.

titlestring | nullnullable

Book title from metadata

Example: Batman: Year One #1

writersstring[]required

Writers/authors

Example: ["Frank Miller"]

BookDetailResponse

{
  "book": {
    "analysisError": "Failed to parse CBZ: invalid archive",
    "createdAt": "2024-01-01T00:00:00Z",
    "deleted": false,
    "fileFormat": "cbz",
    "fileHash": "a1b2c3d4e5f6g7h8i9j0",
    "filePath": "/media/comics/Batman/Batman - Year One 001.cbz",
    "fileSize": 52428800,
    "id": "550e8400-e29b-41d4-a716-446655440001",
    "libraryId": "550e8400-e29b-41d4-a716-446655440000",
    "libraryName": "Comics",
    "number": 1,
    "pageCount": 32,
    "readProgress": "null",
    "readingDirection": "ltr",
    "seriesId": "550e8400-e29b-41d4-a716-446655440002",
    "seriesName": "Batman: Year One",
    "sortTitle": "batman year one 001",
    "title": "Batman: Year One #1",
    "updatedAt": "2024-01-15T10:30:00Z"
  },
  "metadata": "null"
}