How to migrate to our new domain name: cai.tools.sap
This guide helps you migrate to our new domain name cai.tools.sap. This change will not heavily impact your use: the entire platform will continue to work as it does now, we’re only changing our name and URL. You keep your account, your bots, and everything that you’ve created.
For the coming year, the domain name recast.ai will redirect to cai.tools.sap. Very few migrations in your code and in your bots are mandatory. You have one year to migrate. Of course, we encourage you to migrate as soon as you can! If you need any support, we’re ready to help 🙂 Please contact us through our Slack community.
Our platform is now available at this URL: cai.tools.sap. To access the platform, you’ll need to log in the first time. If you saved our URL somewhere (like in a bookmark), please update it.
Our GitHub organization with all our open-source projects and SDKs is now available at github.com/SAPConversationalAI.
Technical migration
Our main domain name is now cai.tools.sap. This means that our platform, API, and documentation use this domain name. If you’re using our API, or if you’ve bookmarked our website, or if you’ve allowed our domain name in a security config file in your backend system, the main migration consists of changing all recast.ai URLs to cai.tools.sap. Making a request to the old domain name will redirect to the new one. So it’s not mandatory to replace it with the new one, but you have to be sure your code supports HTTP redirections.
The detailed tasks that we encourage you to do are explained below.
API & SDKs
If you’re using our SDKs, please migrate to the new ones.
- Remove and install the new ones.
| Old SDK | New SDK | |
| NodeJs | npm install –save recastai | npm install –save sapcai |
| Python | pip install recastai | pip install sapcai |
| PHP | composer require recastai/sdk-php | composer require sapcai/sdk-php |
| Ruby | gem install RecastAI | gem install Sapcai |
| IOS | pod “RecastAI” | pod “sapcai” |
| Android | ai.recast.sdk_android | ai.sapcai.sdk_android |
- Read the README to understand how to use them (exactly the same as the old ones; only the package name has changed). Here’s an example if you’re using the Node.js SDK:
var build = new sapcai.build('YOUR_TOKEN')
build.dialog({'type': 'text', content: 'YOUR TEXT'}, { conversationId: 'CONVERSATION_ID' })
.then(res => {
console.log(res.messages)
// Do your code
})
.catch(err => console.error('Something went wrong', err))
The behavior of the two main endpoints /dialog and /request remains exactly the same. We’ve changed the conversation memory endpoints, so be sure to read the SDK documentation.
If you’re using our API endpoints documented in our API Reference, please update the following:
- Our API Reference is now available at cai.tools.sap/docs/api-reference
- Change the API URL of all endpoints that you’re using; our API URL is now api.cai.tools.sap
Here is an example if you’re using the Bot Builder API to send messages to the SAP Conversational AI platform (Recast.AI) and create a conversation.
Before:
curl -H "Authorization: Token REQUEST_TOKEN" \ -H "Content-Type: application/json" \ -d '{"message": {"content":"Hello","type":"text"}, "conversation_id": "CONVERSATION_ID"}' \ -X POST "https://api.recast.ai/build/v1/dialog"
After:
curl -H "Authorization: Token REQUEST_TOKEN" \ -H "Content-Type: application/json" \ -d '{"message": {"content":"Hello","type":"text"}, "conversation_id": "CONVERSATION_ID"}' \ -X POST "https://api.cai.tools.sap/build/v1/dialog"
If you’re using our Webchat available in the Connect tab, please update the following:
The Webchat script has changed. Please update the code snippet by going to your Webchat configuration in the Connect tab and copying the new script at the same place as the current script on your website.
The change in the script is the URL of the web chat script.
Before:
src="https://cdn.recast.ai/webchat/webchat.js"
After:
src="https://cdn.cai.tools.sap/webchat/webchat.js"
If you’ve cloned our Webchat from GitHub, please make the following changes:
Update the HTTP requests in the code that use our API. The API URL is stored in the config,js, so you only need to update this file as shown below.
Before:
Export default {
apiUrl: 'https://api.recast.ai/connect/v1',
}
After:
Export default {
apiUrl: 'https://api.cai.tools.sap/connect/v1',
}
If you’re using other channels, please follow the below instructions:
If you’ve connected your bot to one of the channels we provide in the Connect tab, you need to update the configuration of each channel as described below.
Facebook Messenger
Update the callback URL in your Facebook page (in the Webhooks section) with the new URL that we provide in your Facebook Messenger channel settings:
Before (example):
https://api.recast.ai/connect/v1/webhook/429f7f41-7cab-4926-90bf-640193c95cdd
After (example):
https://api.cai.tools.sap/connect/v1/webhook/429f7f41-7cab-4926-90bf-640193c95cdd
To enable the update, deactivate and reactivate your page on Facebook.
Slack
Update the redirect URL and the event request URL in your Slack app. To do this, check the configuration steps in the Connect tab on the platform and redo steps 4 and 6.
SAP Jam Collaboration
Update the callback URL on your JAM configuration page. To do this, check the configuration steps in the Connect tab on the platform and redo step 4.
Skype, Microsoft Teams
Update the messaging endpoint in your bot channel registration in Microsoft Azure. To do this, check the configuration steps in the Connect tab on the platform and redo step 3.
Updating everything will ensure your bots will keep operating smoothly! If you have any questions, please join our Slack Community, where our team will be happy to help you smoothly transfer.