Skip to main content
POST
/
vectors
/
{index_id}
/
search
/
text
Search by Text
curl --request POST \
  --url https://api.gravixlayer.com/v1/vectors/{index_id}/search/text \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "query": "<string>",
  "model": "<string>",
  "top_k": 500,
  "filter": {},
  "include_metadata": true,
  "include_values": true
}'

Authorizations

Authorization
string
header
required

API key authentication. Get your API key from the Gravix Layer Dashboard.

Path Parameters

index_id
string
required

The ID of the index to search

Body

application/json
query
string
required

The search query text

model
string
required

The embedding model to use

top_k
integer
required

Number of top similar results to return

Required range: 1 <= x <= 1000
filter
object

Metadata filter to apply

include_metadata
boolean

Include vector metadata in results

include_values
boolean

Include vector embeddings in results

Response

200

Search results

I