Skip to main content

Interface: TavilySearchOptions

Defined in: packages/tools/src/web/web-search.ts:60

Properties​

apiKey?​

optional apiKey?: Secret

Defined in: packages/tools/src/web/web-search.ts:62

The key, or a function that reads it at call time (env, vault, per-tenant store). Default process.env.TAVILY_API_KEY.


excludeDomains?​

optional excludeDomains?: string[]

Defined in: packages/tools/src/web/web-search.ts:71


fetch?​

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/tools/src/web/web-search.ts:78

Call Signature​

(input, init?): Promise<Response>

MDN Reference

Parameters​
input​

URL | RequestInfo

init?​

RequestInit

Returns​

Promise<Response>

Call Signature​

(input, init?): Promise<Response>

MDN Reference

Parameters​
input​

string | URL | Request

init?​

RequestInit

Returns​

Promise<Response>


includeAnswer?​

optional includeAnswer?: boolean

Defined in: packages/tools/src/web/web-search.ts:68

Ask Tavily for a short written answer. Default false.


includeDomains?​

optional includeDomains?: string[]

Defined in: packages/tools/src/web/web-search.ts:70

Restrict or exclude domains.


includeImages?​

optional includeImages?: boolean

Defined in: packages/tools/src/web/web-search.ts:66

Ask Tavily for image results with captions. Default false.


modelParameters?​

optional modelParameters?: object

Defined in: packages/tools/src/web/web-search.ts:77

Let the model choose, per search: site (search within one domain) and thorough (a deeper, costlier search). Off by default, so the tool's schema stays small unless you want these.

site?​

optional site?: boolean

thorough?​

optional thorough?: boolean


searchDepth?​

optional searchDepth?: "basic" | "advanced"

Defined in: packages/tools/src/web/web-search.ts:64

basic (default) or advanced (deeper, costs more).