Overview

This backend powers the ChatInk Chrome Extension, enabling a new way to save, organize, and interact with your web browsing history. Instead of traditional bookmarks, ChatInk saves links and lets you chat with your saved content using advanced open-source AI models.

• Save links directly from Chrome (not just bookmarks)
• Chat with your saved links: Ask questions, summarize, or search your saved content
• Uses open-source LLMs hosted on Groq (free while available)
• Ready for future integration with OpenAI and Google Gemini

Features

• Chrome Extension Integration: Seamless connection with the ChatInk extension
• Link Management API: Save, retrieve, and manage your links
• Chat API: Interact with your saved links using AI
• Pluggable AI Model Support: Currently uses open-source models on Groq; classes for OpenAI and Gemini are included for future use

Getting Started

1. Clone and Install

git clone https://github.com/yourusername/chrome_backend.git
cd chrome_backend
pip install -r requirements.txt

2. Environment Variables

Copy the example env file and fill in any required secrets:

cp context_links/users/.env.example context_links/users/.env

3. Run the Backend

# Example using uvicorn (adjust path/module as needed)
uvicorn context_links.main:app --reload

4. Connect with the Chrome Extension

• Install the ChatInk Chrome Extension
• In the extension settings, set the backend API URL to your running backend (e.g., http://localhost:8000)

API Endpoints

• POST /links/save: Save a new link from the extension
• GET /links/list: Get all saved links
• POST /chat/query: Chat with your saved links (provide a query and context)

See context_links/users/views.py for full API details.

AI Model Integration

• Default: Uses open-source models via Groq API (free while available)
• Extensible: Classes for OpenAI and Google Gemini models are included in context_links/users/ai_models/ for future integration. Swap or extend models as needed.

License

MIT License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

---

For questions or contributions, please open an issue or pull request.