Sign in
workspace-web-search

Set Workspace Web Search Config

Set a workspace's web-search configuration, replacing any existing one.

An organization owner/admin, or an owner/admin of this workspace, may write it. The configuration can only narrow what the deployment permits: turning web search off for the workspace, lowering the result ceiling, and adding to the domains a search may not reach. It never turns on a backend the deployment has not configured, and it carries no credential.

put/v1/workspaces/{workspace_id}/web-search

Path parameters

workspace_idstring uuid required

Request body

allowed_domainsstring[] nullable

Results are kept only from these domains; intersected with any list the request sends

blocked_domainsstring[] nullable

Results from these domains are dropped; added to any list the request sends

enabledboolean required

False refuses web search for this workspace, both the otari_web_search tool and POST /v1/search. The fields below narrow the tool only.

max_resultsinteger nullable

Ceiling on results one search returns; only ever lowers the effective limit, so at most 20

provider_optionsobject nullable

Provider-specific knobs forwarded to the search backend; a request's own keys win

purpose_hintstring nullable

Hint used when a request declares otari_web_search without one of its own

Response

Successful Response

allowed_domainsstring[] nullable required
blocked_domainsstring[] nullable required
configuredboolean required
created_atstring nullable required
enabledboolean required
max_resultsinteger nullable required
provider_optionsobject nullable required
purpose_hintstring nullable required
updated_atstring nullable required
web_search_configuredboolean required
workspace_idstring uuid required

Changes

Changed in 1 of the 126 revisions of this API.1