Skip to the content

Update a Tool

PATCH /v1/tools/{tool_id}

Property	Value
Operation	`update_tool`
Group	Tools
Scope	`tools:write`
Route class	`control`
Idempotency	No `Idempotency-Key`
Audit	Audited `tool.update` (mutation)
Released in	1.49.0
Phase 0 host	Served (the hosted api pins 1.65.0)

Replaces the named fields at the revision If-Match names and checks the Tool again as a create does. Published Agent versions keep the copy they froze; the change reaches Calls through the next Agent version publish (FR-agents-7). An archived Tool is refused with tool_archived.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the tools:write scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl -X PATCH "$VOCAL_API/v1/tools/tool_..." \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H 'If-Match: "1"' \
  -H "Content-Type: application/json" \
  -d '{}'

const response = await fetch(`${process.env.VOCAL_API}/v1/tools/tool_...`, {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'If-Match': '"1"',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
console.log(response.status, await response.text());

import os

import requests

response = requests.patch(
    f"{os.environ['VOCAL_API']}/v1/tools/tool_...",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "If-Match": '"1"',
    },
    json={},
)
print(response.status_code, response.text)

Parameters

Name	In	Type	Required	Description
`tool_id`	path	ToolId	yes	The id of a Tool: `tool_` and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
`if-match`	header	string	yes	The revision the change was made against, quoted as the ETag returns it, or `*` to overwrite.

Request body

Content type application/json, required: ToolUpdateRequest.

Field	Type	Required	Description
`annotations`	ToolAnnotationsInput	no
`description`	string	no	Model-facing: what the Tool does and when to use it.
`filler`	ToolFillerInput or null	no
`http`	HttpToolConfigInput	no	Replaces the request of an `http` Tool, its `auth` as `HttpToolConfigInput` says; refused for a Tool of another type.
`idempotent`	boolean	no
`name`	ToolName	no
`parameters`	ToolParameters	no
`response_schema`	ToolResponseSchema or null	no
`timeout_ms`	integer	no

Responses

Status	Content type	Shape	Error codes
`200`	`application/json`	Tool
`400`	`application/json`	ErrorEnvelope	`invalid_request`
`401`	`application/json`	ErrorEnvelope	`unauthenticated`
`403`	`application/json`	ErrorEnvelope	`forbidden`, `org_suspended`
`404`	`application/json`	ErrorEnvelope	`not_found`
`409`	`application/json`	ErrorEnvelope	`tool_archived`
`412`	`application/json`	ErrorEnvelope	`revision_mismatch`
`422`	`application/json`	ErrorEnvelope	`validation_failed`
`428`	`application/json`	ErrorEnvelope	`precondition_required`
`429`	`application/json`	ErrorEnvelope	`rate_limited`
`500`	`application/json`	ErrorEnvelope	`internal_error`

Fields of the `200` answer

The shape is Tool.

Field	Type	Required	Description
`annotations`	ToolAnnotations	yes
`archived_at`	Timestamp or null	yes	When `DELETE` archived the Tool, or null. An archived Tool takes no write and no test (409 `tool_archived`) and cannot be attached; the Agent versions that froze it keep running it.
`created_at`	Timestamp	yes
`definition_sha256`	string	yes	The SHA-256 of the canonical definition without the auth secret, in lowercase hex; equal to a `PinnedTool`'s when the Agent version froze this revision's definition.
`description`	string	yes	Model-facing: what the Tool does and when to use it.
`filler`	ToolFiller or null	yes
`http`	HttpToolConfig or null	yes	The request of an `http` Tool; null otherwise.
`id`	ToolId	yes
`idempotent`	boolean	yes
`name`	ToolName	yes
`object`	`"tool"`	yes
`organization_id`	OrganizationId	yes
`parameters`	ToolParameters	yes
`response_schema`	ToolResponseSchema or null	yes
`revision`	integer	yes	Counts writes to the Tool; returned as the ETag and required in If-Match.
`timeout_ms`	integer	yes	The deadline of one invocation, in milliseconds.
`type`	ToolType	yes
`updated_at`	Timestamp	yes