GET
/
vector
/
index
/
{id}
Get Index
curl --request GET \
  --url https://api.upstash.com/v2/vector/index/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "customer_id": "example@upstash.com",
  "id": "0639864f-ece6-429c-8118-86a287b0e808",
  "name": "myindex",
  "similarity_function": "COSINE",
  "dimension_count": 384,
  "embedding_model": "BGE_SMALL_EN_V1_5",
  "sparse_embedding_model": "BM25",
  "endpoint": "glowing-baboon-15797-us1",
  "token": "QkZGAsWp2tdW0tdC0zNzM1LWV1MkFkNQzB1ExUb3hOekF0TVRJbFpMDNLVSm1GZw==",
  "read_only_token": "QkZGRk1heGSKC0MtdRlZC0zNzM1LWTj3pAV0Wm1aZ01p05qY3RNR0U0TkRtRt2s9azJU",
  "type": "fixed",
  "region": "us-east-1",
  "max_vector_count": 5210000,
  "max_daily_updates": 1000000,
  "max_daily_queries": 1000000,
  "max_monthly_bandwidth": -1,
  "max_writes_per_second": 1000,
  "max_query_per_second": 1000,
  "max_reads_per_request": 1000,
  "max_writes_per_request": 1000,
  "max_total_metadata_size": 53687091200,
  "reserved_price": 60,
  "creation_time": 1753207106,
  "index_type": "DENSE",
  "throughput_vector": [
    {
      "x": "2025-09-04 14:55:00.000 +0000 UTC",
      "y": 0
    },
    {
      "x": "2025-09-04 14:56:00.000 +0000 UTC",
      "y": 0
    }
  ]
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

id
string
required

The unique ID of the index to fetch

Response

200 - application/json

Index retrieved successfully

The response is of type object.