message.delta

⚠️
Preview — this feature is being built; the design below is the spec.

Received on the stream and in the event list. A fragment of the agent’s reply as it is written.

Example

id: evt_01JC7M3B
data: {"type": "message.delta", "message_id": "msg_01JC7M3D", "delta": "Your refund for order 88123 "}

Fields

FieldMeaning
message_idGroups fragments of one reply.
deltaText to append.

Handling

Append deltas for a live typing effect. Always reconcile with message.completed, which carries the full text.

Was this page helpful?