WebSearchPlugin | OpenRouter Python SDK | OpenRouter

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

Fields

Field	Type	Required	Description	Example
`enabled`	Optional[bool]	➖	Set to false to disable the web-search plugin for this request. Defaults to true.
`engine`	Optional[components.WebSearchEngine]	➖	The search engine to use for web search.	exa
`exclude_domains`	List[str]	➖	A list of domains to exclude from web search results. Supports wildcards (e.g. “*.substack.com”) and path filtering (e.g. “openai.com/blog”).	[ “example.com”, “*.substack.com”, “openai.com/blog” ]
`id`	components.WebSearchPluginID	✔️	N/A
`include_domains`	List[str]	➖	A list of domains to restrict web search results to. Supports wildcards (e.g. “*.substack.com”) and path filtering (e.g. “openai.com/blog”).	[ “example.com”, “*.substack.com”, “openai.com/blog” ]
`max_results`	Optional[int]	➖	N/A
`max_uses`	Optional[int]	➖	Maximum number of times the model can invoke web search in a single turn. Passed through to native providers that support it (e.g. Anthropic).
`search_prompt`	Optional[str]	➖	N/A
`user_location`	OptionalNullable[components.UserLocation]	➖	N/A	`{"city": "San Francisco","country": "USA","region": "California","timezone": "America/Los_Angeles","type": "approximate"}`