Skip to content

ConversationEvent

The events on a conversation's answer stream. The SSE event: name is each member's @jsonName. Clients skip event names they do not know.

Exactly one of these, named by the SSE event: line. The SDKs skip an event name they do not know.

Event Data Visibility Description
message.started MessageStarted public The answer has started.
phase.changed PhaseChanged public The agent moved to another phase of its workflow.
progress.updated ProgressUpdated public A progress step started, changed or finished.
text.delta TextDelta public A fragment of answer text. The one recorded exception to the noun.past_tense naming rule.
citation.added CitationAdded public A citation was added to the answer.
tool.started ToolStarted public A tool call started.
tool.finished ToolFinished public A tool call finished.
input.requested InputRequested public The agent asked the person for input through a widget.
message.completed MessageCompleted public The answer is complete. Ends the stream.
message.failed MessageFailed public The answer failed. Ends the stream; its data is a problem details object.

Used by ResumeConversationStream, SendMessage.