Update a tool

Server: 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] Route required privileges: agentBuilder:manageTools.

Path Parameters

toolId string required: The unique identifier of the tool to update.

Request

Response

200

Indicates a successful response

application/json

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"
       }
     }
   }
 }'

Example request to update the custom ESQL tool

Request Console 1 / 2 languages

Console Kibana Dev Tools

PUT kbn:/api/agent_builder/tools/{toolId}
{
  "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"
  ]
}

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 '{
  "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"
  ]
}'

Response

{
  "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"
}

Example request to update the custom Search tool

Request Console 1 / 2 languages

Console Kibana Dev Tools

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

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 search tool for comprehensive financial data analysis, reporting, and compliance monitoring",
  "tags": [
    "search",
    "finance",
    "compliance",
    "reporting"
  ]
}'

Response

{
  "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"
}

Path Parameters

Request { configuration , confirmation , description , tags , }

Response

Request