Skip to main content
PATCH
Update Tool

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

tool_id
string
required

Body

application/json
name
string | null
Required string length: 1 - 120
description
string | null
Maximum string length: 2000
arguments
AgentWebhookArgumentPayload · object[] | null
method
enum<string> | null
Available options:
GET,
POST,
PUT,
PATCH,
DELETE
url
string | null
Required string length: 1 - 4000
content_type
string | null
Maximum string length: 128
body_template
string | null
Maximum string length: 100000
headers
AgentWebhookHeaderPayload · object[] | null
timeout_seconds
integer | null
Required range: 1 <= x <= 120
error_handling
enum<string> | null
Available options:
passthrough,
hide
mock_responses
AgentWebhookMockResponsePayload · object[] | null
expects_response
boolean | null

Response

Request fulfilled, document follows

tool_id
string
required
workspace_id
string
required
name
string
required
tool_type
enum<string>
required
Available options:
webhook,
client
method
enum<string>
required
Available options:
GET,
POST,
PUT,
PATCH,
DELETE
url
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
content_type
string
required
timeout_seconds
integer
required
error_handling
enum<string>
required
Available options:
passthrough,
hide
description
string
default:""
used_by
integer
default:0

How many agents reference this tool in their draft configuration.

arguments
AgentWebhookArgumentPayload · object[]
body_template
string
default:""
headers
PublicToolHeader · object[]
mock_responses
AgentWebhookMockResponsePayload · object[]
expects_response
boolean
default:true