Skip to main content
GET
/
chat-internal-messages
/
{chatId}
/
listen
Listen to Chat Messages (SSE)
curl --request GET \
  --url https://app.splox.io/api/v1/chat-internal-messages/{chatId}/listen \
  --header 'Authorization: Bearer <token>'
"<string>"
Streams real-time chat messages via Server-Sent Events (SSE) as they are sent and received.

​
Usage

This endpoint provides a persistent connection that streams chat messages as they happen: 
curl -N -H "Authorization: Bearer YOUR_TOKEN" \
  https://app.splox.io/api/v1/chat-internal-messages/{chat_id}/listen

​
Response Format

Server-Sent Events (SSE) stream with each event containing chat messages: 
{
  "id": "0199f300-b22c-8d9e-5555-999901cdef02",
  "chat_id": "0199f200-a11b-7c8d-4444-888890abcdef",
  "role": "assistant",
  "content": "Hello! How can I help you?",
  "created_at": "2025-10-22T12:16:00Z",
  "workflow_request_id": "0199f123-d60e-7ffd-9131-4cc5ab040ee8"
}

​
Message Roles

  • user - Messages from the user
  • assistant - Messages from the AI/workflow
  • system - System messages (optional)

​
Use Cases

  • Real-time chat UI - Display messages as they arrive
  • Desktop app - Stream chat messages in native app
  • Web chat interface - Update UI without polling
  • Multi-user sync - Keep multiple clients in sync

​
Notes

Authentication required: Users can only listen to their own chats
Connection timeout: SSE connections timeout after 30 minutes. Reconnect if needed.
The stream includes keepalive messages every 3 seconds to prevent connection drops.

Authorizations

​
Authorization
string
header
required

JWT token from Splox account

Path Parameters

​
chatId
string<uuid>
required

Chat ID

Response

200 - text/event-stream

SSE stream of chat messages

The response is of type string.