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 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, 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
  1. Set API Key as environment variable
export CYBORGDB_API_KEY=your_api_key_here
  1. [Optional] Set configuration environment variables
export CYBORGDB_DB_TYPE='standalone|redis|postgres'
export CYBORGDB_CONNECTION_STRING=your_connection_string_here

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

  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.15.0.tar.gz (95.5 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.15.0-py3-none-any.whl (32.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cyborgdb_service-0.15.0.tar.gz
  • Upload date:
  • Size: 95.5 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.15.0.tar.gz
Algorithm Hash digest
SHA256 4c197eeb5117a0e4dd5bec9a53c5074868626f2b2431d3f58734e0c34a8b4424
MD5 4dc2add5b3200843bf0cf49dd0a5b4e2
BLAKE2b-256 65c10101917e5c469730fe0f4850060d4d969a6af09ccd1ac8a9c628549f8d3e

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for cyborgdb_service-0.15.0-py3-none-any.whl
Algorithm Hash digest
SHA256 82da2817e49b314b821e5954b7583f77079df79b828b1f80477240d403b2514c
MD5 fdf61f06418b0341583fe5eca0493099
BLAKE2b-256 ff98be902ecfa3dff702f7f1a44a74d6acce2ce882a431d54514bc620a0764c2

See more details on using hashes here.

Provenance

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