Skip to main content
GET
/
v1
/
vector-indices
/
{index_id}
Get Vector Index By Id
curl --request GET \
  --url https://{api_endpoint}/api/v1/vector-indices/{index_id} \
  --header 'Authorization: Bearer <token>'
{
  "embeddings_model_name": "<string>",
  "chunk_size": 123,
  "chunk_overlap": 123,
  "status": "not_ready",
  "status_msg": "<string>",
  "top_k": 10,
  "extraction_strategy": "standard"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
index_id
string
required

Query Parameters

​
select
string
default:*

Response

Successful Response

​
embeddings_model_name
string | null
​
chunk_size
integer | null
​
chunk_overlap
integer | null
​
status
enum<string>
default:not_ready
Available options:
ready,
not_ready,
rebuilding,
error,
update_pending
​
status_msg
string | null
​
top_k
integer
default:10
​
extraction_strategy
enum<string>
default:standard
Available options:
express,
standard,
high_quality