API ReferenceConversations
Stream messages (SSE)
Server-Sent Events stream of new messages for a conversation. Authenticate with a ?ticket= obtained from POST .../stream-ticket. Supports reconnect via Last-Event-ID header or ?after=<chatId|ISO>. Emits "message" and periodic "heartbeat" events.
Authorization
ApiKeyAuth AuthorizationBearer <token>
Team API key (prefix sk_). You may also send the key via X-Api-Key header.
In: header
Path Parameters
conversationId*unknown
Conversation ID
agentId*unknown
Agent ID
Query Parameters
after?string
Replay messages after this chat id or ISO timestamp
ticket*unknown
Single-use SSE ticket
Header Parameters
last-event-id*string
Last-Event-ID?string
Last received message id; EventSource sends this automatically on reconnect to replay missed messages.
Response Body
text/event-stream
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/console/agents/{agentId}/conversations/{conversationId}/stream" \ -H "last-event-id: string"A new conversation message
"id: cm123abc456def\nevent: message\ndata: {\"id\":\"cm123abc456def\",\"conversation_id\":\"cm456def789ghi\",\"role\":\"user\",\"message\":\"Hello, I need help with my order\",\"message_type\":\"text\",\"created_at\":\"2026-06-05T08:00:00.000Z\"}\n\n"{ "message": "string", "error": "string", "code": "string", "statusCode": 0, "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"}{ "message": "string", "error": "string", "code": "string", "statusCode": 0, "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"}{ "message": "string", "error": "string", "code": "string", "statusCode": 0, "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"}