Skip to main content
POST
/
v1
/
indexes
/
describe
Describe Index
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.

Get detailed information about an existing index, including its configuration and status.

​
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",
  "index_type": "ivfflat",
  "is_trained": true,
  "index_config": {
    "type": "ivfflat",
    "dimension": 384,
    "metric": "euclidean",
    "n_lists": 1024
  }
}

​
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"
     }'