Search
Run a search against a configured search tool.
The tool is taken from search_tool_name, which may be omitted when the deployment's web_search_default_tool names one, or when exactly one tool is configured. Such a call runs on the workspace's organization search key when it has one.
Authentication modes:
Master key: the
userfield is required and may name any existing user.API key: usage and spend bind to the key's own user. A
userfield naming a different user is rejected with 403 (or ignored, when the key's ownreject_user_mismatchis false, or the deployment-wide setting is disabled and the key does not override it); it is never billed to that user.Service key: a
userfield names one of the key owner's end users, created on first use on the budgetOtari-End-User-Budgetnames (or the key's default), and is billed and rate limited as that end user, as on chat completions.
Enter your API key here (sent as Otari-Key header).
A direct search request: LiteLLM's /v1/search body, plus include_raw and provider_options.
Two-letter ISO country code to localize results to
Also return the provider's whole response, as raw.
falseMaximum number of results to return; 10 when unset. Lowered to the workspace's ceiling when it sets one, and to the provider's own maximum.
Approximate cap on the page content returned per result
The search query
Restrict results to these domains; prefix a domain with '-' to exclude it instead
Configured search tool to run against. Optional when the deployment names a default (web_search_default_tool) or has exactly one tool, and ignored on POST /api/v1/search/{search_tool_name}.
User ID for usage attribution
Successful Response
A completed direct search.
searchThe configured search tool that served the request
Validation Error
POST /api/v1/search HTTP/1.1
Otari-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 45
{
"max_results": 5,
"query": "otari llm gateway"
}{
"object": "search",
"raw": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"results": [
{
"date": "text",
"last_updated": "text",
"snippet": "text",
"title": "text",
"url": "text"
}
],
"search_tool": "text"
}Run a search against the search tool named in the path.
Identical to POST /api/v1/search except that the path names the tool, which is the form LiteLLM clients use. Any search_tool_name in the body is ignored.
Authentication modes:
Master key: the
userfield is required and may name any existing user.API key: usage and spend bind to the key's own user. A
userfield naming a different user is rejected with 403 (or ignored, when the key's ownreject_user_mismatchis false, or the deployment-wide setting is disabled and the key does not override it); it is never billed to that user.Service key: a
userfield names one of the key owner's end users, created on first use on the budgetOtari-End-User-Budgetnames (or the key's default), and is billed and rate limited as that end user, as on chat completions.
Enter your API key here (sent as Otari-Key header).
Configured search tool to run against
A direct search request: LiteLLM's /v1/search body, plus include_raw and provider_options.
Two-letter ISO country code to localize results to
Also return the provider's whole response, as raw.
falseMaximum number of results to return; 10 when unset. Lowered to the workspace's ceiling when it sets one, and to the provider's own maximum.
Approximate cap on the page content returned per result
The search query
Restrict results to these domains; prefix a domain with '-' to exclude it instead
Configured search tool to run against. Optional when the deployment names a default (web_search_default_tool) or has exactly one tool, and ignored on POST /api/v1/search/{search_tool_name}.
User ID for usage attribution
Successful Response
A completed direct search.
searchThe configured search tool that served the request
Validation Error
POST /api/v1/search/{search_tool_name} HTTP/1.1
Otari-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 45
{
"max_results": 5,
"query": "otari llm gateway"
}{
"object": "search",
"raw": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"results": [
{
"date": "text",
"last_updated": "text",
"snippet": "text",
"title": "text",
"url": "text"
}
],
"search_tool": "text"
}Last updated
Was this helpful?
