Skip to main content
POST /{index_id}/search/text Performs a similarity search by first converting a query text into a vector.

​
Request Body

FieldTypeRequiredDescription
querystringYesThe search query text.
modelstringYesThe embedding model to use for converting the text.
top_kintegerYesThe number of top similar results to return (1-1000).
filterobjectNoA metadata filter to apply before searching.
include_metadatabooleanNoIf true, includes vector metadata in the results.
include_valuesbooleanNoIf true, includes vector embeddings in the results.

​
Example Requests

  • cURL
  • Python SDK
  • JavaScript SDK
curl --location 'https://api.gravixlayer.com/v1/vectors/bf93acdc-dc02-4514-8a6f-292e85fc3450/search/text' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  --data '{
    "query": "What are the latest finance trends?",
    "model": "baai/bge-large-en-v1.5",
    "top_k": 5,
    "filter": { "category": "finance" },
    "include_metadata": true,
    "include_values": false
  }'

​
Response

A JSON object containing the search hits, query time, and token usage. 
{
  "hits": [
    {
      "id": "vec_finance_002",
      "score": 0.41174942,
      "metadata": {
        "category": "finance",
        "language": "english"
      }
    },
    {
      "id": "3ae68ad7-647a-4dd4-885c-cbd498e30428",
      "score": -0.0069170403,
      "metadata": {
        "category": "finance",
        "document_id": "doc_123"
      }
    }
  ],
  "query_time_ms": 62,
  "usage": {
    "prompt_tokens": 7,
    "total_tokens": 7
  }
}
⌘I