Skip to content

Commit 4114eb6

Browse files
cosmyoclaude
andcommitted
fix: remove incorrect OpenAI API key requirement from docs and samples
UiPathChatOpenAI routes all requests through UiPath's LLM Gateway, so no OpenAI API key is needed. Removed misleading references from quick_start.md and added an info box clarifying that an OPENAI_API_KEY is only required when using the OpenAI client directly. - Removed OpenAI API key from prerequisites in quick_start.md - Removed the "Set Up Environment Variables" section - Added info box explaining UiPathChatOpenAI vs direct OpenAI usage - Removed agent-as-tools .env.example (uses UiPathChatOpenAI, no env needed) - Updated rag-assistant .env.example to clarify direct OpenAI client usage Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 60eadd5 commit 4114eb6

3 files changed

Lines changed: 4 additions & 22 deletions

File tree

packages/uipath-openai-agents/docs/quick_start.md

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,10 @@ Before proceeding, ensure you have the following installed:
1111
- Python 3.11 or higher
1212
- `pip` or `uv` package manager
1313
- A UiPath Automation Cloud account with appropriate permissions
14-
- An OpenAI API key
1514

1615
/// info
17-
**OpenAI** - Generate an OpenAI API key [here](https://platform.openai.com).
18-
///
16+
The generated boilerplate uses `UiPathChatOpenAI`, which routes all LLM requests through the **UiPath LLM Gateway**. No OpenAI API key is required — authentication is handled via `uipath auth`. If you choose to use the OpenAI client directly (without `UiPathChatOpenAI`), you will need to configure an `OPENAI_API_KEY` environment variable.
17+
///
1918

2019
## Creating a New Project
2120

@@ -104,7 +103,6 @@ Generate your first UiPath OpenAI agent:
104103
✓ Created 'main.py' file.
105104
✓ Created 'openai_agents.json' file.
106105
✓ Created 'pyproject.toml' file.
107-
🔧 Please ensure to define OPENAI_API_KEY in your .env file.
108106
💡 Initialize project: uipath init
109107
💡 Run agent: uipath run agent '{"messages": "Hello"}'
110108
```
@@ -138,18 +136,6 @@ This command creates the following files:
138136
| `uipath.json` | Input/output JSON schemas and bindings. |
139137
| `agent.mermaid` | Graph visual representation. |
140138

141-
## Set Up Environment Variables
142-
143-
Before running the agent, configure `OPENAI_API_KEY` in the `.env` file:
144-
145-
//// tab | Open AI
146-
147-
```
148-
OPENAI_API_KEY=sk-proj-......
149-
```
150-
151-
////
152-
153139
## Authenticate With UiPath
154140

155141
<!-- termynal -->

packages/uipath-openai-agents/samples/agent-as-tools/.env.example

Lines changed: 0 additions & 5 deletions
This file was deleted.
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1-
# OpenAI API Key
1+
# This sample uses the OpenAI client directly (without UiPathChatOpenAI),
2+
# so an OpenAI API key is required.
23
# Get your API key from https://platform.openai.com/api-keys
34
OPENAI_API_KEY=sk-...

0 commit comments

Comments
 (0)