Sign in
tool-settings

Update Tool Settings

Changed on

Persist and apply tool/guardrail setting changes.

Uses model_fields_set so an explicit null clears a field while an omitted field is left unchanged. Operator-gated and standalone-only.

patch/api/v1/tool-settings

Request

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

Request body

code_execution_executorstring nullable
guardrails_urlstring nullable
sandbox_purpose_hintstring nullable
sandbox_session_imagestring nullable
sandbox_urlstring nullable
web_fetch_default_toolstring nullable

A fetch instance, or 'builtin_fetch'.

web_search_default_toolstring nullable

A search instance whose provider any-search serves, or 'none' to turn in-loop search off.

web_search_enginesstring nullable
web_search_extractboolean nullable
web_search_interceptboolean nullable
web_search_max_callsinteger nullable
web_search_max_resultsinteger nullable
web_search_purpose_hintstring nullable
web_search_urlstring nullable

Example request

{
  "web_search_max_results": 5,
  "web_search_url": "http://searxng:8080"
}

Response

Successful Response

sandbox_provider'protocol' | 'e2b'

What runs the code a code-execution tool call asks for, chosen per deployment.

Values are read without regard to case or surrounding whitespace.

Changes

  • fbee488d4d9fRevision changes
    • info

      added the optional property to the response with the status

  • ca83274e878aRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property