To configure and work with the OpenAI API key on macOS, follow these step-by-step instructions:
Step 1: Sign Up for OpenAI API Access
1. Create an Account: Go to the [OpenAI website](https://www.openai.com/) and sign up for an account if you don’t have one.
2. API Key: Once logged in, navigate to the API section of your account dashboard to generate your API key. Make sure to copy this key, as you will need it later.
Step 2: Install Required Software
1. Install Homebrew (if you don’t have it):
- Open Terminal and run:
bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
2. Install Python (if you don’t have it):
- You can install Python using Homebrew:
bash
brew install python
3. Install pip (Python package manager):
- Pip usually comes with Python, but you can ensure it’s installed by running:
bash
python3 -m ensurepip --upgrade
Step 3: Set Up a Virtual Environment (Optional)
1. Create a Virtual Environment:
- Navigate to your project directory in Terminal and run:
bash
python3 -m venv myenv
- Replace `myenv` with your desired environment name.
2. Activate the Virtual Environment:
- Run:
bash
source myenv/bin/activate
Step 4: Install OpenAI Python Client
1. Install the OpenAI package**:
- With your virtual environment activated, run:
bash
pip install openai
Step 5: Configure Your API Key
1. Set the API Key in Your Environment**:
- You can set your API key as an environment variable. In Terminal, run:
bash
export OPENAI_API_KEY='your_api_key_here'
- Replace `'your_api_key_here'` with the actual API key you copied earlier.
2. Make it Permanent (Optional):
- To make this change permanent, you can add the export command to your shell configuration file (e.g., `.bash_profile`, `.zshrc`, or `.bashrc` depending on your shell). Open the file in a text editor:
bash
nano ~/.zshrc
- Add the line:
bash
export OPENAI_API_KEY='your_api_key_here'
- Save and exit (in nano, press `CTRL + X`, then `Y`, and `Enter`).
- Run `source ~/.zshrc` to apply the changes.
Step 6: Test the OpenAI API
1. Create a Python Script:
- Create a new Python file, e.g., `test_openai.py`:
bash
touch test_openai.py
2. Write a Simple Script:
- Open the file in a text editor and add the following code:
python
import openai
import os
openai.api_key = os.getenv("OPENAI_API_KEY")
response = openai.ChatCompletion.create(
model="gpt-3.5-turbo",
messages=[
{"role": "user", "content": "Hello, how are you?"}
]
)
print(response.choices[0].message['content'])
3. Run the Script:
- In Terminal, run:
bash
python3 test_openai.py
Step 7: Review the Output
- You should see a response from the OpenAI API printed in your Terminal.
Additional Notes
- Make sure to keep your API key secure and do not share it publicly.
- Refer to the [OpenAI API documentation](https://platform.openai.com/docs/api-reference) for more details on how to use the API effectively.
By following these steps, you should be able to configure and work with the OpenAI API on macOS successfully.