Skip to content

Commit c3911a9

Browse files
cosmyoclaude
andcommitted
fix: clarify when OpenAI API key is vs isn't needed
Add info box to quick_start.md explaining that UiPathChatOpenAI handles auth via UiPath LLM Gateway (no key needed), but direct OpenAI client usage requires OPENAI_API_KEY. Revert rag-assistant .env.example since that sample uses the OpenAI client directly. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent e49e6ed commit c3911a9

2 files changed

Lines changed: 8 additions & 3 deletions

File tree

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ Before proceeding, ensure you have the following installed:
1212
- `pip` or `uv` package manager
1313
- A UiPath Automation Cloud account with appropriate permissions
1414

15+
/// info
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+
///
18+
1519
## Creating a New Project
1620

1721
We recommend using `uv` for package management. To create a new project:
Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1-
# UiPath Configuration
2-
# No OpenAI API key is needed - UiPathChatOpenAI routes requests through UiPath's LLM Gateway.
3-
# Run `uipath auth` to authenticate with UiPath Automation Cloud.
1+
# This sample uses the OpenAI client directly (without UiPathChatOpenAI),
2+
# so an OpenAI API key is required.
3+
# Get your API key from https://platform.openai.com/api-keys
4+
OPENAI_API_KEY=sk-...

0 commit comments

Comments
 (0)