Skip to main content
POST
/
v1
/
indexes
/
describe
Get Index Type
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 index type from the describe response. This indicates the algorithm used for the vector index.

Request Body

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

Response

The response contains the index type in the index_type field:
{
  "index_type": "ivfflat"
}

Example Usage

# Retrieve the type of index
index_type=$(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 -r '.index_type')

echo "Index type: $index_type"