Best Practices for Configuring an API in Conversational AI

Updated 

Sprinklr's Conversational AI can seamlessly integrate with APIs, enabling real-time retrieval of information during conversations and assisting customers in resolving their queries.

Prerequisites for Incorporating an API into Conversational AI

  • A detailed description of the API inputs and outputs

  • API’s postman collection or test data

  • User manual or documentation providing insights into the API's functionalities

  • Information detailing the API's authentication mechanism

Checklist to Keep Ready Before Configuring an API

  • API Documentation

  • A file containing request response samples

  • A file containing test data

  • A file containing details of error scenarios

  • List of input and output values for each API

    API Name

    Input Parameters

    Output Parameters

    Customer Details

    {​user_phone_num}​

    {​user_name}​ 

    {​user_email}​ 

    {​user_address}​ 

    {​user_pincode}​ 

    {​current_plan_name}​ 

    {​current_plan_calls}​ 

    {​current_plan_data}​