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.1.tar.gz (85.2 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.1-py3-none-any.whl (30.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cyborgdb_service-0.13.1.tar.gz
  • Upload date:
  • Size: 85.2 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.1.tar.gz
Algorithm Hash digest
SHA256 a96d1217c1fa710073e5e5f9e3f6463845514cc79038378a706340faf42327fc
MD5 2542baee9e6ad35775e0eca6439565d0
BLAKE2b-256 7d73263127a091b0ad73fac0e88b55f4a73f4edea8f453afe85963440a091556

See more details on using hashes here.

Provenance

The following attestation bundles were made for cyborgdb_service-0.13.1.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.1-py3-none-any.whl.

File metadata

File hashes

Hashes for cyborgdb_service-0.13.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0fc9272b70db413c0a2246c18793d2742d6e6b1f33eb70ff12271ed363c99d16
MD5 933e7b4cbbaa069f612e5437404ecefc
BLAKE2b-256 da85ad955927c80c4644fc74f08f2dc079b52c3732f93c0c2f55bde96d7bfdc8

See more details on using hashes here.

Provenance

The following attestation bundles were made for cyborgdb_service-0.13.1-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