Chat

Stream Messages

Changed on

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

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

Request

  • Base URL: https://api.cloud.llamaindex.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.cloud.llamaindex.ai/api/v1/chat/{session_id}/messages/stream
  • Auth: HTTP bearer

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.

require_all_indexesboolean

Fail the turn if any requested index cannot be queried.

Example request

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

Response

Successful Response

unknown required

Changes

  • a38b684f8e1bRevision changes
    • info

      added the new optional request property

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 614771991b52Revision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status