Skip to content

Commit 5012e53

Browse files
authored
Merge pull request #777 from anik120/add-open-api-key-prereq
Add OpenAPI key req to pre-req
2 parents b25ed15 + 48e6e24 commit 5012e53

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,31 @@ Lightspeed Core Stack is based on the FastAPI framework (Uvicorn). The service i
9494
- please note that currently Python 3.14 is not officially supported
9595
- all sources are made (backward) compatible with Python 3.12; it is checked on CI
9696

97+
* OpenAI API Key (Recommended for Getting Started)
98+
99+
Lightspeed Stack supports multiple LLM providers.
100+
101+
| Provider | Setup Documentation |
102+
|----------------|-----------------------------------------------------------------------|
103+
| OpenAI | https://platform.openai.com |
104+
| Azure OpenAI | https://azure.microsoft.com/en-us/products/ai-services/openai-service |
105+
| RHOAI (vLLM) | See tests/e2e-prow/rhoai/configs/run.yaml |
106+
| RHEL AI (vLLM) | See tests/e2e/configs/run-rhelai.yaml |
107+
108+
See `docs/providers.md` for configuration details.
109+
110+
You will need an API key from one of these providers to run LightSpeed Stack.
111+
112+
For example, if you choose to use OpenAI:
113+
114+
1. **Create an account** at [platform.openai.com](https://platform.openai.com)
115+
2. **Add payment information** (new accounts receive free trial credits)
116+
3. **Generate an API key** from your dashboard at [API Keys](https://platform.openai.com/api-keys)
117+
4. **Export the key** in your environment:
118+
```bash
119+
export OPENAI_API_KEY="sk-your-api-key-here"
120+
```
121+
97122
# Installation
98123

99124
Installation steps depends on operation system. Please look at instructions for your system:

0 commit comments

Comments
 (0)