Skip to main content
Retrieves a list of all available indexes from the CyborgDB microservice.
client.list_indexes()

Returns

List[str]: A list of strings containing the index names currently available on the CyborgDB service.

Exceptions

  • 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).
  • Throws if the CyborgDB service is unavailable or unreachable.
  • Throws if there are internal server errors on the CyborgDB service.

Example Usage

from cyborgdb import Client

# Initialize client
client = Client(base_url='http://localhost:8000', api_key='your-api-key')

# Get list of all indexes
indexes = client.list_indexes()
print(f"Available indexes: {indexes}")
# Output: ['documents', 'embeddings', 'semantic-search']