Update read progress

POST

/api/v1/books/progress

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "http://127.0.0.1:58259/api/v1/books/progress");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{ \"bookId\": 1, \"fileProgress\": { \"bookFileId\": 1, \"positionData\": \"example\", \"positionHref\": \"example\", \"progressPercent\": 1, \"ttsPositionCfi\": \"example\", \"contentSourceProgressPercent\": 1 }, \"epubProgress\": { \"cfi\": \"example\", \"href\": \"example\", \"contentSourceProgressPercent\": 1, \"percentage\": 1, \"ttsPositionCfi\": \"example\" }, \"pdfProgress\": { \"page\": 1, \"percentage\": 1 }, \"cbxProgress\": { \"page\": 1, \"percentage\": 1 }, \"audiobookProgress\": { \"positionMs\": 1, \"trackIndex\": 1, \"trackPositionMs\": 1, \"percentage\": 1 }, \"dateFinished\": \"2026-04-15T12:00:00Z\", \"progressValid\": true }");

CURLcode ret = curl_easy_perform(hnd);

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("http://127.0.0.1:58259/api/v1/books/progress"),
    Content = new StringContent("{ \"bookId\": 1, \"fileProgress\": { \"bookFileId\": 1, \"positionData\": \"example\", \"positionHref\": \"example\", \"progressPercent\": 1, \"ttsPositionCfi\": \"example\", \"contentSourceProgressPercent\": 1 }, \"epubProgress\": { \"cfi\": \"example\", \"href\": \"example\", \"contentSourceProgressPercent\": 1, \"percentage\": 1, \"ttsPositionCfi\": \"example\" }, \"pdfProgress\": { \"page\": 1, \"percentage\": 1 }, \"cbxProgress\": { \"page\": 1, \"percentage\": 1 }, \"audiobookProgress\": { \"positionMs\": 1, \"trackIndex\": 1, \"trackPositionMs\": 1, \"percentage\": 1 }, \"dateFinished\": \"2026-04-15T12:00:00Z\", \"progressValid\": true }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "http://127.0.0.1:58259/api/v1/books/progress"

  payload := strings.NewReader("{ \"bookId\": 1, \"fileProgress\": { \"bookFileId\": 1, \"positionData\": \"example\", \"positionHref\": \"example\", \"progressPercent\": 1, \"ttsPositionCfi\": \"example\", \"contentSourceProgressPercent\": 1 }, \"epubProgress\": { \"cfi\": \"example\", \"href\": \"example\", \"contentSourceProgressPercent\": 1, \"percentage\": 1, \"ttsPositionCfi\": \"example\" }, \"pdfProgress\": { \"page\": 1, \"percentage\": 1 }, \"cbxProgress\": { \"page\": 1, \"percentage\": 1 }, \"audiobookProgress\": { \"positionMs\": 1, \"trackIndex\": 1, \"trackPositionMs\": 1, \"percentage\": 1 }, \"dateFinished\": \"2026-04-15T12:00:00Z\", \"progressValid\": true }")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("http://127.0.0.1:58259/api/v1/books/progress"))
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{ \"bookId\": 1, \"fileProgress\": { \"bookFileId\": 1, \"positionData\": \"example\", \"positionHref\": \"example\", \"progressPercent\": 1, \"ttsPositionCfi\": \"example\", \"contentSourceProgressPercent\": 1 }, \"epubProgress\": { \"cfi\": \"example\", \"href\": \"example\", \"contentSourceProgressPercent\": 1, \"percentage\": 1, \"ttsPositionCfi\": \"example\" }, \"pdfProgress\": { \"page\": 1, \"percentage\": 1 }, \"cbxProgress\": { \"page\": 1, \"percentage\": 1 }, \"audiobookProgress\": { \"positionMs\": 1, \"trackIndex\": 1, \"trackPositionMs\": 1, \"percentage\": 1 }, \"dateFinished\": \"2026-04-15T12:00:00Z\", \"progressValid\": true }"))
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{ \"bookId\": 1, \"fileProgress\": { \"bookFileId\": 1, \"positionData\": \"example\", \"positionHref\": \"example\", \"progressPercent\": 1, \"ttsPositionCfi\": \"example\", \"contentSourceProgressPercent\": 1 }, \"epubProgress\": { \"cfi\": \"example\", \"href\": \"example\", \"contentSourceProgressPercent\": 1, \"percentage\": 1, \"ttsPositionCfi\": \"example\" }, \"pdfProgress\": { \"page\": 1, \"percentage\": 1 }, \"cbxProgress\": { \"page\": 1, \"percentage\": 1 }, \"audiobookProgress\": { \"positionMs\": 1, \"trackIndex\": 1, \"trackPositionMs\": 1, \"percentage\": 1 }, \"dateFinished\": \"2026-04-15T12:00:00Z\", \"progressValid\": true }");
Request request = new Request.Builder()
  .url("http://127.0.0.1:58259/api/v1/books/progress")
  .post(body)
  .addHeader("Content-Type", "application/json")
  .build();

Response response = client.newCall(request).execute();

import axios from 'axios';

const options = {
  method: 'POST',
  url: 'http://127.0.0.1:58259/api/v1/books/progress',
  headers: {'Content-Type': 'application/json'},
  data: {
    bookId: 1,
    fileProgress: {
      bookFileId: 1,
      positionData: 'example',
      positionHref: 'example',
      progressPercent: 1,
      ttsPositionCfi: 'example',
      contentSourceProgressPercent: 1
    },
    epubProgress: {
      cfi: 'example',
      href: 'example',
      contentSourceProgressPercent: 1,
      percentage: 1,
      ttsPositionCfi: 'example'
    },
    pdfProgress: {page: 1, percentage: 1},
    cbxProgress: {page: 1, percentage: 1},
    audiobookProgress: {positionMs: 1, trackIndex: 1, trackPositionMs: 1, percentage: 1},
    dateFinished: '2026-04-15T12:00:00Z',
    progressValid: true
  }
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

const url = 'http://127.0.0.1:58259/api/v1/books/progress';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"bookId":1,"fileProgress":{"bookFileId":1,"positionData":"example","positionHref":"example","progressPercent":1,"ttsPositionCfi":"example","contentSourceProgressPercent":1},"epubProgress":{"cfi":"example","href":"example","contentSourceProgressPercent":1,"percentage":1,"ttsPositionCfi":"example"},"pdfProgress":{"page":1,"percentage":1},"cbxProgress":{"page":1,"percentage":1},"audiobookProgress":{"positionMs":1,"trackIndex":1,"trackPositionMs":1,"percentage":1},"dateFinished":"2026-04-15T12:00:00Z","progressValid":true}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

val client = OkHttpClient()

val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{ \"bookId\": 1, \"fileProgress\": { \"bookFileId\": 1, \"positionData\": \"example\", \"positionHref\": \"example\", \"progressPercent\": 1, \"ttsPositionCfi\": \"example\", \"contentSourceProgressPercent\": 1 }, \"epubProgress\": { \"cfi\": \"example\", \"href\": \"example\", \"contentSourceProgressPercent\": 1, \"percentage\": 1, \"ttsPositionCfi\": \"example\" }, \"pdfProgress\": { \"page\": 1, \"percentage\": 1 }, \"cbxProgress\": { \"page\": 1, \"percentage\": 1 }, \"audiobookProgress\": { \"positionMs\": 1, \"trackIndex\": 1, \"trackPositionMs\": 1, \"percentage\": 1 }, \"dateFinished\": \"2026-04-15T12:00:00Z\", \"progressValid\": true }")
val request = Request.Builder()
  .url("http://127.0.0.1:58259/api/v1/books/progress")
  .post(body)
  .addHeader("Content-Type", "application/json")
  .build()

val response = client.newCall(request).execute()

use serde_json::json;
use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "http://127.0.0.1:58259/api/v1/books/progress";

    let payload = json!({
        "bookId": 1,
        "fileProgress": json!({
            "bookFileId": 1,
            "positionData": "example",
            "positionHref": "example",
            "progressPercent": 1,
            "ttsPositionCfi": "example",
            "contentSourceProgressPercent": 1
        }),
        "epubProgress": json!({
            "cfi": "example",
            "href": "example",
            "contentSourceProgressPercent": 1,
            "percentage": 1,
            "ttsPositionCfi": "example"
        }),
        "pdfProgress": json!({
            "page": 1,
            "percentage": 1
        }),
        "cbxProgress": json!({
            "page": 1,
            "percentage": 1
        }),
        "audiobookProgress": json!({
            "positionMs": 1,
            "trackIndex": 1,
            "trackPositionMs": 1,
            "percentage": 1
        }),
        "dateFinished": "2026-04-15T12:00:00Z",
        "progressValid": true
    });

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("Content-Type", "application/json".parse().unwrap());

    let client = reqwest::Client::new();
    let response = client.post(url)
        .headers(headers)
        .json(&payload)
        .send()
        .await;

    let results = response.unwrap()
        .json::<serde_json::Value>()
        .await
        .unwrap();

    dbg!(results);
}

curl --request POST \
  --url http://127.0.0.1:58259/api/v1/books/progress \
  --header 'Content-Type: application/json' \
  --data '{ "bookId": 1, "fileProgress": { "bookFileId": 1, "positionData": "example", "positionHref": "example", "progressPercent": 1, "ttsPositionCfi": "example", "contentSourceProgressPercent": 1 }, "epubProgress": { "cfi": "example", "href": "example", "contentSourceProgressPercent": 1, "percentage": 1, "ttsPositionCfi": "example" }, "pdfProgress": { "page": 1, "percentage": 1 }, "cbxProgress": { "page": 1, "percentage": 1 }, "audiobookProgress": { "positionMs": 1, "trackIndex": 1, "trackPositionMs": 1, "percentage": 1 }, "dateFinished": "2026-04-15T12:00:00Z", "progressValid": true }'

wget --quiet \
  --method POST \
  --header 'Content-Type: application/json' \
  --body-data '{ "bookId": 1, "fileProgress": { "bookFileId": 1, "positionData": "example", "positionHref": "example", "progressPercent": 1, "ttsPositionCfi": "example", "contentSourceProgressPercent": 1 }, "epubProgress": { "cfi": "example", "href": "example", "contentSourceProgressPercent": 1, "percentage": 1, "ttsPositionCfi": "example" }, "pdfProgress": { "page": 1, "percentage": 1 }, "cbxProgress": { "page": 1, "percentage": 1 }, "audiobookProgress": { "positionMs": 1, "trackIndex": 1, "trackPositionMs": 1, "percentage": 1 }, "dateFinished": "2026-04-15T12:00:00Z", "progressValid": true }' \
  --output-document \
  - http://127.0.0.1:58259/api/v1/books/progress

Update the read progress for a book.

Request Body^required

application/json

Read progress request

object

bookId

required

integer format: int64

fileProgress

object

bookFileId

required

integer format: int64

positionData

string

positionHref

string

progressPercent

required

number format: float

ttsPositionCfi

string

contentSourceProgressPercent

number format: float

epubProgress

object

cfi

string

href

string

contentSourceProgressPercent

number format: float

percentage

required

number format: float

ttsPositionCfi

string

pdfProgress

object

page

required

integer format: int32

percentage

required

number format: float

cbxProgress

object

page

required

integer format: int32

percentage

required

number format: float

audiobookProgress

object

positionMs

required

integer format: int64

trackIndex

integer format: int32

trackPositionMs

integer format: int64

percentage

required

number format: float

dateFinished

string format: date-time

progressValid

boolean

Example ^generated

{
  "bookId": 1,
  "fileProgress": {
    "bookFileId": 1,
    "positionData": "example",
    "positionHref": "example",
    "progressPercent": 1,
    "ttsPositionCfi": "example",
    "contentSourceProgressPercent": 1
  },
  "epubProgress": {
    "cfi": "example",
    "href": "example",
    "contentSourceProgressPercent": 1,
    "percentage": 1,
    "ttsPositionCfi": "example"
  },
  "pdfProgress": {
    "page": 1,
    "percentage": 1
  },
  "cbxProgress": {
    "page": 1,
    "percentage": 1
  },
  "audiobookProgress": {
    "positionMs": 1,
    "trackIndex": 1,
    "trackPositionMs": 1,
    "percentage": 1
  },
  "dateFinished": "2026-04-15T12:00:00Z",
  "progressValid": true
}

Responses

204

Read progress updated successfully

Update read progress

Request Body required

Example generated

Responses

204

Request Body^required

Example ^generated