Skip to main content
GET
Get Message Events
Open a Server-Sent Events (SSE) stream to receive the assistant’s response and tool activity for a chat in real time. Connect to this stream before or right after you call Add Message so you capture every event.

Authentication

This request requires your API key in the x-api-key header.
The response uses the text/event-stream content type. Keep the connection open and read events as they arrive rather than waiting for the request to complete.

Request

chatId
string
required
ID of the chat whose events you want to stream.

Event payload

Each SSE event carries a MessageEventDto JSON object.
chatId
string
required
ID of the chat the event belongs to.
eventId
string
required
Unique ID of the event.
status
string
required
Event status. One of inProgress, completed, or failed.
toolName
string
Name of the tool used, when the event represents tool activity.
content
string
Message content or a description of the event.
toolArgs
object
Arguments passed to the tool.
toolResponse
object
Response returned by the tool.

Examples

Stream output

An event with status set to failed indicates the assistant could not complete the response. Use the content field for the failure description.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

chatId
string
required

Response

200 - application/json

Einzelnes MessageEventDto (wird als SSE-Event gesendet)

chatId
string

ID des Chats

eventId
string

ID des Events

toolName
string

Name des Tools, das verwendet wurde

content
string

Inhalt der Nachricht oder Eventbeschreibung

toolArgs
object

Optionales Objekt mit Parametern, die an das Tool übergeben wurden

toolResponse
object

Optionales Objekt mit der Antwort vom Tool

status
enum<string>

Status des Events

Available options:
inProgress,
completed,
failed