Types & Getters
Describe Index
POST
/
v1
/
indexes
/
describe
Describe Index
curl --request POST \
--url https://api.example.com/v1/indexes/describeimport requests
url = "https://api.example.com/v1/indexes/describe"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/v1/indexes/describe', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/indexes/describe",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/indexes/describe"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/indexes/describe")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/indexes/describe")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyGet detailed information about an existing index, including its configuration and status.
You can get an API key from the CyborgDB Admin Dashboard. For more info, follow this guide.
Authentication
Required - API key viaX-API-Key header:
X-API-Key: cyborg_your_api_key_here
Request Body
{
"index_name": "my_index",
"index_key": "64_character_hex_string_representing_32_bytes"
}
Show parameters
Show parameters
Response
{
"index_name": "my_index",
"index_key": "64_character_hex_string_representing_32_bytes",
"index_config": {
"type": "ivfflat",
"dimension": 384
},
"status": "ready",
"vector_count": 10000,
"created_at": "2023-10-01T12:00:00Z"
}
Show response fields
Show response fields
string
Name of the index
string
Encryption key used for the index
object
Configuration details of the index, including:
type: Index type (e.g., ivfflat)dimension: Embedding dimension
string
Current status of the index (e.g., ready, training)
integer
Total number of vectors indexed
string
Timestamp when the index was created
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"
}'
Was this page helpful?
⌘I