AdjacentBooksResponse

Response containing adjacent books in the same series

Returns the previous and next books relative to the requested book, ordered by book number within the series.

next object

oneOf

null

null

BookDto

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

prev object

oneOf

null

null

BookDto

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

AdjacentBooksResponse

{
  "next": "null",
  "prev": "null"
}