Skip to content

Stream LazyGraphRAG query results

POST
/knowledge-bases/{knowledgeBaseId}/query/stream

Executes a LazyGraphRAG query with iterative LLM relevance testing. Returns citations as Server-Sent Events as they are discovered. The query flow: (1) Query expansion via LLM, (2) Vector search, (3) Community-ordered relevance testing, (4) Stream relevant citations. Budget controls how many chunks are tested (higher = more thorough, more costly).

knowledgeBaseId
required

Unique identifier for the knowledge base to retrieve

string

Unique identifier for the knowledge base to retrieve

object
query
required

Search query text

string
>= 1 characters
model

Embedding model to use for this query (defaults to KB’s primary model). Must be configured for this KB.

string
Allowed values: BAAI/bge-small-en-v1.5 BAAI/bge-base-en-v1.5 BAAI/bge-large-en-v1.5 sentence-transformers/all-MiniLM-L6-v2 sentence-transformers/all-mpnet-base-v2 nomic-ai/nomic-embed-text-v1.5
budget

Maximum number of chunks to evaluate for relevance (1-500, default: 20). Higher budgets find more relevant content but cost more LLM calls.

integer
default: 20 >= 1 <= 500
filter

MongoDB-style metadata filter (e.g., {“status”: “final”, “version”: {“$gt”: 1}})

object
key
additional properties
Any of:
object
$eq
required
Any of:
string

Server-sent events stream with citation, progress, and stream-complete events

string

Bad Request - Validation error or invalid input

object
error
required
string
code
string
details
nullable
retryable
boolean

Unauthorized - Authentication required or invalid token

object
error
required
string
code
string
details
nullable
retryable
boolean

Forbidden - Insufficient permissions

object
error
required
string
code
string
details
nullable
retryable
boolean

Not Found - Resource does not exist

object
error
required
string
code
string
details
nullable
retryable
boolean