Stay organized with collectionsSave and categorize content based on your preferences.
TheCredential managementsection is available in the CCAI Platform portal, go
toSettings > Developer Settings > API.
Use your Contact Center AI Platform (CCAI Platform)subdomain(without the https://) as the
username. For example, if the URL you visit ishttps://NAME.ccaiplatform.comthen the subdomain value
for your username isNAME.
Create as many API credentials as you need for internal use.
Depending on the integrations you have, you might already see
API credentials configured for advanced reporting, or others.
If you lose or forget your token, you cangenerate a new token.
Be sure to store the token in a secure location.
The API credential management settings allow you to:
Add new API credentials.
Disable or enable credentials.
Regenerate the secret token.
Edit the name of an existing credential.
To add an API credential, follow these steps:
In the CCAI Platform portal, go toSettings > Developer Settings.
Go to theAPI Credentialpane.
Click+ Add API Credentialbutton. TheAdd API Credentialdialog appears.
Enter a name, and then clickCreate. Your new token appears.
This token does not appear again, so be sure to store it in a secure place.
Rename an API credential
To rename an API credential, follow these steps:
In the CCAI Platform portal, go toSettings > Developer Settings.
Go to theAPI Credentialspane.
ClickeditEditnext to
the credential that you want to rename.
Rename the credential, and then clickDone.
Regenerate a token
To regenerate the token for a credential, follow these steps:
In the CCAI Platform portal, go toSettings > Developer Settings.
Go to theAPI Credentialpane.
ClickrefreshRefreshnext to the
credential that you want to generate a new token for. AWarning* dialog
appears.
In theWarningdialog, clickRegenerateif you're sure that you
want to continue. Your new token appears. This token does not appear again,
so be sure to store it in a secure place.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[[["\u003cp\u003eAPI credentials in the CCAI Platform are managed under \u003cstrong\u003eSettings > Developer Settings > API\u003c/strong\u003e, where you can add, disable, enable, regenerate, or edit credentials.\u003c/p\u003e\n"],["\u003cp\u003eYour CCAI Platform subdomain, found in your platform URL, serves as your username for API credential access.\u003c/p\u003e\n"],["\u003cp\u003eYou can create multiple API credentials to accommodate internal needs or integrate with third-party applications.\u003c/p\u003e\n"],["\u003cp\u003eWhen creating or regenerating API credentials, the generated token is only shown once and should be stored securely as it won't be visible again.\u003c/p\u003e\n"],["\u003cp\u003eExisting credentials are able to be renamed and are listed in the API Credential pane.\u003c/p\u003e\n"]]],[],null,["# API credential management\n\nThe **Credential management** section is available in the CCAI Platform portal, go\nto **Settings \\\u003e Developer Settings \\\u003e API**.\n\nUse your Contact Center AI Platform (CCAI Platform) **subdomain** (without the https://) as the\nusername. For example, if the URL you visit is\n`https://`\u003cvar translate=\"no\"\u003eNAME\u003c/var\u003e`.ccaiplatform.com` then the subdomain value\nfor your username is \u003cvar translate=\"no\"\u003eNAME\u003c/var\u003e.\n\n**Create as many API credentials as you need for internal use.**\n| **Note:** Some third-party integrations require the creation of API credentials.\n\nDepending on the integrations you have, you might already see\nAPI credentials configured for advanced reporting, or others.\n\nIf you lose or forget your token, you can [generate a new token](#generate).\nBe sure to store the token in a secure location.\n\nThe API credential management settings allow you to:\n\n- Add new API credentials.\n\n- Disable or enable credentials.\n\n- Regenerate the secret token.\n\n- Edit the name of an existing credential.\n\nTo add an API credential, follow these steps:\n\n1. In the CCAI Platform portal, go to **Settings \\\u003e Developer Settings**.\n\n2. Go to the **API Credential** pane.\n\n3. Click **+ Add API Credential** button. The **Add API Credential**\n dialog appears.\n\n4. Enter a name, and then click **Create**. Your new token appears.\n This token does not appear again, so be sure to store it in a secure place.\n\nRename an API credential\n------------------------\n\nTo rename an API credential, follow these steps:\n\n1. In the CCAI Platform portal, go to **Settings \\\u003e Developer Settings**.\n\n2. Go to the **API Credentials** pane.\n\n3. Click edit **Edit** next to\n the credential that you want to rename.\n\n4. Rename the credential, and then click **Done**.\n\nRegenerate a token\n------------------\n\nTo regenerate the token for a credential, follow these steps:\n\n1. In the CCAI Platform portal, go to **Settings \\\u003e Developer Settings**.\n\n2. Go to the **API Credential** pane.\n\n3. Click refresh **Refresh** next to the\n credential that you want to generate a new token for. A *Warning*\\* dialog\n appears.\n\n4. In the **Warning** dialog, click **Regenerate** if you're sure that you\n want to continue. Your new token appears. This token does not appear again,\n so be sure to store it in a secure place."]]
