Getting an API Key

An API key is optional. Without one, CyborgDB runs in free tier with a limit of 1,000,000 items per index. A paid API key removes that limit. This guide walks you through signing up and generating an API key.

Overview

CyborgDB offers both free and paid API keys:

Free API Key

Perfect for evaluation and testing

Up to 1M items per index
Community support

Paid API Key

Full production capabilities

Unlimited items per index
Priority support

Step-by-Step Guide

Visit cyborgdb.co and create your account.

Click “Sign Up” in the top navigation
Enter your email address and create a secure password
Verify your email address by clicking the link sent to your inbox
Complete your profile setup

Your account starts with access to free API keys by default.

Choose Your Plan (Optional)

If you need production capabilities, upgrade to a paid plan.

Navigate to the “Billing” section in your dashboard
Review the available plans and features
Select the plan that best fits your needs
Complete the payment setup

Plan Disclosure: Paid plans remove the 1M item limit per index. Free plans and keyless use have a 1M item limit per index. You can always start free and upgrade later.

Generate Your API Key

Create a new API key from your dashboard.

In your CyborgDB dashboard, locate the “API Keys” section
Click the “Add” button next to “API Keys”

Screenshot of CyborgDB Dashboard with API Keys 'Add' button highlighted — CyborgDB Dashboard - API Keys Section

Copy and Secure Your API Key

Your API key will be generated and displayed.

Screenshot of CyborgDB Dashboard showing generated API key — CyborgDB Dashboard - API Key Generated

Important: Copy your API key immediately and store it securely. For security reasons, you won’t be able to see the full key again after leaving this page.

Best Practices:

Store your API key in environment variables, not in your code
Never commit API keys to version control
Use different keys for development and production environments
Rotate keys regularly for enhanced security

Using Your API Key

Once you have your API key, you can use it with any CyborgDB deployment.

With CyborgDB Service, the API key is set on the server as CYBORGDB_API_KEY. Client SDKs do not send this key; when authentication is enabled, they authenticate to the service with the service root key or a per-user token. See Environment Variables.

With the embedded library, pass it to Client:

Environment Variable (Recommended)
Direct Usage
Configuration File

Set your API key as an environment variable:

export CYBORGDB_API_KEY="your-api-key-here"

Then reference it in your code:

import os
from cyborgdb_core import Client, StorageConfig

client = Client(
    api_key=os.getenv("CYBORGDB_API_KEY", ""),
    storage_config=StorageConfig.disk("/var/lib/cyborgdb"),
)

Use your API key directly in your code (not recommended for production):

from cyborgdb_core import Client, StorageConfig

client = Client(
    api_key="your-api-key-here",
    storage_config=StorageConfig.disk("/var/lib/cyborgdb"),
)

Store in a configuration file that’s excluded from version control:

# config.py (add to .gitignore)
CYBORGDB_API_KEY = "your-api-key-here"

# main.py
from config import CYBORGDB_API_KEY
from cyborgdb_core import Client, StorageConfig

client = Client(
    api_key=CYBORGDB_API_KEY,
    storage_config=StorageConfig.disk("/var/lib/cyborgdb"),
)

Managing Your API Keys

Dashboard Management

From your CyborgDB dashboard, you can:

View all API keys - See all keys associated with your account
Create new keys - Generate additional keys for different projects
Revoke keys - Disable keys that are no longer needed
Monitor usage - Track API key usage and performance

Next Steps

Start Building

Jump into the quickstart guideUse your new API key to get started with CyborgDB

Choose Deployment

Service vs EmbeddedDecide between CyborgDB Service or Embedded libraries

Framework Integration

LangChain integrationReplace your existing vector store with CyborgDB

Got your API key? You’re ready to start building confidential AI applications!

CyborgDB Docs

Getting Started

Security

Resources

Overview

Free API Key

Paid API Key

Step-by-Step Guide

Using Your API Key

Managing Your API Keys

Dashboard Management

Next Steps

Start Building

Choose Deployment

Framework Integration

​Overview

Free API Key

Paid API Key

​Step-by-Step Guide

​Using Your API Key

​Managing Your API Keys

​Dashboard Management

​Next Steps

Start Building

Choose Deployment

Framework Integration

Overview

Step-by-Step Guide

Using Your API Key

Managing Your API Keys

Dashboard Management

Next Steps