Alveni AI API Integration Documentation

Alveni AI's API integration feature allows us to extend the functionality of our voice assistants by integrating external APIs, accessing data, and performing specific tasks during or before an AI-powered call. With this guide, you'll be able to see what we need to integrate your API in the Alveni AI platform.

Step-by-Step Breakdown of API Integration Configuration

1. Connect to the API

In this step, we will build the API call by defining key components:

• Method: Choose the appropriate HTTP method for your API call (e.g., GET, POST, PUT, PATCH).
• URL: Specify the API endpoint where the request is sent (e.g., POST request to https://api.example.com/v1/user/profile).

Subsections:

• Body: Define the request body that will be sent. Variables are inserted using <> for dynamic content.
• Headers: Include any necessary headers like Content-Type: application/json.
• Authentication: If authentication is required, toggle the Authorization option to add authentication details (e.g., API key or token).

2. Variables

Variables serve as placeholders filled with data either before or during the call. Two types of variables can be defined:

• Before the Call: Pre-set variables (e.g., {user_phone_number}) to retrieve information such as the caller’s phone number.
• During the Call: These variables are filled with data collected from the user during the call. Specify their type (string, int, phone_number) and add examples for clarity.

3. Set Up Your Integration Details

Define the following required fields for the API integration:

• Name: Provide a concise and clear name for the integration (e.g., "Retrieve User Info").
• Description: A short explanation of what the integration does (e.g., "Fetches user profile details from the external API").
• Speech: Specify what the assistant will say while the integration is running.