WebSearchTool interface

Search the Internet for sources related to the prompt. Learn more about the web search tool.

Properties

custom_search_configuration	The project connections attached to this tool. There can be a maximum of 1 connection resource attached to the tool.
description	Optional user-defined description for this tool or configuration.
filters	Filters to apply to web search results.
name	Optional user-defined name for this tool or configuration.
search_context_size	High level guidance for the amount of context window space to use for the search. One of `low`, `medium`, or `high`. `medium` is the default.
type	The type of the web search tool. One of `web_search` or `web_search_2025_08_26`.
user_location	The approximate location of the user for search relevance.

The project connections attached to this tool. There can be a maximum of 1 connection resource attached to the tool.

custom_search_configuration?: WebSearchConfiguration

Optional user-defined description for this tool or configuration.

description?: string

string

Filters to apply to web search results.

filters?: WebSearchToolFilters

Optional user-defined name for this tool or configuration.

name?: string

string

High level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.

search_context_size?: "low" | "medium" | "high"

"low" | "medium" | "high"

The type of the web search tool. One of web_search or web_search_2025_08_26.

type: "web_search"

"web_search"

The approximate location of the user for search relevance.

user_location?: WebSearchApproximateLocation