API Keys are unique identifiers used to help authenticate connection requests to a particular project or other Soul Machines APIs. This section describes how to create, and use your API Key for the Soul Machines platform.
The API keys view screen can be accessed from the Settings cog > API Keys on the top right-hand corner of the screen.
Creating New API Keys
To create a new API Key, click Create API Key on the top-right of the screen. API keys can be generated for two purposes:
Web - used to connect your Digital Person project to your custom UI or embed the Digital person in to your website
Analytics - used to connect to the Insights API
Once your API Key is generated, you can view it at any point on the API Keys view screen.
Viewing API Keys
Once you click on API Keys, you will see a view of all active API keys you created, the project it's assigned to, and the scope.
If you are logged in as an Owner, Support, or Analytics user, you can view all the API keys generated within the organization.
User Contol Icons
Icon | Description |
|---|---|
 | Sort the API keys by scope or creation date. |
 | View details of the API key. Depending on the scope the details may vary. |
 | Edit API keys. The API key edit option is available only for WebAPI keys. |
 | Revoke/delete API Key. |
 | Copy the generated API Key. The Analytics API key is viewable only during creation. If you have lost the Analytics API key you will need to create a new one. |
Revoke API Key
You should revoke an API key immediately if it becomes inactive, lost, or compromised. Once you revoke the API key, any integration using it will stop working immediately, and it is not possible to reissue a revoked API key. You can create a new API key if you need to reconnect with the API.
To revoke an API key:
Go to the settings cog icon on the top right corner of the screen and select API Keys.
Select the API key that you wish to revoke and click the delete icon against it.
Click Yes, Delete to confirm.
Notes:
If a key expires, it will automatically be revoked.
If the project is deleted, all the API keys associated with the project are also revoked.
If the organization is deleted, all API keys created for the organization are revoked.
Editing Web API Keys
You may sometimes need to add or edit trusted domains of the WebAPI keys without changing the key itself. Click on the edit icon on the API Key Management page.
The Update API Key page allows you to edit the name, toggles, and UI domains.
Contents