Skip to main content
POST
/
v1
/
indexes
/
describe
Get Index Configuration
curl --request POST \
  --url https://api.example.com/v1/indexes/describe

Documentation Index

Fetch the complete documentation index at: https://docs.cyborg.co/llms.txt

Use this file to discover all available pages before exploring further.

Extract the complete index configuration from the describe response. This contains all the parameters used to configure the vector index.

​
Request Body

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

​
Response

The response contains the index configuration in the index_config field: 
{
  "index_name": "my_index",
  "index_type": "ivfflat",
  "is_trained": true,
  "index_config": {
    "type": "ivfflat",
    "dimension": 384,
    "n_lists": 1024,
    "metric": "euclidean"
  }
}

​
Example Usage

# Retrieve index config
config=$(curl -s -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"
     }' | jq '.index_config')

echo "Index configuration: $config"