For the complete documentation index, see llms.txt. This page is also available as Markdown.

Workspace web search

get

Read a workspace's web-access configuration.

Takes the same role as setting it (an organization owner/admin, or an owner/admin of this workspace), because the row describes the workspace's posture rather than one member's allowance. A workspace with no row answers with the unconfigured shape (configured: false), which is the deployment's own behavior described in the same shape rather than a 404.

Authorizations
Otari-KeystringRequired

Enter your API key here (sent as Otari-Key header).

Path parameters
workspace_idstring · uuidRequired
Responses
200

Successful Response

application/json

A workspace's web-search configuration, or the unconfigured one it has without a row.

allowed_domainsstring[] · nullableRequired
blocked_domainsstring[] · nullableRequired
configuredbooleanRequired
created_atstring · nullableRequired
default_enabledbooleanRequired
enabledbooleanRequired
fetch_executorstring · enum · nullableRequired

Who runs the code a request's code-execution tool asks for.

Values are read without regard to case or surrounding whitespace.

Possible values:
max_resultsinteger · nullableRequired
purpose_hintstring · nullableRequired
search_executorstring · enum · nullableRequired

Who runs the code a request's code-execution tool asks for.

Values are read without regard to case or surrounding whitespace.

Possible values:
updated_atstring · nullableRequired
web_search_configuredbooleanRequired
workspace_idstring · uuidRequired
get/api/v1/workspaces/{workspace_id}/web-search
GET /api/v1/workspaces/{workspace_id}/web-search HTTP/1.1
Otari-Key: YOUR_API_KEY
Accept: */*
{
  "allowed_domains": [
    "text"
  ],
  "blocked_domains": [
    "text"
  ],
  "configured": true,
  "created_at": "text",
  "default_enabled": true,
  "enabled": true,
  "fetch_executor": "auto",
  "max_results": 1,
  "provider_options": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "purpose_hint": "text",
  "search_executor": "auto",
  "updated_at": "text",
  "web_search_configured": true,
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000"
}
put

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.

Authorizations
Otari-KeystringRequired

Enter your API key here (sent as Otari-Key header).

Path parameters
workspace_idstring · uuidRequired
Body

The configuration to store for a workspace, as a whole.

PUT semantics, ported from the hosted WorkspaceWebSearchConfigUpdate: what is sent is what the workspace has afterwards, so an omitted field is cleared rather than left as it was.

allowed_domainsstring[] · nullableOptional

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

blocked_domainsstring[] · nullableOptional

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

enabledbooleanRequired

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

fetch_executorstring · enum · nullableOptional

Who runs a provider-native web-fetch declaration (Anthropic's web_fetch_) for this workspace, in search_executor's vocabulary. Pins over the request's Otari-Web-Fetch header; null leaves the header in charge

Possible values:
max_resultsinteger · max: 2147483647 · nullableOptional

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.

purpose_hintstring · max: 2048 · nullableOptional

Search only: hint used when a request declares otari_web_search without one of its own

search_executorstring · enum · nullableOptional

Who runs a provider-native web-search declaration (Anthropic's web_search_, OpenAI's web_search) for this workspace: 'auto' (the provider when it runs the tool natively for the model, else this gateway's search), 'otari' or 'provider'. Pins over the request's Otari-Web-Search header; null leaves the header in charge. The deployment's web_search_intercept still claims every search

Possible values:
Responses
200

Successful Response

application/json

A workspace's web-search configuration, or the unconfigured one it has without a row.

allowed_domainsstring[] · nullableRequired
blocked_domainsstring[] · nullableRequired
configuredbooleanRequired
created_atstring · nullableRequired
default_enabledbooleanRequired
enabledbooleanRequired
fetch_executorstring · enum · nullableRequired

Who runs the code a request's code-execution tool asks for.

Values are read without regard to case or surrounding whitespace.

Possible values:
max_resultsinteger · nullableRequired
purpose_hintstring · nullableRequired
search_executorstring · enum · nullableRequired

Who runs the code a request's code-execution tool asks for.

Values are read without regard to case or surrounding whitespace.

Possible values:
updated_atstring · nullableRequired
web_search_configuredbooleanRequired
workspace_idstring · uuidRequired
put/api/v1/workspaces/{workspace_id}/web-search
PUT /api/v1/workspaces/{workspace_id}/web-search HTTP/1.1
Otari-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 215

{
  "allowed_domains": [
    "text"
  ],
  "blocked_domains": [
    "text"
  ],
  "enabled": true,
  "fetch_executor": "auto",
  "max_results": 1,
  "provider_options": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "purpose_hint": "text",
  "search_executor": "auto"
}
{
  "allowed_domains": [
    "text"
  ],
  "blocked_domains": [
    "text"
  ],
  "configured": true,
  "created_at": "text",
  "default_enabled": true,
  "enabled": true,
  "fetch_executor": "auto",
  "max_results": 1,
  "provider_options": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "purpose_hint": "text",
  "search_executor": "auto",
  "updated_at": "text",
  "web_search_configured": true,
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000"
}
delete

Drop a workspace's configuration, returning it to the deployment's behavior.

Idempotent: a workspace that has no configuration is already in the state this asks for, so it answers with the unconfigured shape rather than a 404.

Authorizations
Otari-KeystringRequired

Enter your API key here (sent as Otari-Key header).

Path parameters
workspace_idstring · uuidRequired
Responses
200

Successful Response

application/json

A workspace's web-search configuration, or the unconfigured one it has without a row.

allowed_domainsstring[] · nullableRequired
blocked_domainsstring[] · nullableRequired
configuredbooleanRequired
created_atstring · nullableRequired
default_enabledbooleanRequired
enabledbooleanRequired
fetch_executorstring · enum · nullableRequired

Who runs the code a request's code-execution tool asks for.

Values are read without regard to case or surrounding whitespace.

Possible values:
max_resultsinteger · nullableRequired
purpose_hintstring · nullableRequired
search_executorstring · enum · nullableRequired

Who runs the code a request's code-execution tool asks for.

Values are read without regard to case or surrounding whitespace.

Possible values:
updated_atstring · nullableRequired
web_search_configuredbooleanRequired
workspace_idstring · uuidRequired
delete/api/v1/workspaces/{workspace_id}/web-search
DELETE /api/v1/workspaces/{workspace_id}/web-search HTTP/1.1
Otari-Key: YOUR_API_KEY
Accept: */*
{
  "allowed_domains": [
    "text"
  ],
  "blocked_domains": [
    "text"
  ],
  "configured": true,
  "created_at": "text",
  "default_enabled": true,
  "enabled": true,
  "fetch_executor": "auto",
  "max_results": 1,
  "provider_options": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "purpose_hint": "text",
  "search_executor": "auto",
  "updated_at": "text",
  "web_search_configured": true,
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000"
}

Last updated

Was this helpful?