Allow OpenAI apiKey to accept function for dynamic key loading #320
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.
Description
The OpenAI SDK supports dynamic API key resolution through async functions, enabling use cases like credential rotation, secret manager integration, and per-request authentication. However, our SDK currently only accepts static strings for the
apiKeyparameter, preventing users from leveraging these capabilities.Public API Changes
The
OpenAIModelOptions.apiKeyparameter now accepts either a string or an async function:The change is backward compatible—all existing string-based usage continues to work without modification. The function receives no arguments and must return a
Promise<string>. The OpenAI SDK invokes the function before each request and validates the returned value.Related Issues
None; noticed this when refactoring integration tests
Agent developed via zastrowm#5 and zastrowm#4
Documentation PR
N/A
Type of Change
Bug fix/New feature
Testing
How have you tested the change?
npm run checkChecklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.