Go SDKAPI ReferenceModels

Preview20250311WebSearchServerTool - Go SDK

Preview20250311WebSearchServerTool type definition

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

Web search preview tool configuration (2025-03-11 version)

Fields

FieldTypeRequiredDescriptionExample
Engine*components.WebSearchEngineEnum➖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
Filtersoptionalnullable.OptionalNullable[components.WebSearchDomainFilter]➖N/A{"allowed_domains": ["example.com"],"excluded_domains": ["spam.com"]}
MaxResults*int64➖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*components.SearchContextSizeEnum➖Size of the search context for web search toolsmedium
Typecomponents.Preview20250311WebSearchServerToolType✔️N/A
UserLocationoptionalnullable.OptionalNullable[components.PreviewWebSearchUserLocation]➖N/A{"city": "San Francisco","country": "USA","region": "California","timezone": "America/Los_Angeles","type": "approximate"}