Interface: AgentChatEvent
One Responses-API-shaped event yielded by the agents plugin SSE stream.
The hook handles the two paths every chat UI needs — accumulating
content from response.output_text.delta and capturing threadId
from appkit.metadata — and surfaces everything else (tool calls,
approval gates, status events, etc.) through UseAgentChatOptions.onEvent.
Fields beyond type are intentionally loose because the agents plugin
forwards adapter-specific shapes verbatim. Treat unknown fields as
opaque pass-through.
Properties
Section titled “Properties”annotations?
Section titled “annotations?”
optionalannotations?:Record<string,unknown>
approval_id?
Section titled “approval_id?”
optionalapproval_id?:string
optionalargs?:unknown
content?
Section titled “content?”
optionalcontent?:string
optionaldata?:Record<string,unknown>
delta?
Section titled “delta?”
optionaldelta?:string
error?
Section titled “error?”
optionalerror?:string
optionalitem?:object
arguments?
Section titled “arguments?”
optionalarguments?:string
call_id?
Section titled “call_id?”
optionalcall_id?:string
optionalid?:string
optionalname?:string
output?
Section titled “output?”
optionaloutput?:string
status?
Section titled “status?”
optionalstatus?:string
optionaltype?:string
item_id?
Section titled “item_id?”
optionalitem_id?:string
output_index?
Section titled “output_index?”
optionaloutput_index?:number
sequence_number?
Section titled “sequence_number?”
optionalsequence_number?:number
stream_id?
Section titled “stream_id?”
optionalstream_id?:string
tool_name?
Section titled “tool_name?”
optionaltool_name?:string
type:
string