API Access Keys allow external systems to access the Luma Virtual Agent platform with proper identification and authorization.
To access the create a new API Access Keys, click Settings on the left navigation panel in the Bot Builder.
Navigate to Tenant menu → Settings → API Access Keys
Click Create API Key.
Enter the name for the new Key.
Select the Status for the Key. When a Key is set to Inactive, access from external systems will be denied.
Click Next.
Provide the required permissions on the Permissions page.
Click Create.
Copy the API Access Key for future use.
| Info |
|---|
The API Access Key is displayed only one time, at the time of creation. Once the popup window is closed, the key is never shown again on the user interface. Make sure that you copy and store it securely, to be used in the 3rd party applications. |
Using the API Access Key in the API Request Header
You need to pass the below details as Header Fileds Fields in the API Request.
Tenant External ID: It helps identify the tenant in the Virtual Agent Platform which can be retrieved from the Tenant Information page in the Settings menu.
API Access Key: It helps to identify and authorize the external application.