fix: Centralize API key validation and fix misleading error messages #684
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
Addresses confusing behavior where TeamAgentFactory showed misleading errors suggesting only TEAM_API_KEY was acceptable, when AIXPLAIN_API_KEY should also work. - Created centralized validation functions in config.py (single source of truth) - Updated api_key_checker.py to use centralized logic - Updated v2/core.py to accept either API key - Fixed error messages to indicate both keys are acceptable - Users can now use either AIXPLAIN_API_KEY or TEAM_API_KEY - Clear, consistent error messages across SDK - Backward compatible, no breaking changes Before: "TEAM_API_KEY has not been set properly" (misleading) After: "Neither 'AIXPLAIN_API_KEY' nor 'TEAM_API_KEY' has been set. Please set either environment variable."
ahmetgunduz
requested review from
elsheikhams99,
kadirpekel and
xainaz
and removed request for
xainaz
xainaz
approved these changes
Sep 18, 2025
ahmetgunduz
deleted the
BUG-638-TeamAgentFactory-incorrectly-requires-TEAM_API_KEY
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Addresses confusing behavior where TeamAgentFactory showed misleading
errors suggesting only TEAM_API_KEY was acceptable, when AIXPLAIN_API_KEY
should also work.
Created centralized validation functions in config.py (single source of truth)
Updated api_key_checker.py to use centralized logic
Updated v2/core.py to accept either API key
Fixed error messages to indicate both keys are acceptable
Users can now use either AIXPLAIN_API_KEY or TEAM_API_KEY
Clear, consistent error messages across SDK
Backward compatible, no breaking changes
Before: "TEAM_API_KEY has not been set properly" (misleading)
After: "Neither 'AIXPLAIN_API_KEY' nor 'TEAM_API_KEY' has been set. Please set either environment variable."