KomgaBookDto

Komga book DTO

Based on actual Komic traffic analysis. This is the main book representation.

createdstringrequired

Created timestamp (ISO 8601)

deletedboolean

Whether book is deleted (soft delete)

fileHashstring

File hash

fileLastModifiedstringrequired

File last modified timestamp (ISO 8601)

idstringrequired

Book unique identifier (UUID as string)

lastModifiedstringrequired

Last modified timestamp (ISO 8601)

libraryIdstringrequired

Library ID

media objectrequired

Media information

commentstring

Comment/notes about media analysis

epubDivinaCompatibleboolean

Whether EPUB is DIVINA-compatible

epubIsKepubboolean

Whether EPUB is a KePub file

mediaProfilestringrequired

Media profile (DIVINA for comics/manga, PDF for PDFs)

mediaTypestringrequired

MIME type (e.g., "application/zip", "application/epub+zip", "application/pdf")

pagesCountinteger<int32>required

Number of pages

statusstringrequired

Media status (READY, UNKNOWN, ERROR, UNSUPPORTED, OUTDATED)

metadata objectrequired

Book metadata

authors object[]

Authors list

Array [

namestringrequired

Author name

rolestringrequired

Author role (WRITER, PENCILLER, INKER, COLORIST, LETTERER, COVER, EDITOR)

]

authorsLockboolean

Whether authors are locked

createdstringrequired

Created timestamp (ISO 8601)

isbnstring

ISBN

isbnLockboolean

Whether ISBN is locked

lastModifiedstringrequired

Last modified timestamp (ISO 8601)

links object[]

Links

Array [

labelstringrequired

Link label

urlstringrequired

Link URL

]

linksLockboolean

Whether links are locked

numberstringrequired

Book number (display string)

numberLockboolean

Whether number is locked

numberSortnumber<double>required

Number for sorting (float for chapter ordering)

numberSortLockboolean

Whether number_sort is locked

releaseDatestring | nullnullable

Release date (YYYY-MM-DD or full ISO 8601)

releaseDateLockboolean

Whether release_date is locked

summarystring

Book summary

summaryLockboolean

Whether summary is locked

tagsstring[]

Tags list

tagsLockboolean

Whether tags are locked

titlestringrequired

Book title

titleLockboolean

Whether title is locked

namestringrequired

Book filename/name

numberinteger<int32>required

Book number in series

oneshotboolean

Whether this is a oneshot

readProgress object

oneOf

• null
• KomgaReadProgressDto

null

seriesIdstringrequired

Series ID

seriesTitlestringrequired

Series title (required by Komic for display)

sizestringrequired

Human-readable file size (e.g., "869.9 MiB")

sizeBytesinteger<int64>required

File size in bytes

urlstringrequired

File URL/path

KomgaBookDto

{
  "created": "string",
  "deleted": true,
  "fileHash": "string",
  "fileLastModified": "string",
  "id": "string",
  "lastModified": "string",
  "libraryId": "string",
  "media": {
    "comment": "string",
    "epubDivinaCompatible": true,
    "epubIsKepub": true,
    "mediaProfile": "string",
    "mediaType": "string",
    "pagesCount": 0,
    "status": "string"
  },
  "metadata": {
    "authors": [
      {
        "name": "string",
        "role": "string"
      }
    ],
    "authorsLock": true,
    "created": "string",
    "isbn": "string",
    "isbnLock": true,
    "lastModified": "string",
    "links": [
      {
        "label": "string",
        "url": "string"
      }
    ],
    "linksLock": true,
    "number": "string",
    "numberLock": true,
    "numberSort": 0,
    "numberSortLock": true,
    "releaseDate": "string",
    "releaseDateLock": true,
    "summary": "string",
    "summaryLock": true,
    "tags": [
      "string"
    ],
    "tagsLock": true,
    "title": "string",
    "titleLock": true
  },
  "name": "string",
  "number": 0,
  "oneshot": true,
  "readProgress": "null",
  "seriesId": "string",
  "seriesTitle": "string",
  "size": "string",
  "sizeBytes": 0,
  "url": "string"
}