Credential Setup

OpenAI API Key Required: Weam AI requires OpenAI API access for core functionality including RAG processing, document analysis, and web scraping. The application will not work properly without an OpenAI API key.

Model Providers

Add credentials for the models you want to use. At minimum, configure one provider to enable basic functionality. OpenAI is mandatory for Weam AI to function properly. Add credentials for additional models you want to use.

OpenAI (Required)
Anthropic (Claude)
Google AI (Gemini)
Additional Providers

Get Your API Key:

Visit platform.openai.com
Sign up or log in to your account
Navigate to the API Keys section
Create a new secret key
Copy the key (you won’t see it again)

Add to Environment:

Weam AI_OPEN_AI_KEY=sk-your-openai-api-key-here
OPEN_AI_MODAL=gpt-4
OPEN_AI_API_URL=https://api.openai.com

Detailed OpenAI Setup Guide

Step-by-step OpenAI API key generation

Get Your API Key:

Visit console.anthropic.com
Sign up or log in
Go to the API Keys section
Create a new key
Copy and save the key securely

Add to Environment:

Weam AI_ANTHROPIC_API_KEY=sk-ant-your-anthropic-key-here
ANTHROPIC_AI_API_URL=https://api.anthropic.com

Detailed Anthropic Setup Guide

Step-by-step Anthropic API key generation

Get Your API Key:

Visit makersuite.google.com
Sign in with a Google account
Create an API key
Copy the generated key

Add to Environment:

Weam AI_GEMINI_KEY=your-google-ai-api-key-here
GEMINI_API_URL=https://generativelanguage.googleapis.com

Detailed Google AI Setup Guide

Step-by-step Google AI API key generation

HuggingFace

Get Token:

Visit huggingface.co
Go to Settings → Access Tokens
Create a new token

HUGGING_FACE_AUTH_TOKEN=hf_your-huggingface-token-here

OpenRouter (Multiple Models)

Get API Key:

Visit openrouter.ai
Sign up and go to Keys section
Create a new API key

Weam AI_OPEN_ROUTER_KEY=sk-or-your-openrouter-key-here

DeepSeek

Weam AI_DEEPSEEK_KEY=sk-your-deepseek-key-here

HuggingFace Guide

OpenRouter Guide

External Integrations (Optional)

Slack
GitHub
Google Workspace

Setup OAuth Integration:

Visit api.slack.com/apps
Create a new app
Configure OAuth settings
Get Client ID and Secret

SLACK_CLIENT_ID=your-slack-client-id
SLACK_CLIENT_SECRET=your-slack-client-secret
NEXT_PUBLIC_SLACK_CLIENT_ID=your-slack-client-id
NEXT_PUBLIC_SLACK_CLIENT_SECRET=your-slack-client-secret

Detailed Slack Setup

Complete Slack integration guide

Setup OAuth Integration:

Visit github.com/settings/developers
Create a new OAuth app
Configure redirect URLs
Get Client ID and Secret

GITHUB_CLIENT_ID=your-github-client-id
GITHUB_CLIENT_SECRET=your-github-client-secret
GITHUB_REDIRECT_URI=https://your-domain.com/api/auth/github/callback

Detailed GitHub Setup

Complete GitHub integration guide

Setup OAuth Integration:

Visit console.cloud.google.com
Create project and enable APIs
Configure OAuth consent screen
Create credentials

GOOGLE_CLIENT_ID=your-google-client-id.googleusercontent.com
GOOGLE_CLIENT_SECRET=your-google-client-secret

Detailed Google Setup

Complete Google Workspace integration guide

Service Configuration

Email Service (Optional)

Configure SMTP for Notifications

For user notifications and account management:

EMAIL_PROVIDER=SMTP
SMTP_SERVER=smtp.gmail.com
SMTP_PORT=587
SMTP_USER=your-email@domain.com
SMTP_PASSWORD=your-app-specific-password
SUPPORT_EMAIL=support@yourdomain.com

Gmail App Password Setup:

Enable 2FA on your Google account
Go to App Passwords
Generate an app password for Weam AI
Use the generated password in SMTP_PASSWORD

SEO Tools (Optional)

DataForSEO Integration

For SEO agent functionality:

SEO_USER_ID=your-seo-tool-email
SEO_PASSWORD=your-seo-tool-password

Setup:

Visit DataForSEO
Create account
Go to Dashboard → API Credentials
Get your credentials

Minimum Configuration

For basic functionality, you only need:

One model provider (OpenAI recommended)
Database credentials (usually auto-configured)
Security keys for JWT tokens (auto-generated)

Additional providers and integrations can be added later without downtime.

Generate Security Keys

Generate Required Security Keys

If you need to generate security keys for JWT and encryption:Using OpenSSL (Recommended):

# Generate all required keys
openssl rand -hex 64  # For JWT_SECRET
openssl rand -hex 64  # For JWT_REFRESH_SECRET
openssl rand -hex 16  # For SECURITY_KEY
openssl rand -hex 32  # For CSRF_TOKEN_SECRET

Using Node.js:

node -e "console.log('JWT_SECRET =', require('crypto').randomBytes(64).toString('hex'))"
node -e "console.log('JWT_REFRESH_SECRET =', require('crypto').randomBytes(64).toString('hex'))"
node -e "console.log('SECURITY_KEY =', require('crypto').randomBytes(16).toString('hex'))"
node -e "console.log('CSRF_TOKEN_SECRET =', require('crypto').randomBytes(32).toString('hex'))"

Online Generators:

Next Steps

Launch & Verify

Start services and test your configuration

Overview

Setup

Your Account

Features

Policies

Credential Setup

Model Providers

Detailed OpenAI Setup Guide

Detailed Anthropic Setup Guide

Detailed Google AI Setup Guide

HuggingFace

OpenRouter (Multiple Models)

DeepSeek

HuggingFace Guide

OpenRouter Guide

External Integrations (Optional)

Detailed Slack Setup

Detailed GitHub Setup

Detailed Google Setup

Service Configuration

Email Service (Optional)

SEO Tools (Optional)

Minimum Configuration

Generate Security Keys

Next Steps

Launch & Verify

​Model Providers

Detailed OpenAI Setup Guide

Detailed Anthropic Setup Guide

Detailed Google AI Setup Guide

​HuggingFace

​OpenRouter (Multiple Models)

​DeepSeek

HuggingFace Guide

OpenRouter Guide

​External Integrations (Optional)

Detailed Slack Setup

Detailed GitHub Setup

Detailed Google Setup

​Service Configuration

​Email Service (Optional)

​SEO Tools (Optional)

​Minimum Configuration

​Generate Security Keys

​Next Steps

Launch & Verify

Model Providers

HuggingFace

OpenRouter (Multiple Models)

DeepSeek

External Integrations (Optional)

Service Configuration

Email Service (Optional)

SEO Tools (Optional)

Minimum Configuration

Generate Security Keys

Next Steps