Skip to main content

​
What are API keys?

API keys let you interact with Sonara programmatically. Use them to create agents, start calls, manage knowledge bases, and more through the Sonara API.

​
Creating an API key

1

Navigate to API Keys

From the dashboard sidebar, click API Keys.
2

Click Create Key

Click the Create API Key button.
3

Configure the key

Provide:
  • Name - A descriptive name (e.g., “Production”, “Development”, “CI/CD”)
  • Scopes - Select which permissions this key should have
  • Rate limits - Set requests per minute and per day limits
  • Expiration (optional) - Set an expiration date for the key
4

Copy your key

After creation, the full API key is displayed once. Copy it immediately and store it securely - you won’t be able to see the full key again.
Treat your API keys like passwords. Never share them publicly, commit them to version control, or expose them in client-side code.

​
Managing API keys

​
Key list

The API Keys page shows all your keys with:
  • Key name
  • Key prefix (for identification)
  • Status (Active, Revoked, Expired)
  • Last used date

​
Key details

Click any key to see its full details:
  • Scopes and permissions
  • Rate limit configuration
  • Total usage count
  • Creation date
  • Last used timestamp

​
Editing a key

You can update a key’s name at any time. Scopes and rate limits cannot be changed after creation - create a new key if you need different settings.

​
Revoking a key

Click Revoke to immediately disable a key. Revoked keys can no longer authenticate API requests. This action cannot be undone.

​
Deleting a key

Click Delete to permanently remove a key from your account. This cannot be undone.
API access is available on the Pro plan and above.