> ## 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.

# Describe Index

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

## Request Body

```json theme={null}
{
  "index_name": "my_index",
  "index_key": "64_character_hex_string_representing_32_bytes"
}
```

<Expandable title="parameters">
  <ParamField body="index_name" type="string" required="true">
    Name of the index to describe
  </ParamField>

  <ParamField body="index_key" type="string" required="true">
    32-byte encryption key as hex string
  </ParamField>
</Expandable>

## Response

```json theme={null}
{
  "index_name": "my_index",
  "index_key": "64_character_hex_string_representing_32_bytes",
  "index_config": {
    "type": "ivfflat",
    "dimension": 384,
    "n_lists": 1024,
    "metric": "euclidean"
  },
  "status": "ready",
  "vector_count": 10000,
  "created_at": "2023-10-01T12:00:00Z"
}
```

<Expandable title="response fields">
  <ResponseField name="index_name" type="string">
    Name of the index
  </ResponseField>

  <ResponseField name="index_key" type="string">
    Encryption key used for the index
  </ResponseField>

  <ResponseField name="index_config" type="object">
    Configuration details of the index, including:

    * `type`: Index type (e.g., ivfflat)
    * `dimension`: Embedding dimension
    * `n_lists`: Number of inverted lists
    * `metric`: Distance metric used
  </ResponseField>

  <ResponseField name="status" type="string">
    Current status of the index (e.g., ready, training)
  </ResponseField>

  <ResponseField name="vector_count" type="integer">
    Total number of vectors indexed
  </ResponseField>

  <ResponseField name="created_at" type="string">
    Timestamp when the index was created
  </ResponseField>
</Expandable>

## Example Usage

```bash theme={null}
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"
     }'
```