workspace-web-search

Set Workspace Web Search Config

Changed on

Set a workspace's web-access 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 access off for the workspace, lowering the Search result ceiling, and constraining domains for Search and Fetch. It never turns on a backend the deployment has not configured, and it carries no credential.

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

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Otari-Key
    • API key in header x-api-key

Path parameters

workspace_idstring uuid required

Request body

allowed_domainsstring[] nullable

Filters Search results and constrains initial and redirected Fetch destinations; intersected with any list the request sends

blocked_domainsstring[] nullable

Filters Search results and blocks initial and redirected Fetch destinations; added to any list the request sends

enabledboolean required

False refuses web access for this workspace through otari_web_search, otari_web_fetch, and POST /api/v1/search.

max_resultsinteger nullable

Search only: ceiling on results one search returns, through otari_web_search and POST /api/v1/search; it only ever lowers the count a request asks for. Unset, the provider's own maximum is the only limit.

provider_optionsobject nullable

Search only: provider-specific knobs forwarded to the backend; request keys win

purpose_hintstring nullable

Search only: 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
default_enabledboolean 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