{ "summary": "Streaming text chunk", "value": { "type": "chunk", "chunk": "Sure! I can help with", "chunkIndex": 3, "ui_engine": false } }
{ "summary": "Minimal text turn", "value": { "agentId": "agt_01HZX2K9ABC", "convoId": "conv_01HZX2K9XYZ", "bucket": "(default)", "prompt": "Hello, how can you help me?", "lightConvoData": { "userName": "John Doe", "userEmail": "john@example.com", "origin": "web-chat" } } }
Websockets
Interact channel
Single bi-directional channel used to drive one agent turn. The client
sends exactly one InteractObject; the server streams back chunked
responses until it closes the connection (code 1000).
WSS
/
interact
Messages
{ "summary": "Streaming text chunk", "value": { "type": "chunk", "chunk": "Sure! I can help with", "chunkIndex": 3, "ui_engine": false } }
{ "summary": "Minimal text turn", "value": { "agentId": "agt_01HZX2K9ABC", "convoId": "conv_01HZX2K9XYZ", "bucket": "(default)", "prompt": "Hello, how can you help me?", "lightConvoData": { "userName": "John Doe", "userEmail": "john@example.com", "origin": "web-chat" } } }
method
type:string
GET
Streaming chunk
type:object
One streamed event from the agent.
Interact request
type:object
The single payload the client sends after opening the socket.