Interface WebSearchOptions

Options for the OpenAI web search tool.

interface WebSearchOptions {
    filters?: WebSearchFilters;
    search_context_size?: "low" | "medium" | "high";
    userLocation?: WebSearchUserLocation;
}

Properties

Domain filtering configuration. Limit results to a specific set of up to 100 domains.

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

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.

userLocation?: WebSearchUserLocation

Approximate user location for geographic search refinement. Not supported for deep research models.