Sign in
latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-17107136452.1 KB

6133543facaf

search-tools

Create Search Tool

Add a search tool at runtime. Storing an API key requires OTARI_SECRET_KEY.

post/v1/search-tools

Request body

api_basestring nullable

Backend endpoint. Omit to inherit the provider's default (searxng inherits web_search_url).

api_keystring nullable

Provider API key. Stored encrypted; never returned.

namestring required

Name callers pass as 'search_tool_name' or in /v1/search/{tool}.

optionsobject nullable

Provider-native request fields used as defaults (e.g. exa's 'type', searxng's 'engines').

providerstring required

Search provider, one of: exa, searxng.

timeoutnumber nullable

Per-request timeout in seconds.

Example request

{
  "api_base": "http://searxng:8080",
  "name": "local",
  "provider": "searxng"
}

Response

Successful Response

api_basestring nullable
created_atstring nullable
decryptableboolean
last4string nullable
namestring required
optionsobject
providerstring required
shadows_configboolean

True when a config-file search tool of the same name exists; the stored one is in effect.

timeoutnumber nullable
updated_atstring nullable