Type Alias AgentCustomToolUseEvent 

pub type AgentCustomToolUseEvent = AgentToolUseEvent;

Available on crate feature managed-agents-preview only.

agent.custom_tool_use: agent invokes one of the caller’s custom tools. The session pauses; respond with an OutgoingUserEvent::CustomToolResult.

Aliased Type

pub struct AgentCustomToolUseEvent {
    pub id: Option<String>,
    pub processed_at: Option<String>,
    pub name: String,
    pub input: Value,
    pub evaluated_permission: Option<AgentEvaluatedPermission>,
    pub session_thread_id: Option<String>,
}

Fields

id: Option<String>

Envelope.

processed_at: Option<String>

Server-side recording timestamp.

name: String

Tool name.

input: Value

Tool input.

evaluated_permission: Option<AgentEvaluatedPermission>

Permission verdict the platform applied. Ask means the client must reply with a user.tool_confirmation event before the tool runs. None when the tool’s permission policy is allow or the field isn’t reported.

session_thread_id: Option<String>

Set on multi-agent sessions when the request originated in a sub-agent thread. Echo this on the corresponding OutgoingUserEvent::ToolConfirmation or OutgoingUserEvent::CustomToolResult reply so the platform routes it back to the waiting thread. Absent for primary-thread events.

Research-preview: only populated when multi-agent threads are in use.