> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cyborg.co/llms.txt
> Use this file to discover all available pages before exploring further.

# CyborgDB Embedded - Python API Reference

> `v0.18.x`

The Python API for CyborgDB is split into two main classes within the `cyborgdb_core` module:

* `Client` – Handles configuration, index creation/loading, and listing available indexes.
* `EncryptedIndex` – Provides data operations on a specific encrypted index such as upserting vectors, training the index, querying, and retrieving stored items.

## Module-level helpers

Two module-level helpers report on CUDA/GPU support in the current build and environment:

```python theme={null}
def cuda_available() -> bool   # True if a usable CUDA device is present at runtime
def cuda_built() -> bool       # True if this build of cyborgdb_core was compiled with CUDA support
```

```python theme={null}
import cyborgdb_core as cyborgdb

if cyborgdb.cuda_built() and cyborgdb.cuda_available():
    print("GPU acceleration is available.")
```

The module also exports:

* Types: [`StorageConfig`](./types#storageconfig), [`S3Credentials`](./types#s3credentials), [`GPUConfig`](./types#gpuconfig), [`StoragePrecision`](./types#storageprecision), [`KMSBlob`](./types#kmsblob), [`Logger`](./client/logger), `MetadataResult` (the row type returned by [`query_metadata()`](./encrypted-index/query-metadata)).
* KMS functions: [`create_index_kms`, `push_index_kms`, `get_index_kms`, `delete_index_kms`](./kms).
* Embedding helpers: `supported_embedding_models()`, `find_embedding_model(name)`, the `EmbeddingModel` class (`embed_documents()` / `embed_queries()`), and the `EmbeddingModelUnavailable` exception (a `RuntimeError` subclass).
* Datetime helpers: `to_epoch_millis(value)` and `from_epoch_millis(millis)`. Metadata has no native datetime type; `datetime` / `date` values are stored as epoch milliseconds.
* `__version__`.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.