Skip to main content
POST
/
v1
/
vector-indices
/
{index_id}
/
retrieve
Retrieve Documents From The Vector Index
curl --request POST \
  --url https://{api_endpoint}/api/v1/vector-indices/{index_id}/retrieve \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "similarity_top_k": 123,
  "max_content_length": 123
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
index_id
string
required

Body

application/json
​
query
string
required
​
similarity_top_k
integer | null
​
max_content_length
integer | null

Response

Successful Response