AI SDK Kotlin/ai.torad.aisdk/ContentPart/ToolApprovalRequest

ToolApprovalRequest

@SerialName(value = "tool-approval-request")

data class ToolApprovalRequest(val toolCallId: String, val toolName: String, val input: JsonElement, val approvalId: String? = null, val signature: String? = null, val providerMetadata: ProviderMetadata = ProviderMetadata.None) : ContentPart(source)

Assistant content: the LLM called a tool that requires approval.

Since

0.3.0-beta01

Constructors

ToolApprovalRequest

constructor(toolCallId: String, toolName: String, input: JsonElement, approvalId: String? = null, signature: String? = null, providerMetadata: ProviderMetadata = ProviderMetadata.None)

Properties

approvalId

val approvalId: String?

Approval-identity key distinct from toolCallId per v6 (gap #7 in historical parity work). Null defaults to toolCallId for the common single-approval case; explicit value lets two approvals share a tool-call id without correlation ambiguity.

input

val input: JsonElement

metadata

val ContentPart.metadata: ProviderMetadata

providerMetadata

@EncodeDefault(mode = EncodeDefault.Mode.NEVER)

val providerMetadata: ProviderMetadata

signature

val signature: String?

HMAC-SHA256 signature binding this approval to its tool call (v6.0.202). Present only when the agent is configured with experimental_toolApprovalSecret; verified fail-closed when the approval is replayed.

toolCallId

val toolCallId: String

toolName

val toolName: String