What is the Recommendation API
The Recommendation API is a REST API that allows you and your bots, web sites, and apps to call Conversation Orchestrator capabilities programmatically. You can use the API to ask Conversation Orchestrator for the next best actions (route to skill, KB article, etc) for a concierge bot/app.
A typical use case for using Recommendation APIs is to get a routing decision to transfer to a skill from a Bot or LOB app.
- A brands concierge bot (for example a bot built in Conversation Builder or Google Dialogflow) handles branded greetings, dialogs, and intents.
- It then calls the Recommendation API which evaluates all the policies setup in Dynamic Routing and then returns the next best best action.
- The concierge bot then uses the action (for example route to a skill), to transfer the conversation to that skill in Conversational Cloud.
- This is often used in conjunction with the Context Session Store to pass custom attributes to use in a policy (for example intents). To learn more about how to use the Context Session Store please see documentation.
To use Recommendation APIs you will need to create and use an API key. To get your unique key:
Login to Conversation Orchestrator with your Conversational Cloud credentials and then navigate to Developer Key.
Copy and paste the key you see in the experience and use it in your API headers.
To generate a new key, click on the Regenerate Key button. Please note that this will invalidate the previous key. The key is shared for all Conversation Orchestrator APIs and therefore you will have to use the new key wherever the APIs are being called.