Getting an API Key

​

Overview

​

Step-by-Step Guide

1

Sign Up for CyborgDB

Visit cyborgdb.co and create your account.

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

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

2

Choose Your Plan (Optional)

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

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

Plan Disclosure: Paid plans unlock cyborgdb-core with unlimited vectors, GPU acceleration, and all backing stores. Free plans use cyborgdb-lite with usage limitations. You can always start free and upgrade later.

3

Generate Your API Key

Create a new API key from your dashboard.

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

4

Copy and Secure Your API Key

Your API key will be generated and displayed.

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

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

import os
from cyborgdb_core import Client

client = Client(api_key=os.getenv("CYBORGDB_API_KEY"))

from cyborgdb_core import Client

client = Client(api_key="your-api-key-here")

# 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

client = Client(api_key=CYBORGDB_API_KEY)

​

Managing Your API Keys

​

Dashboard Management

• 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