APIClaw Settings API

openapi: 3.2.0
info:
  title: LiteLLM Settings API
  description: 'Proxy Server to call 100+ LLMs in the OpenAI format. **Customize Swagger Docs**


    👉 ```LiteLLM Admin Panel on /ui```. Create, Edit Keys with SSO. Having issues? Try ```Fallback Login```


    💸 ```LiteLLM Model Cost Map```.


    🔎 ```LiteLLM Model Hub```. See available models on the proxy. **Docs**'
  version: 1.105.1
tags:
- name: Settings
paths:
  /get/mcp_semantic_filter_settings:
    get:
      tags:
      - Settings
      summary: Get Mcp Semantic Filter Settings
      description: 'Get MCP semantic filter configuration.

        Returns current settings for semantic tool filtering.'
      operationId: get_mcp_semantic_filter_settings_get_mcp_semantic_filter_settings_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MCPSemanticFilterSettingsResponse'
      security:
      - APIKeyHeader: []
  /update/mcp_semantic_filter_settings:
    patch:
      tags:
      - Settings
      summary: Update Mcp Semantic Filter Settings
      description: 'Update MCP semantic filter settings in database.

        Settings will be picked up by all pods within approximately 10 seconds via background polling.'
      operationId: update_mcp_semantic_filter_settings_update_mcp_semantic_filter_settings_patch
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MCPSemanticFilterSettings'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
  /get/websearch_interception_settings:
    get:
      tags:
      - Settings
      summary: Get Websearch Interception Settings
      description: 'Get web search interception configuration.


        Returns the current settings plus their schema, for the Admin UI to render.'
      operationId: get_websearch_interception_settings_get_websearch_interception_settings_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebSearchInterceptionSettingsResponse'
      security:
      - APIKeyHeader: []
  /update/websearch_interception_settings:
    patch:
      tags:
      - Settings
      summary: Update Websearch Interception Settings
      description: 'Update web search interception settings in database.


        Settings will be picked up by all pods within approximately 10 seconds via background polling.'
      operationId: update_websearch_interception_settings_update_websearch_interception_settings_patch
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebSearchInterceptionSettings'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
  /get/mcp_tool_search_settings:
    get:
      tags:
      - Settings
      summary: Get Mcp Tool Search Settings
      description: Get the `litellm_settings.mcp_tool_search` configuration used by the native `mcp_tool_search` virtual tool.
      operationId: get_mcp_tool_search_settings_get_mcp_tool_search_settings_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MCPToolSearchSettingsResponse'
      security:
      - APIKeyHeader: []
  /update/mcp_tool_search_settings:
    patch:
      tags:
      - Settings
      summary: Update Mcp Tool Search Settings
      description: 'Update `litellm_settings.mcp_tool_search` in the database.

        Settings will be picked up by all pods within approximately 10 seconds via background polling.'
      operationId: update_mcp_tool_search_settings_update_mcp_tool_search_settings_patch
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MCPToolSearchSettings'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Update Mcp Tool Search Settings Update Mcp Tool Search Settings Patch
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - APIKeyHeader: []
components:
  schemas:
    WebSearchInterceptionSettingsResponse:
      properties:
        values:
          additionalProperties: true
          type: object
          title: Values
        field_schema:
          additionalProperties: true
          type: object
          title: Field Schema
        active_on_this_pod:
          type: boolean
          title: Active On This Pod
          description: 'Whether the process answering this request has the interception callback registered. Read-only: it reports what is running here, while values.enabled is the cluster-wide setting, and the two disagree while a pod is still applying a change or failed to apply it.'
          default: false
      type: object
      required:
      - values
      - field_schema
      title: WebSearchInterceptionSettingsResponse
      description: Response model for web search interception settings
    MCPSemanticFilterSettings:
      properties:
        enabled:
          type: boolean
          title: Enabled
          description: Enable semantic filtering of MCP tools based on query relevance
          default: false
        embedding_model:
          type: string
          title: Embedding Model
          description: Embedding model to use for semantic similarity (e.g., 'text-embedding-3-small', 'text-embedding-ada-002')
          default: text-embedding-3-small
        top_k:
          type: integer
          maximum: 100.0
          minimum: 1.0
          title: Top K
          description: Number of most relevant tools to return
          default: 10
        similarity_threshold:
          type: number
          maximum: 1.0
          minimum: 0.0
          title: Similarity Threshold
          description: Minimum similarity score for tool inclusion (0.0 to 1.0, where 1.0 = exact match)
          default: 0.3
      type: object
      title: MCPSemanticFilterSettings
      description: Configuration for MCP Semantic Tool Filter
    MCPToolSearchSettings:
      properties:
        embedding_model:
          anyOf:
          - type: string
          - type: 'null'
          title: Embedding Model
          description: Embedding model from model_list used to rank tools by meaning. Unset keeps keyword matching.
        top_k:
          type: integer
          maximum: 100.0
          minimum: 1.0
          title: Top K
          description: Most ranked tools a search returns. A smaller top_k in the tool call wins. Core tools do not count.
          default: 5
        similarity_threshold:
          type: number
          maximum: 1.0
          minimum: 0.0
          title: Similarity Threshold
          description: Lowest cosine similarity a tool needs to appear in semantic results (0.0 = no cutoff).
          default: 0.0
        core_tools:
          items:
            type: string
          type: array
          title: Core Tools
          description: Tool names always returned first when the caller can access them, e.g. `my_server-get_rates`.
          default: []
      type: object
      title: MCPToolSearchSettings
      description: '`litellm_settings.mcp_tool_search`: how the native `mcp_tool_search` virtual tool ranks the caller''s tools.'
    WebSearchInterceptionSettings:
      properties:
        enabled:
          type: boolean
          title: Enabled
          description: Serve web search tool calls from a configured search tool instead of passing them upstream
          default: false
        enabled_providers:
          items:
            type: string
          type: array
          title: Enabled Providers
          description: LLM providers to intercept for (e.g. 'bedrock', 'vertex_ai'). Empty intercepts Bedrock only.
        search_tool_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Search Tool Name
          description: Name of the configured search tool to run searches through. Empty uses the first one available.
        max_agentic_loops:
          anyOf:
          - type: integer
            minimum: 1.0
          - type: 'null'
          title: Max Agentic Loops
          description: How many follow-up model calls one intercepted request may chain. Empty applies the default of 3.
      type: object
      title: WebSearchInterceptionSettings
      description: Configuration for server-side web search interception
    MCPSemanticFilterSettingsResponse:
      properties:
        values:
          additionalProperties: true
          type: object
          title: Values
        field_schema:
          additionalProperties: true
          type: object
          title: Field Schema
      type: object
      required:
      - values
      - field_schema
      title: MCPSemanticFilterSettingsResponse
      description: Response model for MCP semantic filter settings
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    MCPToolSearchSettingsResponse:
      properties:
        values:
          additionalProperties: true
          type: object
          title: Values
        field_schema:
          additionalProperties: true
          type: object
          title: Field Schema
      type: object
      required:
      - values
      - field_schema
      title: MCPToolSearchSettingsResponse
      description: Response model for native MCP tool search settings
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      description: Bearer token
      in: header
      name: x-litellm-api-key
    HTTPBearer:
      type: http
      scheme: bearer
x-provenance:
  method: harvested
  publisher: APIClaw
  source: https://apiclaw.biz/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)