Skip to content

⚡ Quick Setup (5 Minutes)

Get Convoscope running with minimal configuration for immediate testing.

Prerequisites

  • Python 3.8+
  • At least one AI provider API key

1-Minute Setup

# Clone and setup
git clone <repository-url>
cd convoscope
pip install -r requirements.txt

# Set API key
export OPENAI_API_KEY="sk-your-openai-key-here"

# Run
streamlit run run_chat.py

Option B: Use Anthropic Claude

# Same setup as above, but use:
export ANTHROPIC_API_KEY="sk-ant-api03-your-key-here"
streamlit run run_chat.py

Option C: Use Google Gemini

# Same setup as above, but use:
export GEMINI_API_KEY="AIza-your-gemini-key-here"
streamlit run run_chat.py

Verify It's Working

  1. App opens: Browser should open to http://localhost:8501
  2. Provider shows: You should see your provider in the sidebar (✅ openai is ready)
  3. Send test message: Try "Hello, are you working?"
  4. Get response: You should get an AI response within a few seconds

Interface Working Working interface - click to enlarge

What You Get

With this minimal setup: - ✅ AI Chat: Full conversation capability - ✅ Auto-save: Conversations saved automatically - ✅ Error handling: Graceful error messages - ❌ Multi-provider fallback: Need multiple API keys for this

Add More Providers (Optional)

To get the full reliability benefits, add more API keys:

# Add all three for maximum reliability
export OPENAI_API_KEY="sk-your-openai-key"
export ANTHROPIC_API_KEY="sk-ant-api03-your-anthropic-key"
export GEMINI_API_KEY="AIza-your-gemini-key"

# Restart the app
streamlit run run_chat.py

You should now see multiple providers available:

Multiple Providers Multiple providers available - click to enlarge

Troubleshooting

"No API keys configured"

  • Check your environment variable: echo $OPENAI_API_KEY
  • Make sure it starts with sk- (OpenAI) or sk-ant- (Anthropic) or AIza (Google)
  • Restart your terminal after setting the variable

"Invalid API key"

App won't start

  • Check Python version: python --version (need 3.8+)
  • Install dependencies: pip install -r requirements.txt
  • Check for error messages in the terminal

Next Steps

Need help? Check the Troubleshooting Guide for common issues and solutions.