Skip to main content
PATCH
/
api
/
v1
/
books
/
{bookId}
/
read-progress
Mark book's read progress
curl --request PATCH \
  --url https://demo.komga.org/api/v1/books/{bookId}/read-progress \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "completed": true,
  "page": 123
}
'
{
  "violations": [
    {
      "fieldName": "<string>",
      "message": "<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.

Path Parameters

​
bookId
string
required

Body

application/json

page can be omitted if completed is set to true. completed can be omitted, and will be set accordingly depending on the page passed and the total number of pages in the book.

​
completed
boolean
​
page
integer<int32>

Response

No Content