ReadRealm uses AI to help you understand books before you read them and to surface patterns in what readers think. When you open a book’s detail page, an AI-generated summary is fetched automatically. Reader reviews are analyzed for sentiment so you can gauge the overall reaction at a glance.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/aliammari1/readrealm/llms.txt
Use this file to discover all available pages before exploring further.
Book summaries
A five-line summary generated by Google Gemini from the book’s full text.
Sentiment analysis
Each review is automatically classified as positive, negative, or neutral.
AI providers
Google Generative AI and HuggingFace work together behind the scenes.
Auto descriptions
Book detail pages include AI-generated descriptions when no author description exists.
Book summaries
You can request an AI-generated summary for any book by title. ReadRealm fetches the book’s full text from Project Gutenberg, then sends it to Google Gemini with the prompt:“Summarize this book in 5 lines.”The result is a concise, readable overview that gives you the core premise and themes without spoilers. Endpoint:
Summaries require the book to be available as plain text on Project Gutenberg. If the book cannot be found or has no text content, the API returns
"Book not found" or "No text data provided".Descriptions on book details
When you load a book’s detail page viaGET /book/details/{id}, ReadRealm automatically calls the summary endpoint to populate the description field. This means the description you see is always generated fresh by Gemini — not just whatever the original catalog entry contained.
If the AI summary call fails (e.g., network error or the book has no text), the system falls back to the description from the Open Library catalog entry.
Sentiment analysis
Every time you retrieve your own reviews viaGET /book/user-reviews/{userId}, ReadRealm runs sentiment analysis on each review’s comment text using the sentiment library. The result is stored in the emotion field on the review object.
emotion value | Meaning |
|---|---|
positive | The comment has an overall positive tone |
negative | The comment has an overall negative tone |
neutral | The comment is neither clearly positive nor negative |
AI providers
ReadRealm uses multiple AI providers depending on the feature:| Provider | Feature | Model |
|---|---|---|
| Google Generative AI | Book summaries and descriptions | Gemini (configurable via GEMINI_API_MODEL env var) |
| HuggingFace | Additional AI capabilities | Configurable via HUGGINGFACE_API_KEY env var |
| Azure Cognitive Services | Text-to-speech, speech-to-text | Azure OpenAI deployment |
You need to configure your own API keys for each provider. See the environment setup guide for the full list of required variables.
What AI insights are available
| Insight | How to access | When it appears |
|---|---|---|
| Book summary (5 lines) | GET /book/summary/{title} | On demand |
| Auto-generated description | GET /book/details/{id} | Automatically on book detail page |
Review sentiment (emotion) | GET /book/user-reviews/{userId} | With every review you have written |