Skip to content

Documentation / @agentick/shared / ToolUseBlock

Interface: ToolUseBlock

Defined in: blocks.ts:178

Tool use block - Function/tool call request

Extends

Properties

createdAt?

readonly optional createdAt: string

Defined in: blocks.ts:58

ISO 8601 timestamp when this block was created

Inherited from

BaseContentBlock.createdAt


id?

readonly optional id: string

Defined in: blocks.ts:54

Unique identifier for this block

Inherited from

BaseContentBlock.id


index?

readonly optional index: number

Defined in: blocks.ts:62

Position of this block within the message

Inherited from

BaseContentBlock.index


input

readonly input: Record<string, any>

Defined in: blocks.ts:182


messageId?

readonly optional messageId: string

Defined in: blocks.ts:56

ID of the message containing this block

Inherited from

BaseContentBlock.messageId


metadata?

readonly optional metadata: Record<string, any>

Defined in: blocks.ts:64

Additional metadata

Inherited from

BaseContentBlock.metadata


mimeType?

readonly optional mimeType: string

Defined in: blocks.ts:60

MIME type of the content (for media blocks)

Inherited from

BaseContentBlock.mimeType


name

readonly name: string

Defined in: blocks.ts:181


providerMetadata?

readonly optional providerMetadata: 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?

readonly optional summary: string

Defined in: blocks.ts:66

Human-readable summary of the content

Inherited from

BaseContentBlock.summary


toolResult?

readonly optional toolResult: ToolResultBlock

Defined in: blocks.ts:183


toolUseId

readonly toolUseId: string

Defined in: blocks.ts:180


type

readonly type: "tool_use" | TOOL_USE

Defined in: blocks.ts:179

Discriminator for type narrowing (e.g., 'text', 'image', 'tool_use')

Overrides

BaseContentBlock.type

Released under the ISC License.