Get Index - Upstash Documentation

Get Index

curl --request GET \
  --url https://api.upstash.com/v2/vector/index/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://api.upstash.com/v2/vector/index/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.upstash.com/v2/vector/index/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.upstash.com/v2/vector/index/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.upstash.com/v2/vector/index/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.upstash.com/v2/vector/index/{id}")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.upstash.com/v2/vector/index/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "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
    }
  ]
}

GET

vector

index

{id}

Get Index

curl --request GET \
  --url https://api.upstash.com/v2/vector/index/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://api.upstash.com/v2/vector/index/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.upstash.com/v2/vector/index/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.upstash.com/v2/vector/index/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.upstash.com/v2/vector/index/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.upstash.com/v2/vector/index/{id}")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.upstash.com/v2/vector/index/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "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

string

required

The unique ID of the index to fetch

Response

200 - application/json

Index retrieved successfully

customer_id

string

The associated ID of the owner of the index

Example:

"example@upstash.com"

string

Unique ID of the index

Example:

"0639864f-ece6-429c-8118-86a287b0e808"

name

string

The name of the index

Example:

"myindex"

similarity_function

enum<string>

Similarity function that's used to calculate the distance between two vectors

Available options:

COSINE,

EUCLIDEAN,

DOT_PRODUCT

Example:

"COSINE"

dimension_count

number

The amount of values in a single vector

Example:

384

embedding_model

enum<string>

The predefined embedding model to vectorize your plain text

Available options:

BGE_SMALL_EN_V1_5,

BGE_BASE_EN_V1_5,

BGE_LARGE_EN_V1_5,

BGE_M3

Example:

"BGE_SMALL_EN_V1_5"

sparse_embedding_model

enum<string>

The sparse embedding model to be used for indexes

Available options:

BM25,

BGE_M3

Example:

"BM25"

endpoint

string

The REST endpoint of the index

Example:

"glowing-baboon-15797-us1"

token

string

The REST authentication token for the index

Example:

"QkZGAsWp2tdW0tdC0zNzM1LWV1MkFkNQzB1ExUb3hOekF0TVRJbFpMDNLVSm1GZw=="

read_only_token

string

The REST authentication read only token for the index

Example:

"QkZGRk1heGSKC0MtdRlZC0zNzM1LWTj3pAV0Wm1aZ01p05qY3RNR0U0TkRtRt2s9azJU"

type

enum<string>

The payment plan of the index

Available options:

free,

payg,

fixed

Example:

"fixed"

region

enum<string>

The region where the index is currently deployed

Available options:

eu-west-1,

us-east-1,

us-central1

Example:

"us-east-1"

max_vector_count

number

The number of maximum that your index can contain

Example:

5210000

max_daily_updates

number

The number of maximum update operations you can perform in a day. Only upsert operations are included in update count.

Example:

1000000

max_daily_queries

number

The number of maximum query operations you can perform in a day. Only query operations are included in query count.

Example:

1000000

max_monthly_bandwidth

number

The maximum amount of monthly bandwidth for the index. Unit is bytes. -1 if the limit is unlimited.

Example:

-1

max_writes_per_second

number

The number of maximum write operations you can perform per second. Only upsert operations are included in write count.

Example:

1000

max_query_per_second

number

The number of maximum query operations you can perform per second. Only query operations are included in query count.

Example:

1000

max_reads_per_request

number

The number of maximum vectors in a read operation. Query and fetch operations are included in read operations.

Example:

1000

max_writes_per_request

number

The number of maximum vectors in a write operation. Only upsert operations are included in write operations.

Example:

1000

max_total_metadata_size

number

The amount of maximum size for the total metadata sizes in your index.

Example:

53687091200

reserved_price

number

Monthly pricing of your index. Only available for fixed and pro plans.

Example:

60

creation_time

number

The creation time of the vector index in UTC as unix timestamp.

Example:

1753207106

index_type

enum<string>

The type of the vector index

Available options:

DENSE,

SPARSE,

HYBRID

Example:

"DENSE"

throughput_vector

object[]

Throughput data for the vector index over time

Show child attributes

Example:

[
  {
    "x": "2025-09-04 14:55:00.000 +0000 UTC",
    "y": 0
  },
  {
    "x": "2025-09-04 14:56:00.000 +0000 UTC",
    "y": 0
  }
]

List indices Get Index Stats

⌘I