Vector
Get Index
This endpoint returns the data associated with an index.
GET
/
v2
/
vector
/
index
/
{id}
curl --request GET \
--url https://api.upstash.com/v2/vector/index/{id} \
--header 'Authorization: Basic <encoded-value>'
{
"customer_id": "test@upstash.com",
"id": "0639864f-ece6-429c-8118-86a287b0e808",
"name": "myindex",
"similarity_function": "COSINE",
"dimension_count": 5,
"endpoint": "test-index-3814-eu1-vector.upstash.io",
"token": "QkZGMk5heGltdW0tdXBkYXRlZC0zNzM1LWV1MkFkbWlOeGZGZ1J5Wm1GdE5tTXhNQzB1TmpsbExUb3hOekF0TVRJbFpqMTJORFUxTm1GZw==",
"read_only_token": "QkZGRk1heGltdW0tdXBkYXRlZC0zNzM1LWV1MnJlYWRvbmx5TmtaZ05qS3JNWVV0Wm1aZ01pMDBOV1poTHRob05qY3RNR0U0TkRjejNqazJU",
"type": "paid",
"region": "eu-west-1",
"max_vector_count": 400000000,
"max_daily_updates": -1,
"max_daily_queries": -1,
"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": null,
"creation_time": 1707313165
}
Authorizations
Basic authentication using email and API key
Path Parameters
The unique ID of the index to fetch.
Response
200 - application/json
Details of the index
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://api.upstash.com/v2/vector/index/{id} \
--header 'Authorization: Basic <encoded-value>'
{
"customer_id": "test@upstash.com",
"id": "0639864f-ece6-429c-8118-86a287b0e808",
"name": "myindex",
"similarity_function": "COSINE",
"dimension_count": 5,
"endpoint": "test-index-3814-eu1-vector.upstash.io",
"token": "QkZGMk5heGltdW0tdXBkYXRlZC0zNzM1LWV1MkFkbWlOeGZGZ1J5Wm1GdE5tTXhNQzB1TmpsbExUb3hOekF0TVRJbFpqMTJORFUxTm1GZw==",
"read_only_token": "QkZGRk1heGltdW0tdXBkYXRlZC0zNzM1LWV1MnJlYWRvbmx5TmtaZ05qS3JNWVV0Wm1aZ01pMDBOV1poTHRob05qY3RNR0U0TkRjejNqazJU",
"type": "paid",
"region": "eu-west-1",
"max_vector_count": 400000000,
"max_daily_updates": -1,
"max_daily_queries": -1,
"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": null,
"creation_time": 1707313165
}