GET

Get Custom Tool

Retrieves the full definition of a single custom tool.

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

Headers

Authorizationstringrequired
Bearer authentication with your secret API key.
example: Bearer vx_live_3fa9c2…

Path Parameters

tool_idstringrequired
The custom tool's unique identifier.
example: tool_7b2e91

Request

curl -X GET https://api.vantaxai.com/v1/custom-tools/tool_7b2e91 \
  -H "Authorization: Bearer vx_live_3fa9c2..."

const res = await fetch(
  "https://api.vantaxai.com/v1/custom-tools/tool_7b2e91",
  {
  method: "GET",
  headers: {
    Authorization: "Bearer vx_live_3fa9c2...",
  },
  }
);
const { data } = await res.json();

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

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

from vantax import Vantax

vantax = Vantax(api_key=os.environ["VANTAX_API_KEY"])
# GET /v1/custom-tools/{tool_id}
result = vantax.request("GET", "/v1/custom-tools/{tool_id}")

Response

{
  "success": true,
  "data": {
    "id": "tool_7b2e91",
    "name": "check_order_status",
    "description": "Look up the current status of a customer order by order number.",
    "schema": {
      "type": "object",
      "properties": {
        "order_number": {
          "type": "string",
          "description": "The customer's order number, e.g. ORD-10482."
        },
        "email": {
          "type": "string",
          "description": "Email on file for verification."
        }
      },
      "required": ["order_number"]
    },
    "endpoint_url": "https://api.acme-store.com/orders/lookup",
    "http_method": "POST",
    "sub_account_id": "sub_8a1f4c2e",
    "created_at": "2026-01-14T10:30:00Z",
    "updated_at": "2026-02-02T08:12:00Z"
  }
}

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