Update a tool

Base URL: https://{kibana_url}

PUT /api/agent_builder/tools/{toolId}
PUT /s/{space_id}/api/agent_builder/tools/{toolId}

Refer to Spaces for more information.

Update an existing tool. Use this endpoint to modify any aspect of the tool's configuration or metadata. To learn more about Agent Builder tools, refer to the tools documentation.

Required authorization

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Path parameters

Header parameters

Request body

Response

200

Indicates a successful response

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

PUT kbn:/api/agent_builder/tools/{toolId}
{
  "description": "Updated ES|QL query tool for analyzing financial trades with time filtering",
  "tags": ["analytics", "finance", "updated"],
  "configuration": {
    "query": "FROM financial_trades | WHERE execution_timestamp >= ?startTime | STATS trade_count=COUNT(*), avg_price=AVG(execution_price) BY symbol | SORT trade_count DESC | LIMIT ?limit",
    "params": {
      "startTime": {
        "type": "date",
        "description": "Start time for the analysis in ISO format"
      },
      "limit": {
        "type": "integer",
        "description": "Maximum number of results to return"
      }
    }
  }
}

curl Shell

curl \
 -X PUT "https://${KIBANA_URL}/api/agent_builder/tools/{toolId}" \
 -H "Authorization: ApiKey ${API_KEY}" \
 -H "kbn-xsrf: true" \
 -H "Content-Type: application/json" \
 -d '{
   "description": "Updated ES|QL query tool for analyzing financial trades with time filtering",
   "tags": ["analytics", "finance", "updated"],
   "configuration": {
     "query": "FROM financial_trades | WHERE execution_timestamp >= ?startTime | STATS trade_count=COUNT(*), avg_price=AVG(execution_price) BY symbol | SORT trade_count DESC | LIMIT ?limit",
     "params": {
       "startTime": {
         "type": "date",
         "description": "Start time for the analysis in ISO format"
       },
       "limit": {
         "type": "integer",
         "description": "Maximum number of results to return"
       }
     }
   }
 }'

Request Console 1 / 2 languages

Example request to update the custom ESQL tool

Console Kibana Dev Tools

PUT kbn:/api/agent_builder/tools/TOOL_ID
{
  "configuration": {
    "params": {
      "limit": {
        "description": "Maximum number of results to return",
        "type": "integer"
      },
      "startTime": {
        "description": "Start time for the analysis in ISO format",
        "type": "date"
      },
      "symbolPattern": {
        "description": "Pattern to filter symbols (e.g., \u0027US_*\u0027 for US instruments)",
        "type": "keyword"
      }
    },
    "query": "FROM financial_trades | WHERE execution_timestamp \u003E= ?startTime AND symbol LIKE ?symbolPattern | STATS trade_count=COUNT(*), avg_price=AVG(execution_price), total_volume=SUM(quantity) BY symbol | SORT trade_count DESC | LIMIT ?limit"
  },
  "description": "Updated ES|QL query tool for comprehensive financial analysis with enhanced filtering",
  "tags": [
    "analytics",
    "finance",
    "reporting"
  ]
}

Generated from the API spec

curl Shell

curl \
 -X PUT "https://${KIBANA_URL}/api/agent_builder/tools/${TOOL_ID}" \
 -H "Authorization: ApiKey ${API_KEY}" \
 -H "kbn-xsrf: true" \
 -H "Content-Type: application/json" \
 -d '{
    "configuration": {
      "params": {
        "limit": {
          "description": "Maximum number of results to return",
          "type": "integer"
        },
        "startTime": {
          "description": "Start time for the analysis in ISO format",
          "type": "date"
        },
        "symbolPattern": {
          "description": "Pattern to filter symbols (e.g., \u0027US_*\u0027 for US instruments)",
          "type": "keyword"
        }
      },
      "query": "FROM financial_trades | WHERE execution_timestamp \u003E= ?startTime AND symbol LIKE ?symbolPattern | STATS trade_count=COUNT(*), avg_price=AVG(execution_price), total_volume=SUM(quantity) BY symbol | SORT trade_count DESC | LIMIT ?limit"
    },
    "description": "Updated ES|QL query tool for comprehensive financial analysis with enhanced filtering",
    "tags": [
      "analytics",
      "finance",
      "reporting"
    ]
  }'

Generated from the API spec

Response

Example response showing the updated ESQL tool

{
  "configuration": {
    "params": {
      "limit": {
        "description": "Maximum number of results to return",
        "type": "integer"
      },
      "startTime": {
        "description": "Start time for the analysis in ISO format",
        "type": "date"
      },
      "symbolPattern": {
        "description": "Pattern to filter symbols (e.g., \u0027US_*\u0027 for US instruments)",
        "type": "keyword"
      }
    },
    "query": "FROM financial_trades | WHERE execution_timestamp \u003E= ?startTime AND symbol LIKE ?symbolPattern | STATS trade_count=COUNT(*), avg_price=AVG(execution_price), total_volume=SUM(quantity) BY symbol | SORT trade_count DESC | LIMIT ?limit"
  },
  "description": "Updated ES|QL query tool for comprehensive financial analysis with enhanced filtering",
  "id": "example-esql-tool",
  "readonly": false,
  "schema": {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "additionalProperties": false,
    "description": "Parameters needed to execute the enhanced query",
    "type": "object",
    "properties": {
      "limit": {
        "description": "Maximum number of results to return",
        "type": "integer"
      },
      "startTime": {
        "description": "Start time for the analysis in ISO format",
        "format": "date-time",
        "type": "string"
      },
      "symbolPattern": {
        "description": "Pattern to filter symbols (e.g., \u0027US_*\u0027 for US instruments)",
        "type": "string"
      }
    },
    "required": [
      "startTime",
      "symbolPattern",
      "limit"
    ]
  },
  "tags": [
    "analytics",
    "finance",
    "reporting"
  ],
  "type": "esql"
}

Request Console 1 / 2 languages

Example request to update the custom Search tool

Console Kibana Dev Tools

PUT kbn:/api/agent_builder/tools/TOOL_ID
{
  "description": "Updated search tool for comprehensive financial data analysis, reporting, and compliance monitoring",
  "tags": [
    "search",
    "finance",
    "compliance",
    "reporting"
  ]
}

Generated from the API spec

curl Shell

curl \
 -X PUT "https://${KIBANA_URL}/api/agent_builder/tools/${TOOL_ID}" \
 -H "Authorization: ApiKey ${API_KEY}" \
 -H "kbn-xsrf: true" \
 -H "Content-Type: application/json" \
 -d '{
    "description": "Updated search tool for comprehensive financial data analysis, reporting, and compliance monitoring",
    "tags": [
      "search",
      "finance",
      "compliance",
      "reporting"
    ]
  }'

Generated from the API spec

Response

Example response showing the updated Search tool

{
  "configuration": {
    "pattern": "financial_*"
  },
  "description": "Updated search tool for comprehensive financial data analysis, reporting, and compliance monitoring",
  "id": "example-index-search-tool",
  "readonly": false,
  "schema": {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "additionalProperties": false,
    "type": "object",
    "properties": {
      "nlQuery": {
        "description": "A natural language query expressing the search request",
        "type": "string"
      }
    },
    "required": [
      "nlQuery"
    ]
  },
  "tags": [
    "search",
    "finance",
    "compliance",
    "reporting"
  ],
  "type": "index_search"
}

Required authorization

Authentication

Path parameters

Header parameters

Request body { }

Response

Request body