POST
/
v1
/
table
/
{name}
/
query
/
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": true,
  "k": 10,
  "offset": 123,
  "distance_type": "L2",
  "bypass_vector_index": false,
  "filter": "category = '\''shoes'\''",
  "columns": [
    "name",
    "price"
  ],
  "nprobes": 1,
  "refine_factor": null
}'
This response does not have an example.

Authorizations

x-api-key
string
header
required

Path Parameters

name
string
required

name of the table

Body

application/json

Response

200
application/vnd.apache.arrow.file

top k results if query is successfully executed

The response is of type file.