PATCH

Update Custom Tool

Updates one or more fields on an existing custom tool.

PATCHhttps://api.vantaxai.com/v1/custom-tools/{tool_id}

Only include the fields you want to change. Updating the `schema` changes the arguments the Agent collects; updating `endpoint_url`, `http_method`, or `headers` changes where and how the request is sent. Changes apply to every Agent the tool is attached to.

Headers

Authorizationstringrequired
Bearer authentication with your secret API key.
example: Bearer vx_live_3fa9c2…
Content-Typestringrequired
Must be application/json for requests with a body.
example: application/json

Path Parameters

tool_idstringrequired
The custom tool to update.
example: tool_7b2e91

Body Parameters

namestringoptional
New tool name.
descriptionstringoptional
Updated natural-language description used by the Agent.
schemaobjectoptional
Replacement JSON Schema for the tool's input parameters.
endpoint_urlstringoptional
Reassign the URL the Agent calls.
http_methodstringoptional
Change the HTTP method.
GETPOSTPATCHPUTDELETE
headersobjectoptional
Replace the static headers sent with each call.

Request

curl -X PATCH https://api.vantaxai.com/v1/custom-tools/tool_7b2e91 \
  -H "Authorization: Bearer vx_live_3fa9c2..." \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "description": "string",
  "schema": {},
  "endpoint_url": "string"
}'

const res = await fetch(
  "https://api.vantaxai.com/v1/custom-tools/tool_7b2e91",
  {
  method: "PATCH",
  headers: {
    Authorization: "Bearer vx_live_3fa9c2...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "string",
    "description": "string",
    "schema": {},
    "endpoint_url": "string"
  }),
  }
);
const { data } = await res.json();

import { Vantax } from "@vantax/sdk";

const vantax = new Vantax({ apiKey: process.env.VANTAX_API_KEY! });
// PATCH /v1/custom-tools/{tool_id}
const result = await vantax.request("PATCH", "/v1/custom-tools/{tool_id}", {
  "name": "string",
  "description": "string",
  "schema": {},
  "endpoint_url": "string"
});

from vantax import Vantax

vantax = Vantax(api_key=os.environ["VANTAX_API_KEY"])
# PATCH /v1/custom-tools/{tool_id}
result = vantax.request("PATCH", "/v1/custom-tools/{tool_id}", json={"name": "string", "description": "string", "schema": {}, "endpoint_url": "string"})

Response

{
  "success": true,
  "message": "Custom tool updated successfully",
  "data": {
    "id": "tool_7b2e91",
    "name": "check_order_status",
    "description": "Look up live order status and tracking by order number.",
    "endpoint_url": "https://api.acme-store.com/v2/orders/lookup",
    "http_method": "POST",
    "updated_at": "2026-02-02T08:12:00Z"
  }
}

{
  "success": false,
  "message": "Validation failed",
  "errors": [
    { "field": "http_method", "message": "http_method must be one of GET, POST, PATCH, PUT, DELETE" }
  ]
}

{ "success": false, "message": "Custom tool not found" }