Get Tool
GET
/v2/api/tool/{tool_id}
Overview
tool_id).This operation is essential when users or administrators want to view specific attributes of a tool, such as its name, type, status, and creator details.
What is tool_id?
tool_id is a unique numerical identifier assigned to each tool in the system. It is used to locate and retrieve detailed information about that specific tool. This ID must be provided in the request path as a required parameter.How to View Your Tool ID?
View Your Tool ID
Functionality
tool_id as a required path parameter to identify the tool to be retrieved.id: Unique tool identifiername: Tool namedescription: Short description of the tool’s functionalityorg: Organization ID to which the tool belongstool_type: Type or category of the tool (e.g., rag, api)created_by: Email of the user who created the toolis_enabled: Indicates whether the tool is active and usableis_default: Marks if the tool is a default optionconnection: Shows whether the tool has an active connection statusRequest
Path Params
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https:///v2/api/tool/1' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer 'Response Response Example
200 - Example 1
{
"success": true,
"message": "Tool found successfully.",
"data": {
"id": 1,
"name": "Rag Tool",
"description": "Perform chat on your uploaded documents",
"org": 1,
"tool_type": "rag",
"created_by": "[email protected]",
"is_enabled": true,
"is_default": false,
"connection": false
}
}