feat(provider/xai): expose enableImageSearch on the Web Search tool#15662
Merged
dancer merged 1 commit intoMay 29, 2026
Merged
Conversation
xAI's Responses API supports an `enable_image_search` flag on the `web_search` tool that lets Grok run image search as a separate search mode and embed the results back into the response as Markdown image embeds. This flag is distinct from `enable_image_understanding`, which is already supported. - Add optional `enableImageSearch` boolean to `xai.tools.webSearch()`. When set, the SDK forwards it to `/v1/responses` as `enable_image_search` on the `web_search` tool. - Document the new parameter on the xAI provider page. - Add an `examples/ai-functions` entry demonstrating the option. - Fix the `should send web_search tool with args in request` test, which was asserting against the args-less `beforeEach` request (index 0) and silently passing. Now points at the correct call; no production behavior change.
dancer
approved these changes
May 29, 2026
dancer
added
the
backport
dancer
added
backport
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
2 participants
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.
Background
xAI's Responses API supports an
enable_image_searchflag on theweb_searchtool that lets Grok run image search as a separate search mode and embed the results back into the response as Markdown image embeds ().This flag is distinct from
enable_image_understanding, which is already supported by the AI SDK.E.g., see more at https://docs.x.ai/developers/tools/web-search
Summary
enableImageSearchboolean toxai.tools.webSearch(). When set, the SDK forwards it to/v1/responsesasenable_image_searchon theweb_searchtool, enabling image search mode.examples/ai-functionsentry demoing this option.should send web_search tool with args in requesttest, which was asserting against the args-lessbeforeEachrequest (index 0) and silently passing. Now points at the correct call; no production behavior change.Manual Verification
Verified by running
examples/ai-functions/src/generate-text/xai/responses-web-search-image-search.tsagainstapi.x.ai/v1/responses, which has promptShow me images of SpaceX Starship on the launch pad.).We observe --
) inresult.text; the expected "embeds" generated by the model from the image search results.result.sourcesare image URLs (jpg / webp / CDN)web_searchserver-side tool calls; finish reasonstop.Output excerpt:
Checklist
pnpm changesetin the project root)Related Issues
N/A