Edit Tool
PUT
/v2/api/tool/{tool_id}
Overview
tool_id). This is useful for keeping tool information up-to-date, modifying its status, or assigning it to different templates or behaviors.What is tool_id?
tool_id is a unique numeric value that identifies a specific tool within the system. It is passed as a path parameter and is required to locate the tool that needs to be updated. Only the tool matching this ID will be modified by the request.How to View Your Tool ID?
View Your Tool ID
Functionality
tool_id as a required path parameter to identify which tool to update.name: New name of the tooldescription: Updated description of what the tool doestool_type: Specifies the category of the tool (e.g., api, rag)is_enabled: Sets whether the tool is active and accessibleis_draft: Flags whether the tool is still in draft stateis_default: Indicates if the tool should be considered the default toolbase_template_id: Links the tool to a specific base templatesystem_prompt: Assigns or updates the system-level prompt associated with the toolRequest
Path Params
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT '/v2/api/tool/70' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "user Trials Tool 2",
"description": "user Trials Tool Description 2",
"tool_type": "api",
"is_enabled": true,
"is_draft": false,
"is_default": false,
"base_template_id": 1,
"system_prompt": "ABC"
}'Response Response Example
200 - Example 1
{
"success": true,
"message": "Tool updated successfully.",
"data": {
"id": 70,
"name": "user Trials Tool 2",
"description": "user Trials Tool Description 2",
"org": 1,
"tool_type": "api",
"created_by": "user@example.com",
"is_enabled": true,
"is_default": false,
"connection": false,
"headers": {},
"system_prompt": "ABC",
"base_template": 1
}
}