Skip to content

Main Navigation Guide Architecture API Deployment

Appearance

Sidebar Navigation

API Reference

Internal

GET GET /_docs/openapi.json

GET GET /_docs/scalar

GET GET /_docs/swagger

POST POST /__test/cleanup

POST POST /__test/invalidate-cache

POST POST /__test/seed-books

POST POST /__test/seed-candidates

POST POST /__test/seed-files

auth

GET List API keys

POST Create API key

DELETE Delete API key

POST Initial setup

books

DELETE Delete book

POST Approve book metadata

GET Get metadata candidates

credentials

GET Check service credentials

PUT Set service credentials

DELETE Delete service credentials

dashboard

GET Get dashboard data

events

GET Server-Sent Events stream

hardcover

GET Get Hardcover connection status

POST Trigger Hardcover sync

GET List Hardcover sync log entries

health

GET Health check

inbox

GET Get inbox book

GET Get inbox book cover image

PATCH Rescan inbox book metadata

GET Get inbox count

GET List inbox books

GET Inbox processing status

POST Upload book files to inbox

jobs

POST Retry a failed job

GET List failed jobs

GET Job queue status

library

GET Get library book

PATCH Update library book

POST Apply refetched metadata to a library book

GET Get book cover image

GET Download book file

GET Get reading progress for a book

POST Refetch metadata from external sources

POST Re-organize a library book

GET Get library filter facets

GET List library books

Reading Status

GET List books by reading status

GET Get reading status counts

search

GET Search suggestions for command palette

settings

GET Get settings

PATCH Update settings

stats

GET Get reading statistics

kosync

GET Get reading progress

PUT Update reading progress

POST Authenticate KoSync user

POST Register KoSync user

opds

GET OPDS books by author

GET OPDS single book entry

GET OPDS all books feed

GET OPDS cover image

GET OPDS file download

GET OPDS books by genre

GET OPDS genres navigation feed

GET OPDS catalog root

GET OPDS new arrivals feed

GET OPDS search

POST /__test/seed-books

POST

/__test/seed-books

Responses

OK

POST

/__test/seed-books

Samples

Pager

Previous page POST POST /__test/invalidate-cache

Next page POST POST /__test/seed-candidates