Skip to main content
PATCH
/
tools
/
{toolId}
{
  "data": {
    "id": "645e9e4acc61621ce9521a89",
    "name": "get_order_status",
    "description": "Fetch an order status using an orderId.",
    "parameters": {
      "type": "object",
      "properties": {
        "orderId": {
          "type": "string"
        }
      },
      "required": [
        "orderId"
      ]
    },
    "endpoint": {
      "url": "https://api.client.com/tools/get-order-status",
      "method": "POST",
      "timeoutMs": 10000
    },
    "auth": {
      "type": "bearer",
      "token": "REDACTED"
    },
    "createdAt": "2025-11-27T16:00:00.000Z",
    "updatedAt": "2025-11-27T16:00:00.000Z",
    "active": true
  }
}

Path Parameters

​
toolId
string
required

Body

application/json
​
name
string

Tool function name. Must be unique.

Required string length: 1 - 64
Example:

"get_order_status"

​
description
string

What this tool does. This is shown to the LLM to help it decide when to call the tool.

Required string length: 1 - 500
Example:

"Fetch an order status using an orderId."

​
parameters
object

JSON Schema object describing the tool function parameters.

Example:
{
  "type": "object",
  "properties": { "orderId": { "type": "string" } },
  "required": ["orderId"]
}
​
endpoint
object

Invocation settings for the tool endpoint.

Example:
{
  "url": "https://api.client.com/tools/get-order-status",
  "method": "POST",
  "timeoutMs": 10000
}
​
auth
object

Authentication used when calling the endpoint. Secrets should be stored securely server-side.

  • Option 1
  • Option 2
  • Option 3
Example:
{ "type": "bearer", "token": "REDACTED" }
​
active
boolean
default:true

Whether this tool is enabled and can be used by the agent.

Example:

true

Response

Tool definition updated successfully

​
data
object
required