-
Notifications
You must be signed in to change notification settings - Fork 1.2k
add support for token provider #1587
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
deyaaeldeen
wants to merge
9
commits into
openai:next
Choose a base branch
from
deyaaeldeen:feat/token-provider
base: next
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
+198
−99
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
b4dd476
to
f514473
Compare
tetraprod
approved these changes
Jul 18, 2025
tetraprod
approved these changes
Jul 18, 2025
tetraprod
approved these changes
Jul 18, 2025
tetraprod
approved these changes
Jul 18, 2025
tetraprod
approved these changes
Jul 18, 2025
tetraprod
approved these changes
Jul 18, 2025
f514473
to
a5ce6ac
Compare
1453757
to
b623760
Compare
b623760
to
0307ed5
Compare
RobertCraigie
approved these changes
Aug 28, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great!
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.
Changes being requested
This PR introduces a new
tokenProvider
option to the OpenAI client, enabling dynamic token retrieval for authentication scenarios where API keys need to be refreshed or obtained at runtime.Additional context & links
Changes
New Feature:
tokenProvider
OptionTokenProvider
type definition:() => Promise<AccessToken>
AccessToken
interface withtoken: string
propertytokenProvider
option toClientOptions
interface_setToken()
methodKey Benefits
Implementation Details
Client Construction:
tokenProvider
andapiKey
are mutually exclusive - only one can be providedtokenProvider
(setsdangerouslyAllowBrowser: true
)Token Management:
_setToken()
method now returns a boolean indicating if a token was successfully retrievedprepareOptions()
Usage Example
Backward Compatibility
This change is fully backward compatible. Existing code using
apiKey
continues to work unchanged. The newtokenProvider
option is purely additive.