Reference
Back to Remy
Remy Reference/interface/VoiceToolCallEvent
?

VoiceToolCallEvent

Type
Tool activity from the agent, carrying each finished call's result to the screen.

Tool activity, delivered on the toolCall event, for a compact inline status in the app's own voice ("Booking your appointment…"), never raw method names. What makes voice tools feel alive is result: every finished call carries its return value, delivered only to this session, so the screen can render the citation, record, or confirmation the agent just produced in lockstep with the spoken answer.

VoiceToolCallEvent.ts
interface VoiceToolCallEvent {
  method: string
  status: 'running' | 'done' | 'failed'
  at: number
  result?: unknown
  resultTruncated?: boolean
}
Fields
method
string
The method id being executed.
status
'running' | 'done' | 'failed'
Where the call is.
at
number
Milliseconds since epoch.
result
unknown
The tool's return value, present on every 'done' unless truncated, so the UI can show what the agent just did in step with the speech. Failed calls carry none.
resultTruncated
boolean
Set instead of result when the payload exceeded the ~32KB forwarding cap. Fetch the data yourself in that case.
Show what the agent did
session.on('toolCall', ({ method, status, result }: VoiceToolCallEvent) => {
  if (status === 'done') renderResult(result);
});