Skip to main content
POST
Ask a question (RAG)

Authorizations

Authorization
string
header
required

Pass your API key as a Bearer token. Example: Authorization: Bearer sk-xxxxxxxxxxxx

Path Parameters

id
integer
required

Collection ID

Body

application/json
question
string
required

The question to answer

Example:

"What does the document say about data retention?"

model
string
default:gpt-4o-mini

LLM model identifier to use for answering

Example:

"gpt-4o"

mode
enum<string>
default:fast

Answer mode. fast uses fewer retrieved chunks for a quicker response; full retrieves more context for a thorough answer.

Available options:
fast,
full
stream
boolean
default:false

If true, the response is streamed as Server-Sent Events (SSE). Each event has a type field: delta (text chunk), done (final metadata), or error.

top_k
integer
default:10

Number of knowledge chunks to retrieve before generating the answer

Required range: 1 <= x <= 50
current_only
boolean
default:false

Restrict retrieval to the most current document versions only

chat_history
object[]

Optional prior conversation turns for multi-turn context

Example:
filters
object

Optional metadata filters to scope retrieval

Response

Answer generated successfully. When stream=false, returns a JSON body. When stream=true, returns an SSE stream (Content-Type: text/event-stream).

answer
string

The LLM-generated answer

sources
object[]

Knowledge chunks used to generate the answer

model
string

Model used to generate the answer

tokens_used
object

Token usage breakdown