> ## 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 Index Name

Extract the index name from the describe response. This represents the identifier of the currently described index.

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

The response contains the index name in the `index_name` field:

```json theme={null}
{
  "index_name": "my_index"
}
```

<Expandable title="response fields">
  <ResponseField name="index_name" type="string">
    Name of the index (extract this field)
  </ResponseField>
</Expandable>

## Example Usage

```bash theme={null}
# Retrieve the index name
index_name=$(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_name')

echo "Current index name: $index_name"
```
