Support custom OPENAI_BASE_URL and document HF secret

.env.example

@@ -1,7 +1,8 @@
 OPENAI_API_KEY=your_openai_api_key
+OPENAI_BASE_URL=your_openai_compatible_base_url
 ANTHROPIC_API_KEY=your_anthropic_api_key
 GOOGLE_API_KEY=your_google_api_key
 OLLAMA_BASE_URL=your_ollama_url
 OPENROUTER_BASE_URL=your_openrouter_url
 OPENROUTER_API_KEY=your_openrouter_api_key
-LLAMA_CPP_BASE_URL=your_llama_cpp_url
+LLAMA_CPP_BASE_URL=your_llama_cpp_url

README.md

@@ -39,8 +39,10 @@ license: mit
 > [!NOTE]
 > The tool needs Tor to do the searches. You can install Tor using `apt install tor` on Linux/Windows(WSL) or `brew install tor` on Mac. Once installed, confirm if Tor is running in the background.
 
-> [!TIP]
-> You can provide OpenAI or Anthropic or Google API key by either creating .env file (refer to sample env file in the repo) or by setting env variables in PATH.
+> [!TIP]
+> You can provide OpenAI or Anthropic or Google API key by either creating .env file (refer to sample env file in the repo) or by setting env variables in PATH.
+>
+> If you use an OpenAI-compatible proxy/gateway, set `OPENAI_BASE_URL` (for example: `https://your-openai-gateway/v1`).
 >
 > For Ollama, provide `http://host.docker.internal:11434` as `OLLAMA_BASE_URL` in your env if running using docker method or `http://127.0.0.1:11434` for other methods. You might need to serve Ollama on 0.0.0.0 depending on your OS. You can do by running `OLLAMA_HOST=0.0.0.0 ollama serve &` in your terminal.
 
@@ -66,6 +68,7 @@ docker run --rm \
 2. Push this repository to the Space git remote.
 3. In Space settings, add required secrets:
    - `OPENAI_API_KEY` (for OpenAI models)
+   - `OPENAI_BASE_URL` (optional, for custom OpenAI-compatible endpoint URL)
    - `ANTHROPIC_API_KEY` (for Claude models)
    - `GOOGLE_API_KEY` (for Gemini models)
    - `OPENROUTER_API_KEY` (for OpenRouter models)

config.py

@@ -3,11 +3,12 @@ from dotenv import load_dotenv
 
 load_dotenv()
 
-# Configuration variables loaded from the .env file
-OPENAI_API_KEY = os.getenv("OPENAI_API_KEY")
-GOOGLE_API_KEY = os.getenv("GOOGLE_API_KEY")
-ANTHROPIC_API_KEY = os.getenv("ANTHROPIC_API_KEY")
-OLLAMA_BASE_URL = os.getenv("OLLAMA_BASE_URL")
-OPENROUTER_BASE_URL = os.getenv("OPENROUTER_BASE_URL", "https://openrouter.ai/api/v1")
-OPENROUTER_API_KEY = os.getenv("OPENROUTER_API_KEY")
-LLAMA_CPP_BASE_URL= os.getenv("LLAMA_CPP_BASE_URL")
+# Configuration variables loaded from the .env file
+OPENAI_API_KEY = os.getenv("OPENAI_API_KEY")
+OPENAI_BASE_URL = os.getenv("OPENAI_BASE_URL")
+GOOGLE_API_KEY = os.getenv("GOOGLE_API_KEY")
+ANTHROPIC_API_KEY = os.getenv("ANTHROPIC_API_KEY")
+OLLAMA_BASE_URL = os.getenv("OLLAMA_BASE_URL")
+OPENROUTER_BASE_URL = os.getenv("OPENROUTER_BASE_URL", "https://openrouter.ai/api/v1")
+OPENROUTER_API_KEY = os.getenv("OPENROUTER_API_KEY")
+LLAMA_CPP_BASE_URL= os.getenv("LLAMA_CPP_BASE_URL")

llm.py

@@ -3,12 +3,13 @@ import openai
 from langchain_core.prompts import ChatPromptTemplate
 from langchain_core.output_parsers import StrOutputParser
 from llm_utils import _common_llm_params, resolve_model_config, get_model_choices
-from config import (
-    OPENAI_API_KEY,
-    ANTHROPIC_API_KEY,
-    GOOGLE_API_KEY,
-    OPENROUTER_API_KEY,
-)
+from config import (
+    OPENAI_API_KEY,
+    OPENAI_BASE_URL,
+    ANTHROPIC_API_KEY,
+    GOOGLE_API_KEY,
+    OPENROUTER_API_KEY,
+)
 import logging
 import re
 
@@ -45,29 +46,39 @@ def get_llm(model_choice):
     return llm_instance
 
 
-def _ensure_credentials(model_choice: str, llm_class, model_params: dict) -> None:
-    """Raise a clear error if the user selects a hosted model without a key."""
-
-    def _require(key_value, env_var, provider_name):
-        if key_value:
-            return
-        raise ValueError(
-            f"{provider_name} model '{model_choice}' selected but `{env_var}` is not set.\n"
-            "Add it to your .env file or export it before running the app."
-        )
+def _ensure_credentials(model_choice: str, llm_class, model_params: dict) -> None:
+    """Raise a clear error if the user selects a hosted model without a key."""
+
+    def _is_configured(value):
+        return bool(value and str(value).strip() and "your_" not in str(value).lower())
+
+    def _require(key_value, env_var, provider_name):
+        if _is_configured(key_value):
+            return
+        raise ValueError(
+            f"{provider_name} model '{model_choice}' selected but `{env_var}` is not set.\n"
+            "Add it to your .env file or export it before running the app."
+        )
 
     class_name = getattr(llm_class, "__name__", str(llm_class))
 
     if "ChatAnthropic" in class_name:
         _require(ANTHROPIC_API_KEY, "ANTHROPIC_API_KEY", "Anthropic")
-    elif "ChatGoogleGenerativeAI" in class_name:
-        _require(GOOGLE_API_KEY, "GOOGLE_API_KEY", "Google Gemini")
-    elif "ChatOpenAI" in class_name:
-        base_url = (model_params or {}).get("base_url", "").lower()
-        if "openrouter" in base_url:
-            _require(OPENROUTER_API_KEY, "OPENROUTER_API_KEY", "OpenRouter")
-        else:
-            _require(OPENAI_API_KEY, "OPENAI_API_KEY", "OpenAI")
+    elif "ChatGoogleGenerativeAI" in class_name:
+        _require(GOOGLE_API_KEY, "GOOGLE_API_KEY", "Google Gemini")
+    elif "ChatOpenAI" in class_name:
+        base_url = str((model_params or {}).get("base_url", "")).lower()
+        if "openrouter" in base_url:
+            _require(OPENROUTER_API_KEY, "OPENROUTER_API_KEY", "OpenRouter")
+            return
+
+        if _is_configured(OPENAI_API_KEY) or _is_configured(OPENAI_BASE_URL):
+            return
+
+        raise ValueError(
+            f"OpenAI model '{model_choice}' selected but neither `OPENAI_API_KEY` nor `OPENAI_BASE_URL` is configured.\n"
+            "Set `OPENAI_API_KEY` for OpenAI cloud, or set `OPENAI_BASE_URL` for an OpenAI-compatible endpoint."
+        )
 
 
 def refine_query(llm, user_input):

llm_utils.py

@@ -6,13 +6,13 @@ from typing import Callable, Optional, List
 from langchain_anthropic import ChatAnthropic
 from langchain_google_genai import ChatGoogleGenerativeAI
 from langchain_core.callbacks.base import BaseCallbackHandler
-import os
 from config import (
     OLLAMA_BASE_URL,
     OPENROUTER_BASE_URL,
     OPENROUTER_API_KEY,
     GOOGLE_API_KEY,
     OPENAI_API_KEY,
+    OPENAI_BASE_URL,
     ANTHROPIC_API_KEY,
     LLAMA_CPP_BASE_URL,
 )
@@ -51,28 +51,49 @@ _common_llm_params = {
     "callbacks": _common_callbacks,
 }
 
+
+def _clean_optional_url(value: Optional[str]) -> Optional[str]:
+    if not value:
+        return None
+    cleaned = value.strip().rstrip("/")
+    if not cleaned or "your_" in cleaned.lower():
+        return None
+    return cleaned
+
+
+_DIRECT_OPENAI_BASE_URL = _clean_optional_url(OPENAI_BASE_URL)
+
+
+def _openai_constructor_params(model_name: str) -> dict:
+    params = {"model_name": model_name}
+    if _DIRECT_OPENAI_BASE_URL:
+        params["base_url"] = _DIRECT_OPENAI_BASE_URL
+        # Some OpenAI-compatible gateways accept any placeholder key.
+        params["api_key"] = OPENAI_API_KEY or "sk-local"
+    return params
+
 # Map input model choices (lowercased) to their configuration
 # Each config includes the class and any model-specific constructor parameters
 _llm_config_map = {
     'gpt-4.1': {
         'class': ChatOpenAI,
-        'constructor_params': {'model_name': 'gpt-4.1'} 
+        'constructor_params': _openai_constructor_params('gpt-4.1')
     },
     'gpt-5.2': {
         'class': ChatOpenAI,
-        'constructor_params': {'model_name': 'gpt-5.2'} 
+        'constructor_params': _openai_constructor_params('gpt-5.2')
     },
     'gpt-5.1': {
         'class': ChatOpenAI,
-        'constructor_params': {'model_name': 'gpt-5.1'} 
+        'constructor_params': _openai_constructor_params('gpt-5.1')
     },
     'gpt-5-mini': {
         'class': ChatOpenAI,
-        'constructor_params': {'model_name': 'gpt-5-mini'} 
+        'constructor_params': _openai_constructor_params('gpt-5-mini')
     },
     'gpt-5-nano': { 
         'class': ChatOpenAI,
-        'constructor_params': {'model_name': 'gpt-5-nano'} 
+        'constructor_params': _openai_constructor_params('gpt-5-nano')
     },
     'claude-sonnet-4-5': {
         'class': ChatAnthropic,
@@ -244,7 +265,7 @@ def get_model_choices() -> List[str]:
     """
     gated_base_models: List[str] = []
 
-    openai_ok = _is_set(OPENAI_API_KEY)
+    openai_ok = _is_set(OPENAI_API_KEY) or _is_set(OPENAI_BASE_URL)
     anthropic_ok = _is_set(ANTHROPIC_API_KEY)
     google_ok = _is_set(GOOGLE_API_KEY)
     openrouter_ok = _is_set(OPENROUTER_API_KEY) and _is_set(OPENROUTER_BASE_URL)
@@ -333,4 +354,4 @@ def resolve_model_config(model_choice: str):
                 "constructor_params": {"model": ollama_model, "base_url": OLLAMA_BASE_URL},
             }
 
-    return None
+    return None