Documentation / @agentick/shared / ToolUseBlock
Interface: ToolUseBlock
Defined in: blocks.ts:178
Tool use block - Function/tool call request
Extends
Properties
createdAt?
readonlyoptionalcreatedAt:string
Defined in: blocks.ts:58
ISO 8601 timestamp when this block was created
Inherited from
id?
readonlyoptionalid:string
Defined in: blocks.ts:54
Unique identifier for this block
Inherited from
index?
readonlyoptionalindex:number
Defined in: blocks.ts:62
Position of this block within the message
Inherited from
input
readonlyinput:Record<string,any>
Defined in: blocks.ts:182
messageId?
readonlyoptionalmessageId:string
Defined in: blocks.ts:56
ID of the message containing this block
Inherited from
metadata?
readonlyoptionalmetadata:Record<string,any>
Defined in: blocks.ts:64
Additional metadata
Inherited from
mimeType?
readonlyoptionalmimeType:string
Defined in: blocks.ts:60
MIME type of the content (for media blocks)
Inherited from
name
readonlyname:string
Defined in: blocks.ts:181
providerMetadata?
readonlyoptionalproviderMetadata:Record<string,Record<string,unknown>>
Defined in: blocks.ts:191
Provider-specific metadata that must round-trip through the pipeline. Keyed by provider name (e.g., "google", "anthropic", "openai").
Used for opaque data the provider requires on subsequent requests, such as Gemini's thoughtSignature on function call parts.
summary?
readonlyoptionalsummary:string
Defined in: blocks.ts:66
Human-readable summary of the content
Inherited from
toolResult?
readonlyoptionaltoolResult:ToolResultBlock
Defined in: blocks.ts:183
toolUseId
readonlytoolUseId:string
Defined in: blocks.ts:180
type
readonlytype:"tool_use"|TOOL_USE
Defined in: blocks.ts:179
Discriminator for type narrowing (e.g., 'text', 'image', 'tool_use')