Skip to main content
POST
/
api
/
run
/
embeddings
/
queries
/
vectorSimilaritySearch
vectorSimilaritySearch
curl --request POST \
  --url https://connvo-dev.convex.cloud/api/run/embeddings/queries/vectorSimilaritySearch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "args": {
    "limit": 123,
    "model": "<string>",
    "sourceTypes": [
      "user"
    ],
    "threshold": 123
  }
}'
{
  "status": "success",
  "errorMessage": "<string>",
  "errorData": {},
  "value": [
    {
      "embedding": {
        "_creationTime": 123,
        "_id": "<string>",
        "createdAt": 123,
        "dimensions": 123,
        "metadata": {},
        "model": "<string>",
        "sourceId": "<string>",
        "sourceType": "user",
        "version": "<string>"
      },
      "score": 123,
      "sourceData": "<any>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Standard user authentication token issued via WorkOS. Provide as Authorization: Bearer <user-token>.

Body

application/json
args
object
required

Response

Convex executed your request and returned a result

status
enum<string>
required
Available options:
success,
error
errorMessage
string
errorData
object
value
object[]