API Keys
What is an API Key?​
An API Key is a unique identifier used to authenticate an application or user when calling an API. It is a secret token required to access certain functionalities within our system, such as fetching analytics data, sending messages, or managing resources.
Types​
When creating an API Key, you can specify its access scope by selecting one of the following types:
- Analytics: Provides access to fetch analytics data for custom use cases or integration with external tools like PowerBI. See available queries
- Use: Grants permissions to Sessions, Message, and Classify endpoints.
- Manage: Allows creation, modification, and deletion of resources such as AI Agents, broadcasts, collections, datasources, desks, and more. View API Documentation
Key Management and Security​
For security reasons, the API Key is only visible once upon creation. Ensure you copy and store it securely. If you lose it, you'll need to generate a new key.
Permissions​
API Keys are managed under the account settings and are accessible exclusively to:
- Admins
- Owners
How to create an API Key​
- Go to Deploy → Developer Tools → API Keys.
- In the card on the right side, set a name to identify the use you will give to the key.
- Select the type of key you want to create.
- Click Create.
warning
The API Key will only be displayed once. Make sure to copy it and store it securely.