GET
/
range
curl https://hardy-cricket-48359-us1-vector.upstash.io/range \
  -H "Authorization: Bearer ABcFMGhhcmR5LWNyaWNrZXQtNDgzNTktdXMxYWRtaW5PREE0TkdVME5XUXRaV0poTWkwME9UVTFMVGxrTm1NdE9USTROR0ppWkRsak56ZGs=" \
  -d '{ "cursor": "0",
  "limit" : 2,
  "includeVectors": false,
  "includeMetadata": true }'
{
  "result" : {
    "nextCursor" : "2",
    "vectors" : [ 
		{
	      "id" : "1",
	      "metadata" : {"genre":"comedy","year":2020}
    	}, 
		{
	      "id" : "2",
	      "metadata" : {"genre":"comedy","year":2020}
    	} 
	]
  }
}

Request

cursor
string
required

The offset to the last retrieved vector. Should be set to "0" in the initial range.

limit
number
required

The number of maximum vectors that you want in the response of range. (page size)

includeMetadata
boolean

Whether to include the metadata of the vectors in the response. Setting this true would be the best practice, since it will make it easier to identify the vectors.

includeVectors
boolean

The metadata of the vector. This is used to make it easier to identify the vector on queries.

Response

nextCursor
string
required

The offset for the next range. You should place this in the cursor field for the next range.Empty if there are no other vectors in the index.

vectors
Object[]
required
id
string
required

The ID of the vector

vector
number[]
required

The embedding data

metadata
Object

Whether to include the vector data of the resulting vectors.