Training Status

GET

indexes

training-status

Training Status

curl --request GET \
  --url https://api.example.com/v1/indexes/training-status

import requests

url = "https://api.example.com/v1/indexes/training-status"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/v1/indexes/training-status', 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/training-status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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/training-status"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/v1/indexes/training-status")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/indexes/training-status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

Get the current training status including indexes being trained and the retrain threshold configuration.

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

This is a GET request with no request body. Authentication is required via the API key header.

Response

{
  "training_indexes": ["my_index", "semantic_index"],
  "retrain_threshold": 10000,
  "currently_training": "my_index",
  "queued_indexes": ["semantic_index"],
  "worker_running": true,
  "worker_pid": 0,
  "global_training": {}
}

Show response fields

training_indexes

array[string]

List of index names currently being trained or queued for training

retrain_threshold

integer

The multiplier for the retraining threshold. Auto-training triggers when num_vectors > n_lists * retrain_threshold

currently_training

string | null

Name of the index currently being trained, or null if none

queued_indexes

array[string]

List of indexes queued for training (waiting their turn)

worker_running

boolean

Whether the training worker thread is active

worker_pid

integer

(Deprecated) Always 0. Kept for SDK backward compatibility

global_training

object

(Deprecated) Always empty object. Kept for SDK backward compatibility

Training States

Training state is inferred from the currently_training and queued_indexes fields:

If currently_training is non-null, that index is actively being trained
Indexes in queued_indexes are waiting their turn
An index not in either field has completed or has not been trained

Exceptions

401: Authentication failed (invalid API key)
500: Internal server error

Example Usage

Get Training Status:

curl -X GET "http://localhost:8000/v1/indexes/training-status" \
     -H "X-API-Key: cyborg_your_api_key_here"

Monitor Training Progress:

# Check if any indexes are being trained
training_count=$(curl -s -X GET "http://localhost:8000/v1/indexes/training-status" \
     -H "X-API-Key: cyborg_your_api_key_here" | \
     jq '.training_indexes | length')

if [ "$training_count" -gt 0 ]; then
    echo "$training_count indexes are currently being trained"
fi

Wait for Training Completion:

# Poll until specific index training is complete
index_name="my_index"

while true; do
    is_training=$(curl -s -X GET "http://localhost:8000/v1/indexes/training-status" \
         -H "X-API-Key: cyborg_your_api_key_here" | \
         jq --arg idx "$index_name" '.training_indexes | contains([$idx])')
    
    if [ "$is_training" = "false" ]; then
        echo "Training complete for $index_name"
        break
    fi
    
    echo "Still training $index_name..."
    sleep 5
done

Check Retrain Threshold:

# Get the current retrain threshold
threshold=$(curl -s -X GET "http://localhost:8000/v1/indexes/training-status" \
     -H "X-API-Key: cyborg_your_api_key_here" | \
     jq '.retrain_threshold')

echo "Indexes will retrain when vector count exceeds ${threshold}x the initial training size"

Training is automatically triggered when:

An index reaches the configured vector threshold (num_vectors > n_lists * retrain_threshold)
Manual training is requested via the /v1/indexes/train endpoint
The index has never been trained and reaches the minimum vector count

Use this endpoint to avoid querying an index while it’s being trained, as training can temporarily affect query performance.

List Indexes

Upsert Vectors

⌘I

Introduction

Client

Encrypted Index

Types & Getters

Users (RBAC)

Authentication

Request

Response

Training States

Exceptions

Example Usage

​Authentication

​Request

​Response

​Training States

​Exceptions

​Example Usage

Authentication

Request

Response

Training States

Exceptions

Example Usage