Home

KOAssistant Wiki

The reference for KOAssistant, the AI assistant plugin for KOReader. Every feature, option and menu path is described here; the README is the short overview and the place to start.

This wiki documents KOAssistant v0.24.1. The release you run may lack a few of the newest items; the release notes say what each version added. The pages are kept in the repository's wiki/ folder and published at every release.

Start here

• Getting Started: install, add an API key, run your first action.
• Setup, Gestures and Panels: the wizard, the two quick panels, gestures and shortcuts.
• Privacy and Data: what is sent to the AI, what is asked first, and how to control it per book.

Using KOAssistant

• Contexts and Chat: highlight, book, library and general chats, the input dialog and the chips row.
• Chat Windows: the response viewer, the minimal popup, view modes, sources and reasoning.
• Using X-Ray: the browsable guide to a book, checkpoints, marks in the text, versions.
• Book Groups and Series: series and projects, carried entries, linking and AI merges.
• Reading Analysis Actions: recap, summaries, analysis, book info, notes, quizzes.
• Research Mode: papers with a DOI.
• Spoiler Protection: keeping the AI behind your reading position.
• Dictionary and Translation: the dictionary popup, bypass modes, translate views.
• Book Settings and Book Hub: per-book settings and the one page per book.
• Conversations, Notebooks and Export: history, notebooks, export, tags, pins.
• Artifacts and Caching: saved results, updates, pinned responses, costs.
• Image Generation: a picture from a highlight or an X-Ray entry.

Customization

• Actions and Menus: manage, tune and create actions; where they appear.
• Template Variables: the placeholders a prompt can use.
• Prompts, Behaviors and Domains: how the prompt is built and how to shape it.
• Languages: AI languages, translation and dictionary languages, the UI languages.

Providers and models

• Providers and Models: the 32 built-in providers, free tiers, subscriptions, custom providers and models.
• Reasoning, Web Search and Book Tools: thinking, searching the web, searching the book.

Reference and support

• Settings Reference: every row of the KOAssistant menu, in menu order.
• Backups and Updates: updating, backing up, restoring, resetting.
• Advanced Configuration and Development: configuration files, debugging, the test suite.
• Troubleshooting: when something does not work.
• Contributing: issues, pull requests, translations, editing this wiki.