Agents Platform

Send Conversation Message Stream

Changed on

Send input to a conversation, and stream the events of the request as server-sent events. The last event is stream_ended, which has the outcome of the turn. This endpoint is in alpha and may change.

post/v1/convai/conversations/{conversation_id}/messages/stream

Request

Path parameters

conversation_idstring required

The Conversation ID

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

Response

Server-sent events. Each event has the stream cursor as its id, the event type as its event, and a stream envelope as its data.

conversation_idstring required
turn_idstring required
created_at_unix_msinteger required

Changes