Skip to main content
POST
Search

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/x-www-form-urlencoded
collection
string
required

Target collection to search within

query_text
string
required

Query text to search for

embedding_model_id
string
default:text-embedding-v4

Embedding model ID (default: text-embedding-v4)

search_type
enum<string> | null

Search strategy: dense, sparse, or hybrid (default: hybrid)

Available options:
dense,
sparse,
hybrid
top_k
integer | null

Maximum number of results to return (default: 5)

Required range: 1 <= x <= 100
filters
Filters · object | null

Optional filters to apply during search. Format: {field: value} for equality filters. For advanced filters, use {field: {operator: str, value: Any}} where operator can be: eq, ne, gt, gte, lt, lte, in, contains.

fusion_config
Fusion Config · object | null

Optional fusion configuration for hybrid search

rerank_model_id
string | null

Optional rerank model ID for result reordering

rerank_top_k
integer | null

Optional override for rerank result count

readonly
boolean | null

Avoid index modifications (default: False)

nprobes
integer | null

Number of partitions to probe for ANN search

refine_factor
integer | null

Refine factor for ANN search re-ranking

fallback_to_sparse
boolean | null

Allow hybrid search to fallback to sparse (default: True)

Response

Successful Response

Unified response payload for document search pipeline.

status
string
required

Pipeline status: success|partial_success|error

search_type
enum<string>
required

Actual search strategy executed (post-fallback if any)

Available options:
dense,
sparse,
hybrid
result_count
integer
required

Number of results returned

message
string
required

Human-readable pipeline outcome message

results
SearchResult · object[]

Search results (possibly reranked)

warnings
string[]

Non-fatal warnings and fallback messages

used_rerank
boolean
default:false

Whether rerank model was applied to the results