List Indexes

Retrieves a list of all available indexes from the CyborgDB microservice.

async listIndexes(): Promise<string[]>

Returns

Promise<string[]>: A Promise that resolves to an array of index names currently available on the CyborgDB service.

Exceptions

Error

Throws if the API request fails due to network connectivity issues.
Throws if the server returns an HTTP error status.
Throws if authentication fails (invalid API key).

Service Errors

Throws if the CyborgDB service is unavailable or unreachable.
Throws if there are internal server errors on the CyborgDB service.

Example Usage

import { Client } from 'cyborgdb';

const client = new Client('http://localhost:8000', 'your-api-key');

try {
    const indexes = await client.listIndexes();
    console.log('Available indexes:', indexes);
    // Output: ['my_vector_index', 'semantic_search', 'document_embeddings']
} catch (error) {
    console.error('Failed to list indexes:', error.message);
}

Load Index

Upsert

⌘I

Introduction

Client

Encrypted Index

Types & Getters

Returns

Exceptions

Example Usage

​Returns

​Exceptions

​Example Usage

Returns

Exceptions

Example Usage