Skip to Content
🇬🇧API Keys

API Keys

API keys are used for authentication when using Alex Code and other CoreSynth services via API.


Overview

ParameterDetails
FormatUUID v4
SecurityAES-256-CBC
ValidityUntil deleted by user
ScopeService-specific
Dashboardhttps://coresynth.io 
API Endpointhttps://api.coresynth.io/v1 

Generating an API Key

Step 1 — Log in to the Dashboard

  1. Log in at coresynth.io 
  2. Go to Account Settings in the dashboard

Step 2 — Create a New Key

  1. Go to the API Keys section
  2. Click “Generate new key”
  3. Enter a name for the key (e.g. “Claude Code”, “Production”)
  4. Select permissions (scopes)
  5. Click “Create”

Step 3 — Save the Key

Warning: The key will be shown only once. Save it immediately to a secure location.


Using API Keys

Claude Code

# Set environment variable export ALEX_CODE_API_KEY="your-api-key-here" # Start Claude Code claude-code

Cursor

// settings.json { "externalAiProviders": { "alexCode": { "apiKey": "your-api-key-here", "endpoint": "https://api.coresynth.io/v1" } } }

OpenCode

# Configuration in ~/.opencode/config.yaml providers: alexCode: api_key: your-api-key-here endpoint: https://api.coresynth.io/v1

VS Code

// settings.json { "alexCode.apiKey": "your-api-key-here", "alexCode.endpoint": "https://api.coresynth.io/v1" }

Windsurf

// windsurf.json { "ai_providers": { "alexCode": { "api_key": "your-api-key-here", "endpoint": "https://api.coresynth.io/v1" } } }

Managing Keys

Viewing Active Keys

In the API Keys section, you will see a list of all keys:

ColumnDescription
NameKey identification
CreatedCreation date
Last UsedLast activity
ActionsDelete, regenerate

Deleting a Key

  1. In the key list, click “Delete” for the respective key
  2. Confirm deletion
  3. The key is immediately deactivated

Regenerating a Key

If a key is compromised:

  1. Delete the existing key
  2. Create a new key
  3. Update configuration in all clients

Security Recommendations

  • Do not store keys in code — use environment variables
  • Use different keys for different environments (dev/prod)
  • Regularly check key activity
  • Delete unnecessary keys — minimize risk
  • Do not share keys — each user should have their own

Scopes (Permissions)

ScopeDescription
alex:readReading server information
alex:writePerforming actions via Alex
alex:codeAccess to Alex Code
billing:readReading invoices and payments

Next Steps


Need help? Open a support ticket .

Last updated on