Skip to main content

REST Server for CyborgDB: The Confidential Vector Database

Project description

CyborgDB Service

PyPI - Version PyPI - License PyPI - Python Version

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 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, 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
# Install the CyborgDB Service
pip install cyborgdb-service
  1. Set environment variables
export CYBORGDB_API_KEY=your_api_key_here
export CYBORGDB_DB_TYPE='redis|postgres'
export CYBORGDB_CONNECTION_STRING=your_connection_string_here

# Optional: Configure GPU operations (none, upsert, train, query, all)
# Default is 'none' (CPU only)
export GPU_OPERATIONS='all'             # Enable GPU for all operations
# Or specify specific operations:
# export GPU_OPERATIONS='upsert,train'  # Enable GPU only for upsert and training
# export GPU_OPERATIONS='query'         # Enable GPU only for queries

For connection string examples run cyborgdb-service --help

  1. 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cyborgdb_service-0.13.0.tar.gz (85.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cyborgdb_service-0.13.0-py3-none-any.whl (30.2 kB view details)

Uploaded Python 3

File details

Details for the file cyborgdb_service-0.13.0.tar.gz.

File metadata

  • Download URL: cyborgdb_service-0.13.0.tar.gz
  • Upload date:
  • Size: 85.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for cyborgdb_service-0.13.0.tar.gz
Algorithm Hash digest
SHA256 5155ec4d14c2dbb310df57950db4283cb4d08ace0991d5d4851488f0e53e8597
MD5 3b6075f7454cb071a2b251ac06c57b38
BLAKE2b-256 f1f9f953574c297c18a34391aa278dc74a659146fe51af712137f8bb226a84e6

See more details on using hashes here.

Provenance

The following attestation bundles were made for cyborgdb_service-0.13.0.tar.gz:

Publisher: build_and_package_wheels.yml on cyborginc/cyborgdb-service

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cyborgdb_service-0.13.0-py3-none-any.whl.

File metadata

File hashes

Hashes for cyborgdb_service-0.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a4ef92857dd1fd957d3e793902cf6aeb52ee1777d4fe30121c1f69b0e2bf9c0c
MD5 47356b40ba28d5aa57a58d668ac17c4b
BLAKE2b-256 7886d934a5f1ab2ef63e4653977030ee023221f9e57c5d4d4eead2c39b04fc70

See more details on using hashes here.

Provenance

The following attestation bundles were made for cyborgdb_service-0.13.0-py3-none-any.whl:

Publisher: build_and_package_wheels.yml on cyborginc/cyborgdb-service

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page