Skip to main content
GET
Follow real-time chat history (server-sent events)

Reading the stream

EventSource cannot send an Authorization header, so open the stream with fetch and split the body on blank lines. Reopen it while the last snapshot is not terminal: the server closes every connection after 60 seconds. Ask for ?partial=1 so the reply being written arrives as delta frames (the appended text) instead of a whole snapshot per write.
While status is processing, streamingMessage holds the assistant’s reply so far when the model streams (OpenAI, Anthropic, Gemini) and the assistant has no guardrails enabled. Other providers and guarded assistants deliver the text in one piece; status changes and tool calls still arrive as they happen.
Poll GET …/realtime instead only when you cannot hold a connection open, such as a serverless function with a short timeout.

Authorizations

Authorization
string
header
required

Use JWT token for authentication

Path Parameters

identifier
string
required

The unique identifier of the assistant specialization

chatUid
string
required

The unique identifier of the chat conversation

Query Parameters

partial
enum<string>

1 or true: while only the reply being written changes, send event: delta frames with the appended text ({"append":"…"}) or event: partial frames with the whole streamingMessage, instead of a full snapshot. About half the bytes of polling, against 6-7 times without it. Older APIs ignore it.

Available options:
1,
true

Response

A text/event-stream body. snapshot events carry a RealtimeChatHistoryDto (plus streamingMessage while the status is processing).

The response is of type string.

Example:

"event: snapshot\ndata: {\"chatUID\":\"550e8400-e29b-41d4-a716-446655440000\",\"status\":\"processing\",\"chatHistory\":[{\"role\":\"user\",\"content\":{\"message\":\"Analyze this data\"}}],\"streamingMessage\":{\"role\":\"assistant\",\"content\":{\"message\":\"Based on the an\"}},\"lastUpdatedAt\":1705312200000}\n\n: keep-alive\n\nevent: snapshot\ndata: {\"chatUID\":\"550e8400-e29b-41d4-a716-446655440000\",\"status\":\"completed\",\"chatHistory\":[{\"role\":\"user\",\"content\":{\"message\":\"Analyze this data\"}},{\"role\":\"assistant\",\"content\":{\"message\":\"Based on the analysis...\"}}],\"lastUpdatedAt\":1705312214000}\n\n"