cyborgdb-service 0.16.1

REST Server for CyborgDB: The Confidential Vector Database

CyborgDB Service

A FastAPI-based REST API wrapper for CyborgDB, providing Confidential Vector DB capabilities over HTTP. It enables you to ingest & search vectors embeddings in a privacy-preserving manner, without revealing the contents of the vectors themselves. CyborgDB works as a standalone database as well as with existing DBs (e.g., Postgres, Redis) and enables you to add, query and retrieve vector embeddings with transparent end-to-end encryption.

Features

• End-to-End Encryption: Vector embeddings remain encrypted throughout their lifecycle, including at search time
• Zero-Trust Design: Novel architecture keeps confidential inference data secure
• High Performance: GPU-accelerated indexing and retrieval with CUDA support (configurable per operation)
• Familiar API: Easy integration with existing AI workflows
• Multiple Backing Stores: Works with PostgreSQL, Redis, S3, and in-memory storage
• Cloud Ready: Supports AWS RDS, AWS ElastiCache, Azure Database for PostgreSQL, Azure Cache for Redis, Google Cloud SQL, and Google Cloud Memorystore

Getting Started

To get started in minutes, check out our Quickstart Guide.

Installation

1. Install cyborgdb-service

pip install cyborgdb-service

2. Set API Key as environment variable

export CYBORGDB_API_KEY=your_api_key_here

3. [Optional] Set configuration environment variables

export CYBORGDB_DB_TYPE='standalone|redis|postgres|s3'
export CYBORGDB_CONNECTION_STRING=your_connection_string_here

Tip: Run cyborgdb-service --help for a detailed list of all configuration options.

4. Run the server

cyborgdb-service

API Key Configuration

You need to provide your API key using any of these methods:

Method 1: Environment Variable (Easiest)

export CYBORGDB_API_KEY=your_api_key_here
cyborgdb-service

Method 2: .env File

Create a .env file in the project root:

CYBORGDB_API_KEY=your_api_key_here

Then run:

cyborgdb-service

Method 3: Inline with Launch

CYBORGDB_API_KEY=your_api_key_here cyborgdb-service

Documentation

For more information on CyborgDB, see the Cyborg Docs.

License

CyborgDB Service is licensed under the MIT License. The underlying library, CyborgDB Core, is licensed under Cyborg's Terms of Service.