How to Configure OpenAI

This guide walks you through the process of setting up OpenAI API integration for your AI Assistant & Knowledge Bot Addon.

Step 1: Get Your OpenAI API Key

Modern Approach (2024+)

OpenAI now uses a project-based system for API keys. This guide follows the current recommended approach through Projects, which provides better organization and resource management.

1. Create OpenAI Account

• Go to OpenAI Platform
• Sign up for a new account or log in to your existing account
• Complete any required verification steps including phone verification

2. Create a New Project

• Navigate to Projects
  • Go to the Projects page
  • Click Create new project from the left menu
• Project Setup
  • In the pop-up window, add your project name (e.g., "WhatsCloud AI Assistant")
  • Click Create project
  • Note down the Project ID shown on the next page - you'll need this later

3. Configure Model Access

• Set Model Permissions
  • Ensure you're in the correct project (check the project name in the top navigation)
  • Go to Limits from the left menu
  • In the Model usage section, allow access to the models you plan to use:
    • gpt-3.5-turbo (recommended for most use cases)
    • gpt-4 (for advanced reasoning, higher cost)
    • gpt-4o-mini (fast and cost-effective)
• Best Practice
  Only enable the models you actually plan to use. You can always add more models later as needed.

4. Create API Key

• Generate New Key
  • Go to the API Keys page
  • Click Create new secret key button
• Name Your Key
  • Add a descriptive name for your API key (e.g., "WhatsCloud-AI-Integration-API-For-Production")
  • This helps you identify the key's purpose later
  • You can create multiple keys for different environments
• Save Your Key Securely
  • Copy the generated API key immediately
  • Store it in a secure location (password manager recommended)
  • You cannot view the key again after closing the dialog

Critical Security Notice

Never share your API key publicly or commit it to version control. Treat it like a password - keep it secure and private. If compromised, immediately delete the key and create a new one. Use descriptive names to easily manage multiple keys.

5. Set Up Billing (Required for Production)

• Add Payment Method
  • Go to Settings → Billing in your OpenAI account
  • Add a valid payment method (credit/debit card)
  • Set usage limits to control costs

Next Steps

Once you get OpenAI API-Key, proceed to WhatsCloud tenant panel to "Activate OpenAI" features. Click here to learn how.)

---