Unable to reach KOReader endpoint

[pabsan-0]

What happened?

Hi,

This paragraph for context only: I was in the process of connecting Readest with my self-hosted Kavita. I have OPDS working but am now onto progress syncing, I have been instructed by Readest docs to use the KOReader API, which Kavita has and I was hoping to be compatible.

The KOReader API endpoint mentioned in kavita docs is not reachable to me at all:

$ curl -v http://192.168.0.254:5001/api/koreader/MY_API_KEY
*   Trying 192.168.0.254:5001...
* Connected to 192.168.0.254 (192.168.0.254) port 5001
> GET /api/koreader/MY_API_KEYHTTP/1.1
> Host: 192.168.0.254:5001
> User-Agent: curl/8.5.0
> Accept: */*
>
< HTTP/1.1 404 Not Found
< Content-Length: 0
< Date: Sun, 03 May 2026 22:17:10 GMT
< Server: Kestrel
< Vary: Accept-Encoding
< X-Frame-Options: SAMEORIGIN
< Content-Security-Policy: frame-ancestors 'none';
<
* Connection #0 to host 192.168.0.254 left intact

The following being for the plain OPDS link, which does work:

$ curl -v http://192.168.0.254:5001/api/opds/MY_API_KEY
*   Trying 192.168.0.254:5001...
* Connected to 192.168.0.254 (192.168.0.254) port 5001
> GET /api/opds/MY_API_KEYHTTP/1.1
> Host: 192.168.0.254:5001
> User-Agent: curl/8.5.0
> Accept: */*
>
< HTTP/1.1 401 Unauthorized
< Content-Length: 0
< Date: Sun, 03 May 2026 22:25:00 GMT
< Server: Kestrel
<
* Connection #0 to host 192.168.0.254 left intact

What did you expect?

I expected that endpoint to be reachable with a non-404 code

Kavita Version Number - If you don't see your version number listed, please update Kavita and see if your issue still persists.

0.9.0 - Stable

Are you accessing kavita through a reverse proxy? If yes, confirm that the issue persists with a direct connection

No

What operating system is Kavita being hosted from?

Docker (LSIO Container)

If the issue is being seen on Desktop, what OS are you running where you see the issue?

None

If the issue is being seen in the UI, what browsers are you seeing the problem on?

No response

If the issue is being seen on Mobile, what OS are you running where you see the issue?

None

If the issue is being seen on the Mobile UI, what browsers are you seeing the problem on?

No response

Relevant log output

Additional Notes

Thank you :)

[Fesaa]

KOReader adds the correct paths itself, that one you're calling isn't a valid endpoint (and thus returns 404). Have a look at the api docs for more info: https://www.kavitareader.com/docs/api/#/Koreader

[pabsan-0]

Thank you! From your comment I thought I'd need to dig a bit deeper to make this work, but Readest progress sync DOES work out of the box. Maybe it is already somewhere in the docs, but I didn't know and just took a chance: I needed to set the API key as Kavita password in Readest. Jotting down this for future users stumbling on this issue:

• KOReader Sync
• Fill in:
  • Server URL: http://IP:PORT/api/koreader/YOUR_API_KEY
  • Username: Kavita username
  • Password: Kavita API key, not password
  • Checksum Method: File Content

[majora2007]

That's interesting, it seems Readest uses the API Key for password and KOReader uses neither as the API key is in the url.