POST
/
v1
/
table
/
{name}
/
query

Authorizations

x-api-key
string
header
required

Path Parameters

name
string
required

name of the table

Body

application/json
bypass_vector_index
boolean
default:
false

Whether to bypass vector index.

columns
string[]

The columns to return. Defaults to all columns in the table.

distance_type
enum<string>

distance metric to use for search

Available options:
L2,
Cosine,
Dot
filter
string

A SQL filter expression that specifies the rows to query.

full_text_query
object

The full text query to search for.

k
integer
default:
10

The number of search results to return.

nprobes
integer
default:
1

The number of partitions to search. Higher values yield better search results but are slower.

offset
integer

The number of search results to skip.

prefilter
boolean
default:
false

Whether to apply the filter before search.

refine_factor
integer | null

The refine step re-ranks refine_factor * k results based on exact vectors. Null (the default) skips this step for faster queries.

vector
number[]

The targeted vector to search for.

vector_column
string

The column to query, it can be inferred from the schema if there is only one vector column.

Response

200 - application/vnd.apache.arrow.file

The response is of type file.