API Keys Setup

OpenSNS supports multiple AI providers. This guide covers how to get and configure API keys.

Supported Providers

Provider	Features	Pricing
OpenAI	GPT-4 for text generation	Pay-per-use
Fal.ai	Fast image/video generation	Pay-per-use
Ollama	Local LLM (free)	Free (self-hosted)
ComfyUI	Local image generation	Free (self-hosted)

Getting API Keys

OpenAI

1. Go to platform.openai.com
2. Sign in or create an account
3. Navigate to API Keys section
4. Click “Create new secret key”
5. Copy the key (starts with sk-)

Caution

OpenAI keys are shown only once. Save it securely!

Fal.ai

1. Go to fal.ai
2. Sign in with GitHub or Google
3. Go to Dashboard → API Keys
4. Create a new key
5. Copy the key

Firecrawl (Optional)

Firecrawl improves web scraping for complex sites:

1. Go to firecrawl.dev
2. Sign up for an account
3. Copy your API key from the dashboard

Configuring Keys

Option 1: Environment Variables (Global)

Set keys in backend/.env for all users:

backend/.env

OPENAI_API_KEY=sk-your-openai-key
FAL_KEY=your-fal-key

Option 2: Settings UI (Per-User)

Each user can configure their own keys:

1. Log in to OpenSNS
2. Go to Settings
3. Enter your API keys
4. Click Save Settings

Tip

User keys override environment variables. This allows users to bring their own keys.

Key Security

OpenSNS encrypts all stored API keys using Fernet (AES-128):

• Keys are encrypted before storage
• Only the key owner can use them
• Keys are never exposed in API responses
• UI shows only “configured” status, never the actual key

Testing Connection

After configuring keys, test they work:

1. Go to Settings
2. Click Test Connection
3. Shows status for each configured provider

Using Local Providers

For privacy or cost savings, use local AI:

Ollama (Free LLM)

# Install Ollama
curl -fsSL https://ollama.ai/install.sh | sh

# Pull a model
ollama pull llama2

# Configure OpenSNS
OLLAMA_URL=http://localhost:11434
DEFAULT_LLM_ENGINE=ollama

ComfyUI (Free Images)

1. Install ComfyUI
2. Start the server
3. Configure:

COMFYUI_URL=http://localhost:8188
DEFAULT_IMAGE_ENGINE=comfyui

Fallback Mode

Without API keys, OpenSNS uses “fallback mode”:

• Text generation returns placeholder copy
• Images use product images from scraping
• Videos use source images

This is useful for testing the workflow without incurring costs.

API Documentation

Once you have OpenSNS running locally, interactive API documentation is available:

• Swagger UI: http://localhost:8000/docs
• ReDoc: http://localhost:8000/redoc

These are auto-generated from the FastAPI backend and always up-to-date.