workspace-web-search

Get Workspace Web Search Config

Changed on

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.

get/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

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