API Integrations

Understanding API Integrations

Auralytik provides two ways to connect to external APIs:

Managing API Credentials

Store and manage authentication credentials securely for your API connections.

Accessing Credentials

1. Navigate to AI Integrations from the sidebar
2. Select the Credentials tab
3. View, create, or edit credentials

Authentication Types

Creating Credentials

1. Click "Add Credential"
2. Enter a descriptive name (e.g., "CRM Production API")
3. Select the authentication type
4. Enter the credential values
5. Click "Save"

Creating API Integrations

Full API integrations allow you to configure multiple endpoints with advanced features.

Creating an Integration

1. Navigate to AI Integrations → Integrations
2. Click "Create Integration"
3. Enter integration details:
   • Name (e.g., "Customer CRM")
   • Base URL (e.g., "https://api.crm.com/v1")
   • Default headers
   • Authentication method
4. Add endpoints
5. Save the integration

Configuring Endpoints

Each integration can have multiple endpoints:

Endpoint: Get Customer
Method: GET
Path: /customers/{customerId}
Parameters:
  - customerId (path): Customer identifier

Endpoint: Update Customer
Method: PATCH
Path: /customers/{customerId}
Parameters:
  - customerId (path): Customer identifier
  - body (JSON): Update payload

Advanced Authentication

Full integrations support advanced authentication methods:

Using APIs in Flows

Use the ApiCall step in your flows to interact with external APIs.

ApiCall Step Configuration

1. Add an ApiCall step to your flow
2. Select the integration and endpoint
3. Map flow variables to API parameters
4. Map API response fields to flow variables

Parameter Mapping

Map data from your dataset or flow variables to API parameters:

// API endpoint: GET /customers/{customerId}
// Parameter mapping:
customerId → {{row.customer_id}}

// API endpoint: POST /appointments
// Body mapping:
{
  "customer_id": "{{row.customer_id}}",
  "date": "{{extracted.preferred_date}}",
  "time": "{{extracted.preferred_time}}",
  "notes": "{{ai_classification}}"
}

Response Mapping

Extract data from API responses to use in subsequent steps:

// API Response:
{
  "customer": {
    "name": "Juan Garcia",
    "balance": 150000,
    "status": "active"
  }
}

// Response mapping:
customer_name → response.customer.name
customer_balance → response.customer.balance
customer_status → response.customer.status

Error Handling

Configure how to handle API errors:

• Continue: Proceed with flow even if API fails
• Retry: Retry the request with backoff
• Fail: Mark the row as failed
• Branch: Route to an error handling branch

Using APIs in Voice Actions

Make real-time API calls during voice conversations to provide dynamic information.

Configuring API Voice Actions

1. In your VoiceCall step, go to Actions
2. Add an ApiCall action
3. Select the integration and endpoint
4. Define parameters the AI should collect from the caller
5. Configure the response template for the AI to speak

Real-Time API Example

// Action: check_balance
// Description: Look up customer account balance
// Parameters:
//   - account_number: Customer's account number

// AI during call:
"Could you please provide your account number?"
[Customer: "1234567"]
// AI triggers API call with account_number=1234567

// Response template:
"Your current balance is {{response.balance}} pesos.
 Your next payment of {{response.next_payment}} is due on
 {{response.due_date}}."

Learn More

For complete details on voice action configuration:Voice Actions Guide →