Skip to main content

PreviewScanResponse

Preview scan response showing detected series

detectedSeries object[]required

List of detected series

  • Array [
    • bookCountintegerrequired

    Number of books detected

    Possible values: >= 0

    metadata object
    oneOf
    null
    namestringrequired

    Series name as detected

    pathstring | nullnullable

    Path relative to library root

    sampleBooksstring[]required

    Sample book filenames (first 5)

  • ]
    • totalFilesintegerrequired

    Total number of files found

    Possible values: >= 0

    PreviewScanResponse
    {
      "detectedSeries": [
        {
          "bookCount": 0,
          "metadata": "null",
          "name": "string",
          "path": "string",
          "sampleBooks": [
            "string"
          ]
        }
      ],
      "totalFiles": 0
    }