Create Tool
POST
/v2/api/organization/{organization_id}/tool
Overview
This is typically used to register tools like api, rag that the organization wants to manage or integrate.
The endpoint ensures the tool is properly categorized and associated with relevant metadata such as its creator, status, and system instructions.
Functionality
organization_id as a path parameter to determine under which organization the tool will be created.name: The name of the tool (mandatory).tool_type: The type of the tool (mandatory).description: A short description of the tool (optional).system_prompt: An optional system-level instruction related to the tool’s behavior or configuration.Request
Path Params
Header Params
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https:///v2/api/organization/1/tool' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "user Testing Tool 2",
"description": "Testing Tool of Postman 2",
"tool_type": "api",
"system_prompt": "Testing"
}'Response Response Example
201 - Example 1
{
"success": true,
"message": "Tool created successfully.",
"data": {
"id": 70,
"name": "user Testing Tool 2",
"description": "Testing Tool of Postman 2",
"org": 1,
"tool_type": "api",
"created_by": "[email protected]",
"is_enabled": true,
"is_default": false,
"connection": false,
"headers": {},
"system_prompt": "Testing",
"base_template": null
}
}