API Reference

Beta

Chat

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Stream Messages

beta.chat.stream(strsession_id, ChatStreamParams**kwargs) -> object

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

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

ParametersExpand Collapse

session_id: str

index_ids: SequenceNotStr[str]

Indexes to retrieve data from.

prompt: str

User message for this chat turn.

maxLength1000

organization_id: Optional[str]

project_id: Optional[str]

ReturnsExpand Collapse

object

Stream Messages

Python

HTTP

TypeScript

Python

Java

Go

CLI Tool

import os
from llama_cloud import LlamaCloud

client = LlamaCloud(
    api_key=os.environ.get("LLAMA_CLOUD_API_KEY"),  # This is the default and can be omitted
)
response = client.beta.chat.stream(
    session_id="session_id",
    index_ids=["idx-abc123", "idx-def456"],
    prompt="What were the main findings in Q3?",
)
print(response)

200 example

{}

Returns Examples

200 example

{}