Skip to main content
POST
/
v1
/
indexes
/
describe
Describe Index
curl --request POST \
  --url https://api.example.com/v1/indexes/describe
Get detailed information about an existing index.

​
Authentication

Required - API key via X-API-Key header: 
X-API-Key: cyborg_your_api_key_here
You can get an API key from the CyborgDB Admin Dashboard. For more info, follow this guide.

​
Request Body

{
  "index_name": "my_index",
  "index_key": "64_character_hex_string_representing_32_bytes"
}

​
Response

{
  "index_name": "my_index",
  "is_trained": true,
  "dimension": 384,
  "metric": "euclidean",
  "n_lists": 1024
}
v0.17 simplified the describe response. The index_type and nested index_config fields from v0.16 are gone — there is now a single DiskIVF index type and the relevant parameters are returned as top-level fields.

​
Exceptions

  • 401: Authentication failed (invalid API key) or wrong index_key on SDK-supplied indexes — see error model
  • 404: Index not found
  • 422: Invalid request parameters
  • 500: Internal server error

​
Example Usage

curl -X POST "http://localhost:8000/v1/indexes/describe" \
     -H "X-API-Key: cyborg_your_api_key_here" \
     -H "Content-Type: application/json" \
     -d '{
       "index_name": "my_index",
       "index_key": "your_64_character_hex_key_here"
     }'
KMS-backed index (no key required): 
curl -X POST "http://localhost:8000/v1/indexes/describe" \
     -H "X-API-Key: cyborg_your_api_key_here" \
     -H "Content-Type: application/json" \
     -d '{
       "index_name": "kms_index"
     }'