Reading

{
  "items": [
    {
      "conversion": {
        "converter": "libmobi:85dcfe803fc2a21020ddcf15c3eb66b93d388add",
        "inputSHA256": "string",
        "options": "portico-epub-v1;unencrypted-only;no-replica;default-kf8",
        "originalFormat": "mobi",
        "originalRevision": "r12",
        "originalSize": 1,
        "originalSourceId": "id_8h2k4q",
        "outputSHA256": "string",
        "outputSize": 1,
        "revision": "r12",
        "workerSHA256": "string"
      },
      "item": {
        "author": {
          "source": "owner",
          "value": "string"
        },
        "coverUrl": "https://example.com/…",
        "format": "epub",
        "id": "id_8h2k4q",
        "inventoryAvailable": true,
        "libraryId": "id_8h2k4q",
        "publicationType": {
          "source": "owner",
          "value": "book"
        },
        "readingMark": {
          "itemId": "id_8h2k4q",
          "read": true,
          "revision": 0
        },
        "series": {
          "id": "id_8h2k4q",
          "name": "Fargo",
          "number": 0,
          "source": "owner"
        },
        "sourceId": "id_8h2k4q",
        "title": "Fargo"
      },
      "progress": {
        "location": {
          "cfi": "string",
          "format": "epub",
          "pageIndex": 0,
          "progression": 0,
          "section": "string"
        },
        "observedAt": 0,
        "revision": 0,
        "sourceId": "id_8h2k4q",
        "sourceRevision": "r12",
        "stale": true
      }
    }
  ],
  "nextCursor": "eyJvIjoyMH0"
}

• itemsarray of objectrequired

  • conversionobject

    • converterstringrequiredone of "libmobi:85dcfe803fc2a21020ddcf15c3eb66b93d388add"
    • inputSHA256stringrequiredlength 64–64pattern ^[a-f0-9]{64}$
    • optionsstringrequiredone of "portico-epub-v1;unencrypted-only;no-replica;default-kf8"
    • originalFormatstringrequiredone of "mobi", "azw3"
    • originalRevisionstringrequiredlength 64–64pattern ^[a-f0-9]{64}$
    • originalSizeintegerrequired1–67108864
    • originalSourceIdstringrequiredlength 1–256
    • outputSHA256stringrequiredlength 64–64pattern ^[a-f0-9]{64}$
    • outputSizeintegerrequired1–134217728
    • revisionstringrequiredlength 64–64pattern ^[a-f0-9]{64}$
    • workerSHA256stringrequiredlength 64–64pattern ^[a-f0-9]{64}$
  • itemobjectrequired

    • authorobject

      • sourcestringrequiredone of "owner", "file-metadata", "file-name", "folder"
      • valuestringrequiredlength 1–4096
    • coverUrlstring
    • formatstringrequiredone of "epub", "pdf", "cbz", "mobi", "azw3", "cb7", "cbr"
    • idstringrequired
    • inventoryAvailablebooleanrequired
    • libraryIdstringrequired
    • publicationTypeobject

      • sourcestringrequiredone of "owner", "file-metadata"
      • valuestringrequiredone of "book", "magazine", "newspaper"
    • readingMarkobject

      • itemIdstringrequiredlength 1–64pattern ^[A-Za-z0-9_-]{1,64}$
      • readbooleanrequired
      • revisionintegerrequired≥ 0
    • seriesobject

      • idstringrequiredlength 1–∞
      • namestringrequiredlength 1–4096
      • numbernumber≥ 0
      • sourcestringrequiredone of "owner", "file-metadata", "file-name", "folder"
    • sourceIdstringrequired
    • titlestringrequired
  • progressobjectrequired

    • locationobjectrequired

      • cfistring
      • formatstringrequiredone of "epub", "pdf", "cbz", "cb7", "cbr"
      • pageIndexinteger
      • progressionnumberrequired
      • sectionstring
    • observedAtintegerrequired
    • revisionintegerrequired
    • sourceIdstringrequired
    • sourceRevisionstringrequired
    • stalebooleanrequired
• nextCursorstring

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

• errorobjectrequired

  • codestringrequired
  • messagestringrequired

{
  "rows": [
    {
      "items": [
        {
          "author": {},
          "coverUrl": "https://example.com/…",
          "format": "epub",
          "id": "id_8h2k4q",
          "inventoryAvailable": true,
          "libraryId": "id_8h2k4q",
          "publicationType": {},
          "readingMark": {},
          "series": {},
          "sourceId": "id_8h2k4q",
          "title": "Fargo"
        }
      ],
      "key": "string",
      "newIssues": [
        {
          "issueDate": "string",
          "item": {}
        }
      ],
      "newspaper": {
        "id": "id_8h2k4q",
        "issueCount": 1,
        "latest": {
          "issueDate": "string",
          "item": {}
        },
        "name": "Fargo"
      },
      "nextCursor": "eyJvIjoyMH0",
      "series": [
        {
          "count": 1,
          "id": "id_8h2k4q",
          "libraryId": "id_8h2k4q",
          "name": "Fargo",
          "preview": [],
          "readCount": 0
        }
      ],
      "shortReads": [
        {
          "estimatedSeconds": 1,
          "item": {},
          "wordCount": 1
        }
      ]
    }
  ]
}

• rowsarray of objectrequired

  • itemsarray of objectrequired

    • authorobject

      • sourcestringrequiredone of "owner", "file-metadata", "file-name", "folder"
      • valuestringrequiredlength 1–4096
    • coverUrlstring
    • formatstringrequiredone of "epub", "pdf", "cbz", "mobi", "azw3", "cb7", "cbr"
    • idstringrequired
    • inventoryAvailablebooleanrequired
    • libraryIdstringrequired
    • publicationTypeobject

      • sourcestringrequiredone of "owner", "file-metadata"
      • valuestringrequiredone of "book", "magazine", "newspaper"
    • readingMarkobject

      • itemIdstringrequiredlength 1–64pattern ^[A-Za-z0-9_-]{1,64}$
      • readbooleanrequired
      • revisionintegerrequired≥ 0
    • seriesobject

      • idstringrequiredlength 1–∞
      • namestringrequiredlength 1–4096
      • numbernumber≥ 0
      • sourcestringrequiredone of "owner", "file-metadata", "file-name", "folder"
    • sourceIdstringrequired
    • titlestringrequired
  • keystringrequired
  • newIssuesarray of object

    • issueDatestringrequiredlength 7–10pattern ^[0-9]{4}-[0-9]{2}(-[0-9]{2})?$
    • itemobjectrequired

      • authorobject

        • sourcestringrequiredone of "owner", "file-metadata", "file-name", "folder"
        • valuestringrequiredlength 1–4096
      • coverUrlstring
      • formatstringrequiredone of "epub", "pdf", "cbz", "mobi", "azw3", "cb7", "cbr"
      • idstringrequired
      • inventoryAvailablebooleanrequired
      • libraryIdstringrequired
      • publicationTypeobject

        • sourcestringrequiredone of "owner", "file-metadata"
        • valuestringrequiredone of "book", "magazine", "newspaper"
      • readingMarkobject

        • itemIdstringrequiredlength 1–64pattern ^[A-Za-z0-9_-]{1,64}$
        • readbooleanrequired
        • revisionintegerrequired≥ 0
      • seriesobject

        • idstringrequiredlength 1–∞
        • namestringrequiredlength 1–4096
        • numbernumber≥ 0
        • sourcestringrequiredone of "owner", "file-metadata", "file-name", "folder"
      • sourceIdstringrequired
      • titlestringrequired
  • newspaperobject

    • idstringrequiredpattern ^[A-Za-z0-9_-]{43}$
    • issueCountintegerrequired≥ 1
    • latestobjectrequired

      • issueDatestringrequiredlength 7–10pattern ^[0-9]{4}-[0-9]{2}(-[0-9]{2})?$
      • itemobjectrequired

        • authorobject

          • sourcestringrequiredone of "owner", "file-metadata", "file-name", "folder"
          • valuestringrequiredlength 1–4096
        • coverUrlstring
        • formatstringrequiredone of "epub", "pdf", "cbz", "mobi", "azw3", "cb7", "cbr"
        • idstringrequired
        • inventoryAvailablebooleanrequired
        • libraryIdstringrequired
        • publicationTypeobject

          • sourcestringrequiredone of "owner", "file-metadata"
          • valuestringrequiredone of "book", "magazine", "newspaper"
        • readingMarkobject

          • itemIdstringrequiredlength 1–64pattern ^[A-Za-z0-9_-]{1,64}$
          • readbooleanrequired
          • revisionintegerrequired≥ 0
        • seriesobject

          • idstringrequiredlength 1–∞
          • namestringrequiredlength 1–4096
          • numbernumber≥ 0
          • sourcestringrequiredone of "owner", "file-metadata", "file-name", "folder"
        • sourceIdstringrequired
        • titlestringrequired
    • namestringrequiredlength 1–4096
  • nextCursorstring
  • seriesarray of object

    • countintegerrequired≥ 1
    • idstringrequiredpattern ^[A-Za-z0-9_-]{43}$
    • libraryIdstringrequiredlength 1–∞
    • namestringrequiredlength 1–4096
    • previewarray of objectrequired1–3 items

      • authorobject

        • sourcestringrequiredone of "owner", "file-metadata", "file-name", "folder"
        • valuestringrequiredlength 1–4096
      • coverUrlstring
      • formatstringrequiredone of "epub", "pdf", "cbz", "mobi", "azw3", "cb7", "cbr"
      • idstringrequired
      • inventoryAvailablebooleanrequired
      • libraryIdstringrequired
      • publicationTypeobject

        • sourcestringrequiredone of "owner", "file-metadata"
        • valuestringrequiredone of "book", "magazine", "newspaper"
      • readingMarkobject

        • itemIdstringrequiredlength 1–64pattern ^[A-Za-z0-9_-]{1,64}$
        • readbooleanrequired
        • revisionintegerrequired≥ 0
      • seriesobject

        • idstringrequiredlength 1–∞
        • namestringrequiredlength 1–4096
        • numbernumber≥ 0
        • sourcestringrequiredone of "owner", "file-metadata", "file-name", "folder"
      • sourceIdstringrequired
      • titlestringrequired
    • readCountintegerrequired≥ 0
  • shortReadsarray of object

    • estimatedSecondsintegerrequired1–10800
    • itemobjectrequired

      • authorobject

        • sourcestringrequiredone of "owner", "file-metadata", "file-name", "folder"
        • valuestringrequiredlength 1–4096
      • coverUrlstring
      • formatstringrequiredone of "epub", "pdf", "cbz", "mobi", "azw3", "cb7", "cbr"
      • idstringrequired
      • inventoryAvailablebooleanrequired
      • libraryIdstringrequired
      • publicationTypeobject

        • sourcestringrequiredone of "owner", "file-metadata"
        • valuestringrequiredone of "book", "magazine", "newspaper"
      • readingMarkobject

        • itemIdstringrequiredlength 1–64pattern ^[A-Za-z0-9_-]{1,64}$
        • readbooleanrequired
        • revisionintegerrequired≥ 0
      • seriesobject

        • idstringrequiredlength 1–∞
        • namestringrequiredlength 1–4096
        • numbernumber≥ 0
        • sourcestringrequiredone of "owner", "file-metadata", "file-name", "folder"
      • sourceIdstringrequired
      • titlestringrequired
    • wordCountintegerrequired1–44999

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

• errorobjectrequired

  • codestringrequired
  • messagestringrequired

{
  "items": [
    {
      "author": {
        "source": "owner",
        "value": "string"
      },
      "coverUrl": "https://example.com/…",
      "format": "epub",
      "id": "id_8h2k4q",
      "inventoryAvailable": true,
      "libraryId": "id_8h2k4q",
      "publicationType": {
        "source": "owner",
        "value": "book"
      },
      "readingMark": {
        "itemId": "id_8h2k4q",
        "read": true,
        "revision": 0
      },
      "series": {
        "id": "id_8h2k4q",
        "name": "Fargo",
        "number": 0,
        "source": "owner"
      },
      "sourceId": "id_8h2k4q",
      "title": "Fargo"
    }
  ],
  "nextCursor": "eyJvIjoyMH0"
}

• itemsarray of objectrequired

  • authorobject

    • sourcestringrequiredone of "owner", "file-metadata", "file-name", "folder"
    • valuestringrequiredlength 1–4096
  • coverUrlstring
  • formatstringrequiredone of "epub", "pdf", "cbz", "mobi", "azw3", "cb7", "cbr"
  • idstringrequired
  • inventoryAvailablebooleanrequired
  • libraryIdstringrequired
  • publicationTypeobject

    • sourcestringrequiredone of "owner", "file-metadata"
    • valuestringrequiredone of "book", "magazine", "newspaper"
  • readingMarkobject

    • itemIdstringrequiredlength 1–64pattern ^[A-Za-z0-9_-]{1,64}$
    • readbooleanrequired
    • revisionintegerrequired≥ 0
  • seriesobject

    • idstringrequiredlength 1–∞
    • namestringrequiredlength 1–4096
    • numbernumber≥ 0
    • sourcestringrequiredone of "owner", "file-metadata", "file-name", "folder"
  • sourceIdstringrequired
  • titlestringrequired
• nextCursorstring

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

• errorobjectrequired

  • codestringrequired
  • messagestringrequired

{
  "anchor": {
    "matchUnit": "utf16",
    "normalization": "xhtml-body-blockspace-fields-v1",
    "offsetUnit": "utf16"
  },
  "hits": [
    {
      "coverUrl": "https://example.com/…",
      "excerpt": "string",
      "itemId": "id_8h2k4q",
      "libraryId": "id_8h2k4q",
      "matchLength": 1,
      "matchStart": 0,
      "sectionIndex": 0,
      "sectionPath": "string",
      "sourceId": "id_8h2k4q",
      "sourceRevision": "r12",
      "title": "Fargo",
      "utf16Offset": 0
    }
  ],
  "indexRevision": 0,
  "indexedOnly": true,
  "next": "string"
}

• anchorobjectrequired

  • matchUnitstringrequiredone of "utf16"
  • normalizationstringrequiredone of "xhtml-body-blockspace-fields-v1"
  • offsetUnitstringrequiredone of "utf16"
• hitsarray of objectrequired0–50 items

  • coverUrlstringlength 0–2048
  • excerptstringrequiredlength 0–8192
  • itemIdstringrequiredlength 1–128
  • libraryIdstringrequiredlength 1–128
  • matchLengthintegerrequired≥ 1
  • matchStartintegerrequired≥ 0
  • sectionIndexintegerrequired0–4095
  • sectionPathstringrequiredlength 1–1024
  • sourceIdstringrequiredlength 1–128
  • sourceRevisionstringrequiredlength 1–128
  • titlestringlength 0–4096
  • utf16Offsetintegerrequired≥ 0
• indexRevisionintegerrequired≥ 0
• indexedOnlybooleanrequiredone of true
• nextstringlength 0–512

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

• errorobjectrequired

  • codestringrequired
  • messagestringrequired

{
  "entries": [
    {
      "colour": "",
      "createdAt": 0,
      "id": "id_8h2k4q",
      "kind": "bookmark",
      "location": {
        "cfi": "string",
        "format": "epub",
        "progression": 0,
        "section": "string"
      },
      "note": "string",
      "rects": [
        {
          "height": 0,
          "width": 0,
          "x": 0,
          "y": 0
        }
      ],
      "text": "string",
      "updatedAt": 0
    }
  ],
  "nextCursor": "eyJvIjoyMH0",
  "revision": 0,
  "sourceId": "id_8h2k4q",
  "sourceRevision": "r12"
}

• entriesarray of objectrequired0–50 items

  • colourstringrequiredone of "", "yellow", "green", "blue", "pink"
  • createdAtintegerrequired≥ 0
  • idstringrequiredlength 1–64pattern ^[A-Za-z0-9_-]{1,64}$
  • kindstringrequiredone of "bookmark", "highlight"
  • locationobjectrequired

    • cfistringrequiredlength 10–4096
    • formatstringrequiredone of "epub"
    • progressionnumberrequired0–1
    • sectionstringlength 0–1024
  • notestringrequiredlength 0–4096
  • rectsarray of object0–128 items

    • heightnumberrequired0–1
    • widthnumberrequired0–1
    • xnumberrequired0–1
    • ynumberrequired0–1
  • textstringrequiredlength 0–8192
  • updatedAtintegerrequired≥ 0
• nextCursorstringrequiredlength 0–64pattern ^([A-Za-z0-9_-]{1,64})?$
• revisionintegerrequired≥ 0
• sourceIdstringrequiredlength 1–256
• sourceRevisionstringrequiredlength 1–256

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

• errorobjectrequired

  • codestringrequired
  • messagestringrequired

"string"

string (binary)

"string"

string (binary)

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

• errorobjectrequired

  • codestringrequired
  • messagestringrequired

"string"

string (binary)

"string"

string (binary)

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

• errorobjectrequired

  • codestringrequired
  • messagestringrequired

{
  "progress": {
    "location": {
      "cfi": "string",
      "format": "epub",
      "pageIndex": 0,
      "progression": 0,
      "section": "string"
    },
    "observedAt": 0,
    "revision": 0,
    "sourceId": "id_8h2k4q",
    "sourceRevision": "r12",
    "stale": true
  }
}

• progressobject | any | nullrequired

  • locationobjectrequired

    • cfistring
    • formatstringrequiredone of "epub", "pdf", "cbz", "cb7", "cbr"
    • pageIndexinteger
    • progressionnumberrequired
    • sectionstring
  • observedAtintegerrequired
  • revisionintegerrequired
  • sourceIdstringrequired
  • sourceRevisionstringrequired
  • stalebooleanrequired

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

• errorobjectrequired

  • codestringrequired
  • messagestringrequired

{
  "coverage": {
    "reason": "string",
    "status": "indexed"
  },
  "hits": [
    {
      "excerpt": "string",
      "matchLength": 1,
      "matchStart": 0,
      "sectionIndex": 0,
      "sectionPath": "string",
      "utf16Offset": 0
    }
  ],
  "indexRevision": 0,
  "next": "string",
  "sessionId": "id_8h2k4q",
  "sourceId": "id_8h2k4q",
  "sourceRevision": "r12"
}

• coverageobjectrequired

  • reasonstringlength 0–64
  • statusstringrequiredone of "indexed", "pending", "unsupported", "evicted", "excluded"
• hitsarray of objectrequired0–50 items

  • excerptstringrequiredlength 0–8192
  • matchLengthintegerrequired≥ 1
  • matchStartintegerrequired≥ 0
  • sectionIndexintegerrequired0–4095
  • sectionPathstringrequiredlength 1–1024
  • utf16Offsetintegerrequired≥ 0
• indexRevisionintegerrequired≥ 0
• nextstringlength 0–512
• sessionIdstringrequiredlength 1–128
• sourceIdstringrequiredlength 1–128
• sourceRevisionstringrequiredlength 1–128

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

• errorobjectrequired

  • codestringrequired
  • messagestringrequired

"string"

string (binary)

"string"

string (binary)

"string"

string (binary)

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

• errorobjectrequired

  • codestringrequired
  • messagestringrequired