PreviewWebSearchServerTool Type | OpenRouter TypeScript SDK

The TypeScript SDK and docs are currently in beta. Report issues on GitHub.

Web search preview tool configuration

Example Usage

import { PreviewWebSearchServerTool } from "@openrouter/sdk/models";

let value: PreviewWebSearchServerTool = {
  type: "web_search_preview",
};

Field	Type	Required	Description	Example
`engine`	models.WebSearchEngineEnum	:heavy_minus_sign:	Which search engine to use. “auto” (default) uses native if the provider supports it, otherwise Exa. “native” forces the provider’s built-in search. “exa” forces the Exa search API. “firecrawl” uses Firecrawl (requires BYOK). “parallel” uses the Parallel search API.	auto
`filters`	models.WebSearchDomainFilter	:heavy_minus_sign:	N/A	`{"allowed_domains": ["example.com"],"excluded_domains": ["spam.com"]}`
`maxResults`	number	:heavy_minus_sign:	Maximum number of search results to return per search call. Defaults to 5. Applies to Exa, Firecrawl, and Parallel engines; ignored with native provider search.	5
`searchContextSize`	models.SearchContextSizeEnum	:heavy_minus_sign:	Size of the search context for web search tools	medium
`type`	”web_search_preview”	:heavy_check_mark:	N/A
`userLocation`	models.PreviewWebSearchUserLocation	:heavy_minus_sign:	N/A	`{"city": "San Francisco","country": "USA","region": "California","timezone": "America/Los_Angeles","type": "approximate"}`

⌘I