Skip to content

fix: remove incorrect OpenAI API key requirement from docs and samples #210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cosmyo wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: remove incorrect OpenAI API key requirement from docs and samples #210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 2 additions & 16 deletions packages/uipath-openai-agents/docs/quick_start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,10 @@ Before proceeding, ensure you have the following installed:
- Python 3.11 or higher
- `pip` or `uv` package manager
- A UiPath Automation Cloud account with appropriate permissions
- An OpenAI API key

/// info
**OpenAI** - Generate an OpenAI API key [here](https://platform.openai.com).
///
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.
///

## Creating a New Project

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

## Set Up Environment Variables

Before running the agent, configure `OPENAI_API_KEY` in the `.env` file:

//// tab | Open AI

```
OPENAI_API_KEY=sk-proj-......
```

////

## Authenticate With UiPath

<!-- termynal -->
Expand Down
5 changes: 0 additions & 5 deletions packages/uipath-openai-agents/samples/agent-as-tools/.env.example
View file
Open in desktop

This file was deleted.

3 changes: 2 additions & 1 deletion packages/uipath-openai-agents/samples/rag-assistant/.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# OpenAI API Key
# This sample uses the OpenAI client directly (without UiPathChatOpenAI),
# so an OpenAI API key is required.
# Get your API key from https://platform.openai.com/api-keys
OPENAI_API_KEY=sk-...