Change a tool

PATCH /v1/tools/{tool_id}

Change what the model is told about a tool or the request it makes. Every agent that carries it uses the change on its next turn. Send http whole; a value still reading •••• as it was read keeps what is stored. Needs tools:write and a live key.

Parameters

Name	In	Type	Required	Description
`tool_id`	path	string (uuid)	Yes

Body

Sent as JSON. A field this operation does not take is refused, so a typo fails loudly.

Field	Type	Required	Description
`description`	string or null	No
`http`	object or null	No	The whole request again. A value still reading `••••` as it was read keeps what is stored.
`name`	string or null	No
`parameters`	object or null	No
`speaking_hint`	string or null	No

Answer

200 with ToolObject.

Errors

Every error is a problem document with a stable code.

Status	When
`401`	The key is missing, mistyped, unknown, revoked or expired.
`403`	A credential sent somewhere it does not go yet, or a test key.
`404`	This key reaches no such tool.
`409`	The project already has a tool by that name, or it is frozen.
`422`	The tool's shape, its address or its credential will not do.
`429`	Too many requests for this key or its organization; see `Retry-After`.
`500`	Something went wrong on our side. Quote the `request_id` to support.

Examples

Change a tool

#!/bin/sh
# Change a tool. Every agent that has it uses the change on its next turn. With a live key.
curl -sS --fail-with-body -X PATCH "https://api.aigently.ai/v1/tools/0c2e4a6c-8e0a-4c2e-b4a6-c8e0a2c4e6a8" \
  -H "Authorization: Bearer $AIGENTLY_API_KEY" \
  --json '{
  "description": "Look up where an order is, by its number."
}'

Try it

Sends this request to the API from your browser, with a test key. Nothing it does rings a phone.