Skip to main content
POST
/
api
/
v1
/
embeddings
/
{indexName}
/
search
Search for embeddings
curl --request POST \
  --url https://api.example.com/api/v1/embeddings/{indexName}/search \
  --header 'Content-Type: application/json' \
  --header 'X-Eigen-API-Key: <api-key>' \
  --data '
{
  "queryVector": [
    123
  ],
  "k": 123
}
'
{
  "status": 200,
  "message": "Similarity search successfully performed.",
  "data": {
    "nearest_neighbors": {
      "21": {
        "metadata": {
          "foo3": "bar4"
        },
        "rank": 2
      },
      "45": {
        "metadata": {
          "foo7": "bar8"
        },
        "rank": 4
      },
      "54": {
        "metadata": {
          "foo": "bar"
        },
        "rank": 0
      },
      "63": {
        "metadata": {
          "foo5": "bar6",
          "hello": "world"
        },
        "rank": 3
      },
      "98": {
        "metadata": {
          "foo1": "bar2",
          "bar": "baz"
        },
        "rank": 1
      }
    }
  }
}

Authorizations

​
X-Eigen-API-Key
string
header
required

Path Parameters

​
indexName
string
required

Name of the index

Body

application/json
​
queryVector
number<float>[]
required

ID of the query vector

​
k
number<int>
required

Number of retrieved embedding desired.

Response

The k-nearest embeddings returned in an array along with their rank (0 is nearest).

​
status
integer
required

Status code of the response

​
message
string
required

Message giving basic information on the response

​
data
object

Important data to be given to the caller

​
error
object

An error that has occured