Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer token authentication. Include the token in the Authorization header as 'Bearer '

Query Parameters

include_metrics
boolean

Include metrics in the response. Default is false.

Body

application/json

Search request supporting dense/sparse modes with vector or text queries

search_mode
enum<string>
required

Search mode to use

Available options:
dense,
sparse,
hybrid
top_k
integer<int32>
required

Number of top results to return from the hybrid search. Must be greater than 0.

Example:

"100"

dense
null | object

Dense vector search configuration

filter
string | null
default:""

SQL WHERE clause to filter the results. If not specified, no filtering will be applied.

Example:

"id < 1000"

fusion
null | object

Fusion configuration for combining results

projection
string | null
default:*

Columns to include in the result set. Uses SQL projection syntax (e.g. "col1, col2"). If not specified, all columns will be returned.

Example:

"id, name"

sparse
null | object

Sparse vector search configuration

Response

Successfully performed search

code
integer<int32>
required

HTTP status code.

Required range: x >= 0
success
boolean
required

Whether the request was successful.

data
object
exception
object