Tool
A Tool (1.49.0): a function the model may call, http or function. Calls run the copy an Agent version froze at publish, never the Tool itself.
An object with 18 fields.
Fields
| 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 |
Used by
The operations whose parameters, request body or responses name this shape directly.