Skip to content
Chek Docs
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Menu
Get started
What Chek is
Quick start
Self-hosting
Install the server
Set up a new server
Configuration
Serve Chek over HTTPS
Accounts and access
Add sign-in providers
Read Komga and Kavita libraries
Browse Chek from an OPDS reader
Upload files
Run extensions
Update and back up the server
Read logs and traces
Troubleshooting
API
API overview
Read and sync from a client
Reference
Overview
Health
Overview
Check that the server is running
GET
Accounts
Overview
Create the first admin
POST
Sign in
POST
Sign out
POST
List sign-in providers
GET
Start signing in with a provider
POST
Return from a provider
GET
Finish signing in with a provider
POST
Sign the web app in with a link code
POST
Get the signed-in user
GET
Make a code that signs the web app in
POST
Change your password
PUT
List your signed-in devices
GET
Sign a device out
DELETE
List users
GET
Create a user
POST
Delete a user
DELETE
Change a user
PATCH
List your linked sign-in providers
GET
Unlink a sign-in provider
DELETE
Start linking a sign-in provider
POST
Libraries
Overview
List libraries
GET
Add a library
POST
Get a library
GET
Upload a file into a folder library
PUT
Rescan a library
POST
Follow a series into an extension library
POST
Catalog
Overview
List a library's publications
GET
List a library's series
GET
List recently added publications
GET
Search publications
GET
Get a series
GET
Rename a series
PATCH
Undo a series' edits
DELETE
List a series' publications
GET
Get a publication
GET
Edit a publication's metadata
PATCH
Undo a publication's edits
DELETE
Reading
Overview
Download the original file
GET
Get the cover thumbnail
GET
List a comic's pages
GET
Get a comic page
GET
Progress
Overview
List publications to continue
GET
Get your reading position
GET
Save your reading position
PUT
Annotations
Overview
List your bookmarks and highlights
GET
Add a bookmark or highlight
POST
Delete a bookmark or highlight
DELETE
Change a bookmark or highlight
PATCH
Extensions
Overview
Open the source verification prototype
GET
Start a private verification browser
POST
Close the current user's verification browser
DELETE
Capture the current user's verification browser
GET
Release the verification browser for extension retries
POST
Send a click to the current user's verification browser
POST
List the repositories the user can see
GET
Add a repository
POST
Remove a repository
DELETE
Change a repository's credentials
PATCH
Fetch a repository's index again
POST
List the extensions the user can install
GET
Get the content ratings you see
GET
Choose the content ratings you see
PUT
List the user's installed extensions
GET
Install or update an extension for a reader
PUT
Install or update an extension
PUT
Uninstall an extension
DELETE
Search a source
GET
Read a series from a source
GET
List one page of a series' chapters from a source
GET
Choose which group's releases a series picks first
PUT
List a chapter's pages from a source
GET
Find how to read a chapter from a source
GET
Download a chapter's file through a source
GET
Fetch a cover or page through a source
GET
Read the server's settings
GET
Change the server's settings
PUT
OPDS
Overview
OPDS start feed
GET
OPDS authentication document
GET
OPDS navigation feed of a library
GET
OPDS feed of a library's publications
GET
OPDS feed of publications to continue
GET
OPDS feed of recently added publications
GET
OPDS feed of a library's recently added publications
GET
OPDS search
GET
OPDS search in a library
GET
OPDS feed of a series
GET
OPDS publication
GET
Download a publication from OPDS
GET
Get a cover from OPDS
GET
GitHub
Select theme
Dark
Light
Auto
Overview
Progress
Section titled “Progress”
Reading positions synced between devices.
Operations
Section titled “Operations”
GET
/api/v1/me/continue-reading
GET
/api/v1/publications/{publicationId}/progress
PUT
/api/v1/publications/{publicationId}/progress
