Skip to main content
Client is the main class exposed by the CyborgDB Python SDK. It provides an interface to interact with the CyborgDB vector database service, allowing you to create and manage encrypted indexes.

​
Constructor

Client(base_url, api_key, verify_ssl=None)
Initializes a new CyborgDB Client instance for connecting to a CyborgDB microservice.

​
Parameters

ParameterTypeDefaultDescription
base_urlstr-Base URL of the CyborgDB microservice endpoint
api_keystr-API key for authentication with the microservice
verify_sslboolNone(Optional) SSL verification. When None, automatically disabled for localhost and http:// URLs
You can get an API key from the CyborgDB Admin Dashboard. For more info, follow this guide.

​
Example Usage

from cyborgdb import Client

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

​
Error Handling

The Client class includes comprehensive error handling that processes different types of API errors:
  • HTTP Errors: Status codes and response details are logged and converted to meaningful error messages
  • Validation Errors: Field validation failures are formatted with detailed information
  • Network Errors: Connection and timeout issues are handled gracefully
All methods throw standard Python exceptions with descriptive messages for easier debugging and error handling in your application.

​
Type Safety

The Python SDK provides type hints for better development experience:
  • Type annotations for all method parameters and return values
  • IDE support with autocomplete and type checking
  • Runtime validation of critical parameters