API Skill

Updated 

Overview

The API skill allows the dynamic workflow node to interact with external systems through API calls. This skill is essential for fetching, sending and processing data from external systems, enhancing conversational AI's capabilities.

API skill use cases

  • Fetching User Data: Retrieve user details from external applications to personalize the conversation.

  • Order Status Updates: Fetch the latest order status from an external order management system.

  • Third-Party Integrations: Integrate with third-party services like weather updates, news feeds, or CRM systems.

Example

Consider the instance, a user asks for the status of their order via user Input: "What's the status of my order #12345?"

Your dynamic workflow node can use the API skill to send a request to the order management system with the order ID. As an outcome, the system retrieves the order status and responds to the user with the current status.

Configure the API skill

  1. Within your conversational ai application, click on Skills.

  2. Click on Add Skill and select API.

  3. Enter the skill Name and Description.

    Note: Ensure you provide precise information about what is required of the skill under the Description field as it is passed as context to the gpt.

  4. Under Setup Function, select the desired API and the API Endpoint.

  5. Specify the input variables required for the API call under API Input. These can be hardcoded or dynamically populated from custom fields.

  6. Define the Output Variable that will store the response from the API.

  7. Configure error variables to handle any issues during the API call under Error Variable.

  8. Click Save.