API v2 skill

Updated 

Overview

Using the API v2 skills, your Digital twin can interact with external systems. You can define an input, an endpoint and an output variable to grab the required information from the external system and to increase efficiency static and dynamic or a combination of both input types can be defined.

Consider the scenario of an e-commerce brand - A customer reaches out to you to check on the status of an order they had placed. Your Digital Twin will perform the following steps in sequence-

  • Receive the order ID from the customer.

  • Using the API v2 skill, call the API endpoint with the order ID as a parameter

  • Process the response from the API.

  • Display the result (order status in this case) to the customer.

Create an API v2 Skill

  1. Under the Sprinklr Service tab, select Digital Twin Studio within Persona Apps.

  2. On the Digital Twin Studio window, click the Digital Twins icon on the left side of the window

  3. Select the Digital Twin in which you want to add the API v2 skill. The selected Digital Twin window will open.

  4. Navigate to Skills & Tasks and click View.

  5. On the Tasks Manager window, click View Skills.

  6. Select API v2 from the dropdown.

  7. Enter the skill Name and Description.

  8. In the Setup Functions field, select an API and API Endpoint based on the chosen action.

  9. In the Input Variables field, define necessary input variables in API Input and map the input to specific variables in Value to Send to API .

  10. Enter the Output Variable to store the information retrieved from the API.

  11. Enter the Error Variable to capture any error messages from the API.

  12. Enter the Process Output to send the API response to Gen AI, especially if it's in a non-readable format.

  13. Click Save to add the API v2 Skill to your Digital Twin.