Add API key troubleshooting to README #2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a troubleshooting note to the README.md to address a common API key error.
Problem
When running the scripts, a user might encounter a vague error like 'api_key' has not been loaded even if they have correctly set the GROQ_API_KEY in their .env file.
Cause
The application appears to have two separate checks:
An initial load_env() check that looks for OPENAI_API_KEY.
An invoke_llm() call that (correctly) requires GROQ_API_KEY when using Groq-hosted models.
This conflict causes the script to fail at startup if only the GROQ_API_KEY is present.
Solution
This commit updates the README with a new "Troubleshooting API Keys" section, advising users to add both OPENAI_API_KEY and GROQ_API_KEY to their .env file to satisfy both checks.