Skip to main content
POST
Stream Answer

Authorizations

x-user-auth
string
header
required

Your API key from account settings

x-bot
string
header
required

Your bot ID from account settings

Body

application/json
Question
string
required

The question to answer using indexed documents

Example:

"ما هو الاسم الكامل لمحمد صلاح؟"

IndexNames
string[]
required

Names of document indexes to search (each matches a knowledge unit title). Required for the streaming endpoint; optional for the standard endpoint.

Example:
Limit
integer

Number of document chunks to retrieve

Required range: 1 <= x <= 50
Example:

10

MaxLimit
integer

Maximum number of documents to process

Required range: 1 <= x <= 50
Example:

10

Temperature
number<float>

Controls creativity in answer generation

Required range: 0 <= x <= 1
Example:

0.1

MaxOutputTokens
integer

Maximum tokens in generated answer

Required range: 1 <= x <= 4096
Example:

1024

UpdateGlobal
boolean

Whether to update global context

Example:

false

IsStream
boolean

Must be true for streaming responses

Example:

true

Response

200 - text/event-stream

Streaming RAG response with progressive content and citations

Server-sent events with answer chunks and metadata