CyborgDB REST API Reference

The CyborgDB REST API provides HTTP/HTTPS endpoints for all encrypted vector database operations using standard RESTful principles and JSON responses.

Base URL

Development: http://localhost:8000/v1
Production: https://your-domain.com:8000/v1

Authentication

All endpoints (except /v1/health) require an API key header:

X-API-Key: cyborg_your_api_key_here

You can get an API key from the CyborgDB Admin Dashboard. For more info, follow this guide.

Response Format

Success:

{
  "status": "success",
  "message": "Operation completed successfully"
}

Error:

{
  "status_code": 400,
  "detail": "Error description"
}

Interactive Documentation

Explore the complete API at: http://localhost:8000/docs after starting the service.

Health Check

⌘I

Introduction

Client

Encrypted Index

Types & Getters

CyborgDB REST API Reference

Base URL

Authentication

Response Format

Interactive Documentation

​Base URL

​Authentication

​Response Format

​Interactive Documentation

Base URL

Authentication

Response Format

Interactive Documentation