Skip to main content
PATCH
Update an existing tool

Authorizations

x-api-key
string
header
required

Project API key. Create and manage keys in the dashboard under Project → API Keys. Send as header: x-api-key:

Path Parameters

id
string
required

Tool ID

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Body

application/json
deprecatedInfo
object
required
slug
string

Tool slug

Maximum string length: 100
Example:

"send_slack_digest"

name
string

Tool name

Maximum string length: 200
Example:

"Send Slack digest"

description
string

Tool description

Example:

"Posts a daily summary to a Slack channel"

instructions
string

Tool instructions

Example:

"Call when the user asks to share a digest in Slack."

toolkitSlug
string

Toolkit slug

Maximum string length: 100
Example:

"my-custom-toolkit"

inputParameters
object

JSON Schema for tool arguments

Example:
outputParameters
object

JSON Schema for the tool result

Example:
noAuth
boolean
default:false

Whether the tool requires no authentication

scopes
string[]

Required OAuth/API scopes

Example:
tags
string[]

Tool tags

Example:
isImportant
boolean
default:false

Whether the tool is important

popularityScore
number
default:0

Popularity score

Required range: x >= 0
type
enum<string>
default:action

Tool type

Available options:
action,
poll,
webhook
availableVersions
string[]

Available versions

Example:
version
string
default:1.0.0

Tool version

Maximum string length: 50
isDeprecated
boolean
default:false

Whether the tool is deprecated

isDisabled
boolean
default:false

Whether the tool is disabled

triggerThreadKey
string

Trigger thread key (for webhook type)

Example:

"invoice.paid"

script
object
executionCreditCost
number | null

Credits charged per successful execution. Omit or null for platform default (2). Admin only.

Required range: x >= 0
Example:

2

Response

200 - application/json

Tool updated successfully

success
boolean
required

Success status

Example:

true

message
string
required

Success message

Example:

"Operation completed successfully"

data
object
required
Example: