README_HUGGINGFACE.md

---
title: Open Notebook
emoji: 📓
colorFrom: blue
colorTo: green
sdk: docker
pinned: false
license: mit
---

# Open Notebook - Hugging Face Spaces Deployment

An open source, privacy-focused alternative to Google's Notebook LM!

This Space runs Open Notebook with a FastAPI backend and embedded SurrealDB database.

## Features

- 🔒 **Control your data** - Keep your research private and secure
- 🤖 **Choose your AI models** - Support for 16+ providers including OpenAI, Anthropic, Ollama, and more
- 📚 **Organize multi-modal content** - PDFs, videos, audio, web pages
- 🎙️ **Generate professional podcasts** - Advanced multi-speaker podcast generation
- 🔍 **Search intelligently** - Full-text and vector search across all your content
- 💬 **Chat with context** - AI conversations powered by your research

## Configuration

To use this Space, you need to set the following secrets in the Space settings:

### Required API Keys (set at least one):
- `OPENAI_API_KEY` - For OpenAI models (GPT-4, GPT-3.5)
- `ANTHROPIC_API_KEY` - For Claude models
- `GOOGLE_API_KEY` - For Gemini models

### Optional Configuration:
- `GROQ_API_KEY` - For Groq models
- `MISTRAL_API_KEY` - For Mistral models

## Usage

Once deployed, access the API at:
- API Documentation: `https://your-space-name.hf.space/docs`
- Health Check: `https://your-space-name.hf.space/health`

## Note

This deployment uses in-memory SurrealDB storage. Data will be lost when the Space restarts.
For persistent storage, consider using an external SurrealDB instance.

## Learn More

- [GitHub Repository](https://github.com/baveshraam/software-eng-proj)
- [Original Project](https://github.com/lfnovo/open-notebook)