---
title: "WebSearchPlugin"
---

## Fields

| Field                                                                                                                                          | Type                                                                                                                                           | Required                                                                                                                                       | Description                                                                                                                                    | Example                                                                                                                                        |
| ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `enabled`                                                                                                                                      | *Optional[bool]*                                                                                                                               | :heavy_minus_sign:                                                                                                                             | Set to false to disable the web-search plugin for this request. Defaults to true.                                                              |                                                                                                                                                |
| `engine`                                                                                                                                       | [Optional[components.WebSearchEngine]](../components/websearchengine.mdx)                                                                       | :heavy_minus_sign:                                                                                                                             | The search engine to use for web search.                                                                                                       | exa                                                                                                                                            |
| `exclude_domains`                                                                                                                              | List[*str*]                                                                                                                                    | :heavy_minus_sign:                                                                                                                             | A list of domains to exclude from web search results. Supports wildcards (e.g. "*.substack.com") and path filtering (e.g. "openai.com/blog").  | [<br/>"example.com",<br/>"*.substack.com",<br/>"openai.com/blog"<br/>]                                                                         |
| `id`                                                                                                                                           | [components.WebSearchPluginID](../components/websearchpluginid.mdx)                                                                             | :heavy_check_mark:                                                                                                                             | N/A                                                                                                                                            |                                                                                                                                                |
| `include_domains`                                                                                                                              | List[*str*]                                                                                                                                    | :heavy_minus_sign:                                                                                                                             | A list of domains to restrict web search results to. Supports wildcards (e.g. "*.substack.com") and path filtering (e.g. "openai.com/blog").   | [<br/>"example.com",<br/>"*.substack.com",<br/>"openai.com/blog"<br/>]                                                                         |
| `max_results`                                                                                                                                  | *Optional[int]*                                                                                                                                | :heavy_minus_sign:                                                                                                                             | N/A                                                                                                                                            |                                                                                                                                                |
| `max_uses`                                                                                                                                     | *Optional[int]*                                                                                                                                | :heavy_minus_sign:                                                                                                                             | 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]*                                                                                                                                | :heavy_minus_sign:                                                                                                                             | N/A                                                                                                                                            |                                                                                                                                                |
| `user_location`                                                                                                                                | [OptionalNullable[components.UserLocation]](../components/userlocation.mdx)                                                                     | :heavy_minus_sign:                                                                                                                             | N/A                                                                                                                                            | \{<br/>"city": "San Francisco",<br/>"country": "US",<br/>"region": "California",<br/>"timezone": "America/Los_Angeles",<br/>"type": "approximate"<br/>} |