Merge pull request #535 from MervinPraison/claude/issue-332-20250528_161954

fix: improve API key validation for LM Studio and local servers

Author: MervinPraison

src/praisonai-agents/praisonaiagents/main.py

@@ -362,7 +362,24 @@ class ReflectionOutput(BaseModel):
     reflection: str
     satisfactory: Literal["yes", "no"]
 
-client = OpenAI(api_key=(os.environ["OPENAI_API_KEY"] if os.environ.get("OPENAI_API_KEY") else "xxxx"))
+# Constants
+LOCAL_SERVER_API_KEY_PLACEHOLDER = "not-needed"
+
+# Initialize OpenAI client with proper API key handling
+api_key = os.environ.get("OPENAI_API_KEY")
+base_url = os.environ.get("OPENAI_API_BASE") or os.environ.get("OPENAI_BASE_URL")
+
+# For local servers like LM Studio, allow minimal API key
+if base_url and not api_key:
+    api_key = LOCAL_SERVER_API_KEY_PLACEHOLDER
+elif not api_key:
+    raise ValueError(
+        "OPENAI_API_KEY environment variable is required for the default OpenAI service. "
+        "If you are targeting a local server (e.g., LM Studio), ensure OPENAI_API_BASE is set "
+        f"(e.g., 'http://localhost:1234/v1') and you can use a placeholder API key by setting OPENAI_API_KEY='{LOCAL_SERVER_API_KEY_PLACEHOLDER}'"
+    )
+
+client = OpenAI(api_key=api_key, base_url=base_url)
 
 class TaskOutput(BaseModel):
     model_config = ConfigDict(arbitrary_types_allowed=True)

src/praisonai/praisonai/inc/models.py

@@ -1,9 +1,13 @@
 # praisonai/inc/models.py
 import os
 import logging
+from urllib.parse import urlparse
 logger = logging.getLogger(__name__)
 logging.basicConfig(level=os.environ.get('LOGLEVEL', 'INFO').upper(), format='%(asctime)s - %(levelname)s - %(message)s')
 
+# Constants
+LOCAL_SERVER_API_KEY_PLACEHOLDER = "not-needed"
+
 # Conditionally import modules based on availability
 try:
     from langchain_openai import ChatOpenAI  # pip install langchain-openai
@@ -71,11 +75,27 @@ def __init__(self, model=None, api_key_var=None, base_url=None, api_key=None):
             self.model_name = self.model.replace("openrouter/", "")
         else: 
             self.api_key_var = api_key_var or "OPENAI_API_KEY" 
-            self.base_url = base_url or os.environ.get("OPENAI_API_BASE", "https://api.openai.com/v1")
+            self.base_url = base_url or os.environ.get("OPENAI_API_BASE") or os.environ.get("OPENAI_BASE_URL") or "https://api.openai.com/v1"
             self.model_name = self.model
         logger.debug(f"Initialized PraisonAIModel with model {self.model_name}, api_key_var {self.api_key_var}, and base_url {self.base_url}")
-        # Use explicit API key if provided, otherwise fall back to environment variable
-        self.api_key = api_key or os.environ.get(self.api_key_var, "nokey")
+
+        # Get API key from environment
+        self.api_key = api_key or os.environ.get(self.api_key_var)
+        
+        # For local servers, allow placeholder API key if base_url is set to non-OpenAI endpoint
+        if not self.api_key and self.base_url:
+            parsed_url = urlparse(self.base_url)
+            is_local = (parsed_url.hostname in ["localhost", "127.0.0.1"] or 
+                       "api.openai.com" not in self.base_url)
+            if is_local:
+                self.api_key = LOCAL_SERVER_API_KEY_PLACEHOLDER
+        
+        if not self.api_key:
+            raise ValueError(
+                f"{self.api_key_var} environment variable is required for the default OpenAI service. "
+                f"For local servers, set {self.api_key_var}='{LOCAL_SERVER_API_KEY_PLACEHOLDER}' and OPENAI_API_BASE to your local endpoint."
+            )
+
 
     def get_model(self):
         """
@@ -127,4 +147,4 @@ def get_model(self):
             raise ImportError(
                 "Required Langchain Integration 'langchain-openai' not found. "
                 "Please install with 'pip install langchain-openai'"
-            )
+            )