API Keys

API keys authenticate your application’s requests to Vocobase. Each key is tied to your account and can be configured with its own limits.

Creating an API Key

1. Navigate to API Keys in the dashboard sidebar
2. Click Create API Key
3. Enter a descriptive name (e.g., “Production App”, “Development”)
4. Set the concurrency limit (optional)
5. Click Create

⚠️ Important: The full API key is only shown once. Copy it immediately and store it securely.

API Key Format

Keys follow this format:

rg_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxx

Key Properties

Concurrency Limit

The maximum number of simultaneous active sessions this key can have.

If you exceed the concurrency limit, new session requests will fail with CONCURRENCY_LIMIT error.

Using Your API Key

In the SDK

<VoiceAgent
  apiKey="rg_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  agentName="my-agent"
/>

Environment Variables

NEXT_PUBLIC_VOCOBASE_API_KEY=rg_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxx

<VoiceAgent
  apiKey={process.env.NEXT_PUBLIC_VOCOBASE_API_KEY!}
  agentName="my-agent"
/>

Security Best Practices

1. Use separate keys for environments — Development, Staging, Production
2. Rotate keys periodically — Create new key, update app, delete old key
3. Never commit keys to version control — Use environment variables
4. Set appropriate concurrency limits — Match your expected usage
5. Monitor for unusual activity — Check usage statistics regularly

Troubleshooting

”Invalid API key”

• Verify the key is copied correctly (no extra spaces)
• Check the key hasn’t been deleted
• Ensure you’re using a rg_live_ prefixed key

”Concurrency limit reached”

• Wait for active sessions to end
• Increase the concurrency limit in the dashboard