Skip to main content
POST
/
v1
/
table
/
{name}
/
query
Search Data
curl --request POST \
  --url https://{db}.{region}.api.lancedb.com/v1/table/{name}/query \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "vector": [
    0.1,
    0.2,
    0.3
  ],
  "full_text_query": {
    "columns": [
      "name",
      "description"
    ],
    "query": "sneakers"
  },
  "vector_column": "vector",
  "prefilter": false,
  "k": 10,
  "offset": 1,
  "distance_type": "L2",
  "bypass_vector_index": false,
  "filter": "category = '\''shoes'\'' AND price < 100",
  "columns": [
    "<string>"
  ],
  "nprobes": 10,
  "refine_factor": null
}'
This response does not have an example.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
name
string
required

Body

application/json
​
vector
number[]
Example:
​
full_text_query
object
​
vector_column
string
Example:
​
prefilter
boolean
default:false
​
k
integer
default:10
Required range: 1 <= x <= 1000
​
offset
integer
Required range: x >= 0
​
distance_type
enum<string>
Available options:
L2,
Cosine,
Dot
​
bypass_vector_index
boolean
default:false
​
filter
string
Example:
​
columns
string[]
​
nprobes
integer
default:10
Required range: 1 <= x <= 1000
​
refine_factor
integer | null
Required range: x >= 1

Response