From e847ba072c576a0a1941f2a78e989f477f8d9fbb Mon Sep 17 00:00:00 2001 From: Michael Struwig Date: Fri, 17 May 2024 11:39:20 +0200 Subject: [PATCH] Add openai api key instructions. --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index f70982f..0689f53 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,17 @@ pip install openbb-agents --upgrade ``` ## Setup +### OpenAI API keys + +To use OpenBB LLM Agents, you need an OpenAI API key. Follow these steps: + +1. **Get API Key**: Sign up on [OpenAI](https://www.openai.com/) and get your API key. +2. **Set Environment Variable**: Add this to your shell profile (`.bashrc`, `.zshrc`, etc.): + ```sh + export OPENAI_API_KEY="your_openai_api_key" + ``` + +### OpenBB Platform data provider credentials To use the OpenBB Platform functions, you need to configure the necessary [data provider API credentials](https://docs.openbb.co/platform/usage/api_keys). This can be done in one of two ways: 1. **Local Configuration**: Specify your credentials in a `~/.openbb_platform/user_settings.json` file. Follow the [local environment setup guide](https://docs.openbb.co/platform/usage/api_keys#local-environment) for detailed instructions.