Skip to main content
POST
/
api
/
v1
/
transient-books
Scan folder for transient books
curl --request POST \
  --url https://demo.komga.org/api/v1/transient-books \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "path": "<string>"
}
'
[
  {
    "comment": "<string>",
    "fileLastModified": "2023-11-07T05:31:56Z",
    "files": [
      "<string>"
    ],
    "id": "<string>",
    "mediaType": "<string>",
    "name": "<string>",
    "pages": [
      {
        "fileName": "<string>",
        "mediaType": "<string>",
        "number": 123,
        "size": "<string>",
        "height": 123,
        "sizeBytes": 123,
        "width": 123
      }
    ],
    "size": "<string>",
    "sizeBytes": 123,
    "status": "<string>",
    "url": "<string>",
    "number": 123,
    "seriesId": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
path
string
required

Response

OK

​
comment
string
required
​
fileLastModified
string<date-time>
required
​
files
string[]
required
​
id
string
required
​
mediaType
string
required
​
name
string
required
​
pages
object[]
required
​
size
string
required
​
sizeBytes
integer<int64>
required
​
status
string
required
​
url
string
required
​
number
number<float>
​
seriesId
string