API Reference

Beta

Chat

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Stream Messages

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

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

Path ParametersExpand Collapse

session_id: string

Query ParametersExpand Collapse

organization_id: optional string

project_id: optional string

Cookie ParametersExpand Collapse

session: optional string

Body ParametersJSONExpand Collapse

index_ids: array of string

Indexes to retrieve data from.

prompt: string

User message for this chat turn.

maxLength1000

Stream Messages

HTTP

HTTP

TypeScript

Python

Java

Go

CLI Tool

curl https://api.cloud.llamaindex.ai/api/v1/chat/$SESSION_ID/messages/stream \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY" \
    -d '{
          "index_ids": [
            "idx-abc123",
            "idx-def456"
          ],
          "prompt": "What were the main findings in Q3?"
        }'

200 example

{}

Returns Examples

200 example

{}