Skip to main content
PATCH
/
tool
/
{tool_id}
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "name": "<string>",
  "type": "<string>",
  "user_id": "<string>",
  "org_id": "<string>",
  "description": "<string>",
  "tool_type": "<string>",
  "configuration": {},
  "is_active": true,
  "created_at": "<string>",
  "updated_at": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
tool_id
string
required

Body

application/json

Request body for partially updating a tool. All fields are optional.

​
name
string | null

Tool name

Required string length: 1 - 100
​
description
string | null

Human-readable description of what the tool does

​
type
string | null

Tool type: function, webhook, api

​
tool_type
string | null

More specific sub-type of the tool

​
configuration
Configuration · object

Tool-specific configuration payload (JSON)

​
is_active
boolean | null

Whether the tool is active

Response

Successful Response

Full tool record returned by the API.

​
id
string
required
​
name
string
required
​
type
string
required
​
user_id
string | null
​
org_id
string | null
​
description
string | null
​
tool_type
string | null
​
configuration
Configuration · object
​
is_active
boolean | null
default:true
​
created_at
string | null
​
updated_at
string | null