Web Search

View as Markdown

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
querystringRequired1-2000 characters
The search query.
modelstring or nullOptional
Native engine model id. Defaults to the server's configured model.
providerenum or nullOptional

Pin a specific engine. Omit to use native-first with Tavily fallback.

max_resultsintegerOptional1-20Defaults to 5
Maximum results to return.
search_depthenumOptionalDefaults to basic

Tavily search depth; ignored by the native engine.

include_domainslist of strings or nullOptional
Restrict results to these domains.
exclude_domainslist of strings or nullOptional
Drop results from these domains.
include_answerbooleanOptionalDefaults to false
Ask the engine for a synthesized answer alongside results.

Response

Successful Response
querystring
providerenum
answerstring or null
resultslist of objects
request_idstringDefaults to

Errors

422
Unprocessable Entity Error