API Keys
API keys are used for authentication when using Alex Code and other CoreSynth services via API.
Overview
| Parameter | Details |
|---|---|
| Format | UUID v4 |
| Security | AES-256-CBC |
| Validity | Until deleted by user |
| Scope | Service-specific |
| Dashboard | https://coresynth.io |
| API Endpoint | https://api.coresynth.io/v1 |
Generating an API Key
Step 1 — Log in to the Dashboard
- Log in at coresynth.io
- Go to Account Settings in the dashboard
Step 2 — Create a New Key
- Go to the API Keys section
- Click “Generate new key”
- Enter a name for the key (e.g. “Claude Code”, “Production”)
- Select permissions (scopes)
- 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-codeCursor
// 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/v1VS 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:
| Column | Description |
|---|---|
| Name | Key identification |
| Created | Creation date |
| Last Used | Last activity |
| Actions | Delete, regenerate |
Deleting a Key
- In the key list, click “Delete” for the respective key
- Confirm deletion
- The key is immediately deactivated
Regenerating a Key
If a key is compromised:
- Delete the existing key
- Create a new key
- 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)
| Scope | Description |
|---|---|
alex:read | Reading server information |
alex:write | Performing actions via Alex |
alex:code | Access to Alex Code |
billing:read | Reading invoices and payments |
Next Steps
- Alex Code — Standalone AI service
- API Integration — Technical documentation
Need help? Open a support ticket .
Last updated on