Merge pull request #307 from scaleapi/dm/litellm-key-templates

danielmillerp · web-flow · commit bd4b6201ef4f · 2026-04-05T14:04:53.000-04:00
Switch agent templates from OPENAI_API_KEY to LITELLM_API_KEY
diff --git a/src/agentex/lib/cli/templates/default-langgraph/.env.example.j2 b/src/agentex/lib/cli/templates/default-langgraph/.env.example.j2
@@ -0,0 +1,12 @@
+# {{ agent_name }} - Environment Variables
+# Copy this file to .env and fill in the values
+
+# API key for your LLM provider
+LITELLM_API_KEY=
+
+# LLM base URL (optional - override to use a different provider)
+# OPENAI_BASE_URL=
+
+# SGP Configuration (optional - for tracing)
+# SGP_API_KEY=
+# SGP_ACCOUNT_ID=
diff --git a/src/agentex/lib/cli/templates/default-langgraph/README.md.j2 b/src/agentex/lib/cli/templates/default-langgraph/README.md.j2
@@ -74,9 +74,9 @@ TOOLS = [my_tool]
 Edit `project/graph.py` to modify the model, system prompt, or graph structure.
 
 ### 3. Configure Credentials
-Set your OpenAI API key:
-1. In `manifest.yaml` under `env.OPENAI_API_KEY`
-2. Or export: `export OPENAI_API_KEY=...`
+Set your LLM API key:
+1. In `manifest.yaml` under `env.LITELLM_API_KEY`
+2. Or export: `export LITELLM_API_KEY=...`
 3. Or create a `.env` file in the project directory
 
 ### 4. Run Locally
diff --git a/src/agentex/lib/cli/templates/default-langgraph/manifest.yaml.j2 b/src/agentex/lib/cli/templates/default-langgraph/manifest.yaml.j2
@@ -76,8 +76,8 @@ agent:
   # Maps Kubernetes secrets to environment variables
   # Common credentials include:
   credentials:
-    - env_var_name: OPENAI_API_KEY
-      secret_name: openai-api-key
+    - env_var_name: LITELLM_API_KEY
+      secret_name: litellm-api-key
       secret_key: api-key
     - env_var_name: SGP_API_KEY
       secret_name: sgp-api-key
@@ -89,7 +89,7 @@ agent:
   # Optional: Set Environment variables for running your agent locally as well
   # as for deployment later on
   env:
-    OPENAI_API_KEY: ""  # Set your OpenAI API key
+    LITELLM_API_KEY: ""  # Set your LLM API key
   #   OPENAI_BASE_URL: "<YOUR_OPENAI_BASE_URL_HERE>"
 
 # Deployment Configuration
diff --git a/src/agentex/lib/cli/templates/default-langgraph/project/acp.py.j2 b/src/agentex/lib/cli/templates/default-langgraph/project/acp.py.j2
@@ -9,6 +9,11 @@ from dotenv import load_dotenv
 load_dotenv()
 import os
 
+# LiteLLM proxy auth: copy LITELLM_API_KEY to OPENAI_API_KEY for OpenAI client compatibility
+_litellm_key = os.environ.get("LITELLM_API_KEY")
+if _litellm_key:
+    os.environ["OPENAI_API_KEY"] = _litellm_key
+
 import agentex.lib.adk as adk
 from agentex.lib.adk import create_langgraph_tracing_handler, stream_langgraph_events
 from agentex.lib.core.tracing.tracing_processor_manager import add_tracing_processor_config
diff --git a/src/agentex/lib/cli/templates/default/.env.example.j2 b/src/agentex/lib/cli/templates/default/.env.example.j2
@@ -0,0 +1,12 @@
+# {{ agent_name }} - Environment Variables
+# Copy this file to .env and fill in the values
+
+# API key for your LLM provider
+LITELLM_API_KEY=
+
+# LLM base URL (optional - override to use a different provider)
+# OPENAI_BASE_URL=
+
+# SGP Configuration (optional - for tracing)
+# SGP_API_KEY=
+# SGP_ACCOUNT_ID=
diff --git a/src/agentex/lib/cli/templates/default/README.md.j2 b/src/agentex/lib/cli/templates/default/README.md.j2
@@ -139,7 +139,7 @@ pip install -r requirements.txt
 ### 4. Configure Credentials
 Options:
 1. Add any required credentials to your manifest.yaml via the `env` section
-2. Export them in your shell: `export OPENAI_API_KEY=...`
+2. Export them in your shell: `export LITELLM_API_KEY=...`
 3. For local development, create a `.env.local` file in the project directory
 
 ```python
diff --git a/src/agentex/lib/cli/templates/default/manifest.yaml.j2 b/src/agentex/lib/cli/templates/default/manifest.yaml.j2
@@ -80,14 +80,14 @@ agent:
       secret_name: redis-url-secret
       secret_key: url
   # credentials:
-  #   - env_var_name: OPENAI_API_KEY
-  #     secret_name: openai-api-key
+  #   - env_var_name: LITELLM_API_KEY
+  #     secret_name: litellm-api-key
   #     secret_key: api-key
 
   # Optional: Set Environment variables for running your agent locally as well 
   # as for deployment later on
   env: {}
-  #   OPENAI_API_KEY: "<YOUR_OPENAI_API_KEY_HERE>"
+  #   LITELLM_API_KEY: "<YOUR_LITELLM_API_KEY_HERE>"
   #   OPENAI_BASE_URL: "<YOUR_OPENAI_BASE_URL_HERE>"
   #   OPENAI_ORG_ID: "<YOUR_OPENAI_ORG_ID_HERE>"
 
diff --git a/src/agentex/lib/cli/templates/sync-langgraph/.env.example.j2 b/src/agentex/lib/cli/templates/sync-langgraph/.env.example.j2
@@ -0,0 +1,12 @@
+# {{ agent_name }} - Environment Variables
+# Copy this file to .env and fill in the values
+
+# API key for your LLM provider
+LITELLM_API_KEY=
+
+# LLM base URL (optional - override to use a different provider)
+# OPENAI_BASE_URL=
+
+# SGP Configuration (optional - for tracing)
+# SGP_API_KEY=
+# SGP_ACCOUNT_ID=
diff --git a/src/agentex/lib/cli/templates/sync-langgraph/README.md.j2 b/src/agentex/lib/cli/templates/sync-langgraph/README.md.j2
@@ -72,9 +72,9 @@ TOOLS = [my_tool]
 Edit `project/graph.py` to modify the model, system prompt, or graph structure.
 
 ### 3. Configure Credentials
-Set your OpenAI API key:
-1. In `manifest.yaml` under `env.OPENAI_API_KEY`
-2. Or export: `export OPENAI_API_KEY=...`
+Set your LLM API key:
+1. In `manifest.yaml` under `env.LITELLM_API_KEY`
+2. Or export: `export LITELLM_API_KEY=...`
 3. Or create a `.env` file in the project directory
 
 ### 4. Run Locally
diff --git a/src/agentex/lib/cli/templates/sync-langgraph/manifest.yaml.j2 b/src/agentex/lib/cli/templates/sync-langgraph/manifest.yaml.j2
@@ -75,8 +75,8 @@ agent:
   # Maps Kubernetes secrets to environment variables
   # Common credentials include:
   credentials:
-    - env_var_name: OPENAI_API_KEY
-      secret_name: openai-api-key
+    - env_var_name: LITELLM_API_KEY
+      secret_name: litellm-api-key
       secret_key: api-key
     - env_var_name: SGP_API_KEY
       secret_name: sgp-api-key
@@ -85,7 +85,7 @@ agent:
   # Optional: Set Environment variables for running your agent locally as well
   # as for deployment later on
   env:
-    OPENAI_API_KEY: ""  # Set your OpenAI API key
+    LITELLM_API_KEY: ""  # Set your LLM API key
   #   OPENAI_BASE_URL: "<YOUR_OPENAI_BASE_URL_HERE>"
 
 
diff --git a/src/agentex/lib/cli/templates/sync-langgraph/project/acp.py.j2 b/src/agentex/lib/cli/templates/sync-langgraph/project/acp.py.j2
@@ -22,6 +22,11 @@ from dotenv import load_dotenv
 load_dotenv()
 import os
 
+# LiteLLM proxy auth: copy LITELLM_API_KEY to OPENAI_API_KEY for OpenAI client compatibility
+_litellm_key = os.environ.get("LITELLM_API_KEY")
+if _litellm_key:
+    os.environ["OPENAI_API_KEY"] = _litellm_key
+
 from project.graph import create_graph
 
 logger = make_logger(__name__)
diff --git a/src/agentex/lib/cli/templates/sync-openai-agents/.env.example.j2 b/src/agentex/lib/cli/templates/sync-openai-agents/.env.example.j2
@@ -0,0 +1,12 @@
+# {{ agent_name }} - Environment Variables
+# Copy this file to .env and fill in the values
+
+# API key for your LLM provider
+LITELLM_API_KEY=
+
+# LLM base URL (optional - override to use a different provider)
+# OPENAI_BASE_URL=
+
+# SGP Configuration (optional - for tracing)
+# SGP_API_KEY=
+# SGP_ACCOUNT_ID=
diff --git a/src/agentex/lib/cli/templates/sync-openai-agents/README.md.j2 b/src/agentex/lib/cli/templates/sync-openai-agents/README.md.j2
@@ -136,7 +136,7 @@ pip install -r requirements.txt
 ### 4. Configure Credentials
 Options:
 1. Add any required credentials to your manifest.yaml via the `env` section
-2. Export them in your shell: `export OPENAI_API_KEY=...`
+2. Export them in your shell: `export LITELLM_API_KEY=...`
 3. For local development, create a `.env.local` file in the project directory
 
 ## Local Development
diff --git a/src/agentex/lib/cli/templates/sync-openai-agents/manifest.yaml.j2 b/src/agentex/lib/cli/templates/sync-openai-agents/manifest.yaml.j2
@@ -75,14 +75,14 @@ agent:
   # Maps Kubernetes secrets to environment variables
   # Common credentials include:
   credentials: [] # Update with your credentials
-  #   - env_var_name: OPENAI_API_KEY
-  #     secret_name: openai-api-key
+  #   - env_var_name: LITELLM_API_KEY
+  #     secret_name: litellm-api-key
   #     secret_key: api-key
 
   # Optional: Set Environment variables for running your agent locally as well 
   # as for deployment later on
   env: {} # Update with your environment variables
-  #   OPENAI_API_KEY: "<YOUR_OPENAI_API_KEY_HERE>"
+  #   LITELLM_API_KEY: "<YOUR_LITELLM_API_KEY_HERE>"
   #   OPENAI_BASE_URL: "<YOUR_OPENAI_BASE_URL_HERE>"
   #   OPENAI_ORG_ID: "<YOUR_OPENAI_ORG_ID_HERE>"
 
diff --git a/src/agentex/lib/cli/templates/sync-openai-agents/project/acp.py.j2 b/src/agentex/lib/cli/templates/sync-openai-agents/project/acp.py.j2
@@ -18,6 +18,11 @@ from agents import Agent, Runner, RunConfig, function_tool
 
 logger = make_logger(__name__)
 
+# LiteLLM proxy auth: copy LITELLM_API_KEY to OPENAI_API_KEY for OpenAI client compatibility
+_litellm_key = os.environ.get("LITELLM_API_KEY")
+if _litellm_key:
+    os.environ["OPENAI_API_KEY"] = _litellm_key
+
 SGP_API_KEY = os.environ.get("SGP_API_KEY", "")
 SGP_ACCOUNT_ID = os.environ.get("SGP_ACCOUNT_ID", "")
 
@@ -75,13 +80,13 @@ class StateModel(BaseModel):
 async def handle_message_send(
     params: SendMessageParams
 ) -> TaskMessageContent | list[TaskMessageContent] | AsyncGenerator[TaskMessageUpdate, None]:
-    if not os.environ.get("OPENAI_API_KEY"):
+    if not os.environ.get("LITELLM_API_KEY"):
         yield StreamTaskMessageFull(
             index=0,
             type="full",
             content=TextContent(
                 author="agent",
-                content="Hey, sorry I'm unable to respond to your message because you're running this example without an OpenAI API key. Please set the OPENAI_API_KEY environment variable to run this example. Do this by either by adding a .env file to the project/ directory or by setting the environment variable in your terminal.",
+                content="Hey, sorry I'm unable to respond to your message because you're running this example without a LiteLLM API key. Please set the LITELLM_API_KEY environment variable to run this example. Do this by either adding a .env file to the project/ directory or by setting the environment variable in your terminal.",
             ),
         )
         return
diff --git a/src/agentex/lib/cli/templates/sync/.env.example.j2 b/src/agentex/lib/cli/templates/sync/.env.example.j2
@@ -0,0 +1,12 @@
+# {{ agent_name }} - Environment Variables
+# Copy this file to .env and fill in the values
+
+# API key for your LLM provider
+LITELLM_API_KEY=
+
+# LLM base URL (optional - override to use a different provider)
+# OPENAI_BASE_URL=
+
+# SGP Configuration (optional - for tracing)
+# SGP_API_KEY=
+# SGP_ACCOUNT_ID=
diff --git a/src/agentex/lib/cli/templates/sync/README.md.j2 b/src/agentex/lib/cli/templates/sync/README.md.j2
@@ -136,7 +136,7 @@ pip install -r requirements.txt
 ### 4. Configure Credentials
 Options:
 1. Add any required credentials to your manifest.yaml via the `env` section
-2. Export them in your shell: `export OPENAI_API_KEY=...`
+2. Export them in your shell: `export LITELLM_API_KEY=...`
 3. For local development, create a `.env.local` file in the project directory
 
 ## Local Development
diff --git a/src/agentex/lib/cli/templates/sync/manifest.yaml.j2 b/src/agentex/lib/cli/templates/sync/manifest.yaml.j2
@@ -75,14 +75,14 @@ agent:
   # Maps Kubernetes secrets to environment variables
   # Common credentials include:
   credentials: [] # Update with your credentials
-  #   - env_var_name: OPENAI_API_KEY
-  #     secret_name: openai-api-key
+  #   - env_var_name: LITELLM_API_KEY
+  #     secret_name: litellm-api-key
   #     secret_key: api-key
 
   # Optional: Set Environment variables for running your agent locally as well 
   # as for deployment later on
   env: {} # Update with your environment variables
-  #   OPENAI_API_KEY: "<YOUR_OPENAI_API_KEY_HERE>"
+  #   LITELLM_API_KEY: "<YOUR_LITELLM_API_KEY_HERE>"
   #   OPENAI_BASE_URL: "<YOUR_OPENAI_BASE_URL_HERE>"
   #   OPENAI_ORG_ID: "<YOUR_OPENAI_ORG_ID_HERE>"
 
diff --git a/src/agentex/lib/cli/templates/temporal-openai-agents/.env.example.j2 b/src/agentex/lib/cli/templates/temporal-openai-agents/.env.example.j2
@@ -0,0 +1,12 @@
+# {{ agent_name }} - Environment Variables
+# Copy this file to .env and fill in the values
+
+# API key for your LLM provider
+LITELLM_API_KEY=
+
+# LLM base URL (optional - override to use a different provider)
+# OPENAI_BASE_URL=
+
+# SGP Configuration (optional - for tracing)
+# SGP_API_KEY=
+# SGP_ACCOUNT_ID=
diff --git a/src/agentex/lib/cli/templates/temporal-openai-agents/README.md.j2 b/src/agentex/lib/cli/templates/temporal-openai-agents/README.md.j2
@@ -192,7 +192,7 @@ make dev
 For local development, create a `.env` file:
 
 ```bash
-OPENAI_API_KEY=your-api-key
+LITELLM_API_KEY=your-litellm-key
 SGP_API_KEY=your-sgp-key        # Optional: for tracing
 SGP_ACCOUNT_ID=your-account-id  # Optional: for tracing
 ```
@@ -212,7 +212,7 @@ SGP_ACCOUNT_ID=your-account-id  # Optional: for tracing
    - Check workflow logs
 
 3. **OpenAI API errors**
-   - Verify `OPENAI_API_KEY` is set
+   - Verify `LITELLM_API_KEY` is set
    - Check API rate limits
    - Verify model name is correct
 
diff --git a/src/agentex/lib/cli/templates/temporal-openai-agents/manifest.yaml.j2 b/src/agentex/lib/cli/templates/temporal-openai-agents/manifest.yaml.j2
@@ -100,14 +100,14 @@ agent:
     - env_var_name: REDIS_URL
       secret_name: redis-url-secret
       secret_key: url
-  #   - env_var_name: OPENAI_API_KEY
-  #     secret_name: openai-api-key
+  #   - env_var_name: LITELLM_API_KEY
+  #     secret_name: litellm-api-key
   #     secret_key: api-key
   
   # Optional: Set Environment variables for running your agent locally as well 
   # as for deployment later on
   env: {}
-  #   OPENAI_API_KEY: "<YOUR_OPENAI_API_KEY_HERE>"
+  #   LITELLM_API_KEY: "<YOUR_LITELLM_API_KEY_HERE>"
   #   OPENAI_BASE_URL: "<YOUR_OPENAI_BASE_URL_HERE>"
   #   OPENAI_ORG_ID: "<YOUR_OPENAI_ORG_ID_HERE>"
 
diff --git a/src/agentex/lib/cli/templates/temporal-openai-agents/project/acp.py.j2 b/src/agentex/lib/cli/templates/temporal-openai-agents/project/acp.py.j2
@@ -1,5 +1,11 @@
 import os
 import sys
+
+# LiteLLM proxy auth: copy LITELLM_API_KEY to OPENAI_API_KEY for OpenAI client compatibility
+_litellm_key = os.environ.get("LITELLM_API_KEY")
+if _litellm_key:
+    os.environ["OPENAI_API_KEY"] = _litellm_key
+
 from temporalio.contrib.openai_agents import OpenAIAgentsPlugin, ModelActivityParameters
 from datetime import timedelta
 from agentex.lib.core.temporal.plugins.openai_agents.interceptors.context_interceptor import ContextInterceptor
diff --git a/src/agentex/lib/cli/templates/temporal/.env.example.j2 b/src/agentex/lib/cli/templates/temporal/.env.example.j2
@@ -0,0 +1,12 @@
+# {{ agent_name }} - Environment Variables
+# Copy this file to .env and fill in the values
+
+# API key for your LLM provider
+LITELLM_API_KEY=
+
+# LLM base URL (optional - override to use a different provider)
+# OPENAI_BASE_URL=
+
+# SGP Configuration (optional - for tracing)
+# SGP_API_KEY=
+# SGP_ACCOUNT_ID=
diff --git a/src/agentex/lib/cli/templates/temporal/manifest.yaml.j2 b/src/agentex/lib/cli/templates/temporal/manifest.yaml.j2
@@ -100,14 +100,14 @@ agent:
     - env_var_name: REDIS_URL
       secret_name: redis-url-secret
       secret_key: url
-  #   - env_var_name: OPENAI_API_KEY
-  #     secret_name: openai-api-key
+  #   - env_var_name: LITELLM_API_KEY
+  #     secret_name: litellm-api-key
   #     secret_key: api-key
   
   # Optional: Set Environment variables for running your agent locally as well 
   # as for deployment later on
   env: {}
-  #   OPENAI_API_KEY: "<YOUR_OPENAI_API_KEY_HERE>"
+  #   LITELLM_API_KEY: "<YOUR_LITELLM_API_KEY_HERE>"
   #   OPENAI_BASE_URL: "<YOUR_OPENAI_BASE_URL_HERE>"
   #   OPENAI_ORG_ID: "<YOUR_OPENAI_ORG_ID_HERE>"
 
