Sign in
Chat

Stream Messages

Stream agent events for a chat turn as Server-Sent Events.

post/api/v1/chat/{session_id}/messages/stream

Path parameters

session_idstring required

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Request body

index_idsstring[] required

Indexes to retrieve data from.

promptstring required

User message for this chat turn.

Example request

{
  "index_ids": [
    "idx-abc123",
    "idx-def456"
  ],
  "prompt": "What were the main findings in Q3?"
}

Response

Successful Response

{"stackTrail":"paths:/api/v1/chat/{session_id}/messages/stream:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

Changed in 4 of the 33 revisions of this API.14