Skip to content

fix: add external_web_access option to WebSearchTool type#1768

Open
fuleinist wants to merge 1 commit intoopenai:masterfrom
fuleinist:fix/issue-1716
Open

fix: add external_web_access option to WebSearchTool type#1768
fuleinist wants to merge 1 commit intoopenai:masterfrom
fuleinist:fix/issue-1716

Conversation

@fuleinist
Copy link

Summary

Adds the missing external_web_access option to the WebSearchTool interface.

Changes

  • Added external_web_access?: boolean | null property to the WebSearchTool interface
  • Added JSDoc documentation for the new property

Testing

  • TypeScript compilation passes (errors are only from missing example dependencies)
  • The new property matches the API behavior described in the issue

Fixes #1716

Fixes openai#1716

The WebSearchTool type was missing the external_web_access option
which is a valid API parameter for the web_search tool. When set to
false, it prevents the model from accessing external web sources.
@fuleinist fuleinist requested a review from a team as a code owner March 13, 2026 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Types do not acknowledge web search's external_web_access option

1 participant