Update Tool by ID

PUT

/api/v2/tools/{tool_id}

Updates a specific tool's details using its unique identifier.

Purpose:

Allows modification of a tool's attributes such as name, description, configuration, or status.

Path Parameters:

tool_id (UUID): Unique identifier of the tool to be updated.

Request Body:

JSON object containing fields to update. Fields may include:

name (string)

description (string)

configuration (object/dict)

is_active (boolean)

other relevant tool metadata

Returns:

200 OK: A JSON response containing the updated serialized tool data.

400 Bad Request: If input data is invalid or versioning fails.

403 Forbidden: If the user lacks permission to update the tool.

404 Not Found: If the tool does not exist.

500 Internal Server Error: If an unexpected error occurs during update.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT '/api/v2/tools/' \
--header 'Content-Type: application/json' \
--header 'Ocp-Apim-Subscription-Key;' \
--data-raw '{
    "name": "string",
    "description": "string",
    "is_enabled": true,
    "is_default": true,
    "is_draft": true,
    "system_prompt": "string",
    "headers": {
        "property1": null,
        "property2": null
    },
    "base_template_id": 0,
    "search_engine": "string",
    "search_engine_url": "string",
    "search_engine_key": "string",
    "top_k": 0,
    "include_domains": [
        "string"
    ],
    "n_attachments": 0
}'

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "property1": null,
        "property2": null
    }
}

Request

Authorization

API Key

Add parameter in header

Ocp-Apim-Subscription-Key

Example:

Ocp-Apim-Subscription-Key: ********************

Path Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Success

Body

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

Get Tool by ID

Delete Tool by ID