Endpoints

Upsert Data

Upserts (inserts or updates) the raw text data after embedding it.

To use this endpoint, the index must be created with an embedding model.

Vector embedding of the raw text data will be upserted into the default namespace by default. You can use a different namespace by specifying it in the request path.

Request

You can either upsert a single data, or multiple data in an array.

idbodystringrequired

The id of the vector.

databodystringrequired

The raw text data to embed and upsert.

metadatabodyObject

The metadata of the vector. This makes identifying vectors on retrieval easier and can be used to with filters on queries.

Data field of the vector will be automatically set to the raw text data, so that you can access it later, during queries.

Path

namespacepathstringdefault:

The namespace to use. When no namespace is specified, the default namespace will be used.

Response

resultstring

"Success" string.

curl
curl $UPSTASH_VECTOR_REST_URL/upsert-data \  -X POST \  -H "Authorization: Bearer $UPSTASH_VECTOR_REST_TOKEN" \  -d '[     { "id": "id-0", "data": "Upstash is a serverless data platform.", "metadata": { "link": "upstash.com" } },     { "id": "id-1", "data": "Upstash Vector is a serverless vector database." }  ]'
curl (Namespace)
curl $UPSTASH_VECTOR_REST_URL/upsert-data/ns \  -X POST \  -H "Authorization: Bearer $UPSTASH_VECTOR_REST_TOKEN" \  -d '{ "id": "id-2", "data": "Upstash is a serverless data platform.", "metadata": { "link": "upstash.com" } }'
200 OK
{    "result": "Success"}
422 Unprocessable Entity
{    "error": "Embedding data for this index is not allowed. The index must be created with an embedding model to use it.",    "status": 422}
Loading search…