web-search
Web Search
Changed onRun one search through this deployment's configured search provider.
The declared query params are the provider_options keys the providers understand. Everything else the caller sends, format and engines included, is ignored rather than forwarded: the bag is opaque to the gateway that filled it, so passing it upstream unread would let a workspace set provider request fields this deployment never chose.
get/api/v1/web-search/search
Request
- The document declares no server URL.
- Auth: API key in header X-Gateway-Token
Query parameters
qstring required
The search query.
max_resultsinteger nullable
search_depthstring nullable
topicstring nullable
time_rangestring nullable
include_answerboolean nullable
Headers
x-gateway-tokenstring nullable
Response
Successful Response
Changes
- info
added the optional property
to the response with the status
- info
- info
api operation id
web_search_api_v1_web_search_search_getremoved and replaced withweb-search-web_search
- info