API Reference

Beta

Chat

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Stream Messages

JsonElement Beta.Chat.Stream(ChatStreamParamsparameters, CancellationTokencancellationToken = default)

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

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

ParametersExpand Collapse

ChatStreamParams parameters

required string sessionID

Path param

required IReadOnlyList<string> indexIds

Body param: Indexes to retrieve data from.

required string prompt

Body param: User message for this chat turn.

maxLength1000

string? organizationID

Query param

formatuuid

string? projectID

Query param

formatuuid

Stream Messages

C#

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

ChatStreamParams parameters = new()
{
    SessionID = "session_id",
    IndexIds =
    [
        "idx-abc123", "idx-def456"
    ],
    Prompt = "What were the main findings in Q3?",
};

var response = await client.Beta.Chat.Stream(parameters);

Console.WriteLine(response);

200 example

{}

Returns Examples

200 example

{}