Custom API Integration

Connect custom APIs and external services to extend your AI Agent’s capabilities.

Introduction

The Custom API integration allows you to connect any external service with a REST API to your LiveTok AI Agent. This enables you to integrate proprietary systems, internal tools, and services that don’t have native LiveTok integrations.

Purpose: Provide a flexible way to connect any REST API to your AI Agent, enabling custom integrations with internal systems, proprietary software, and specialized tools.

Motivation: Many businesses have custom systems, internal APIs, or specialized services that need to be integrated with their AI Agent. The Custom API integration provides a standardized way to connect these services without requiring native integration support.

Capabilities

Custom API Connections

Connect any REST API endpoint to your AI Agent, enabling it to make API calls during conversations. This allows the AI to interact with external systems, retrieve data, and perform actions through custom APIs.

Flexible Tool Definition

Define custom tools with specific endpoints, HTTP methods, headers, and parameters. Each tool can be configured with its own authentication, request format, and response handling.

Multiple Tool Support

Configure multiple API tools within a single integration, allowing your AI Agent to interact with multiple external services or endpoints.

Configuration

Prerequisites

• API endpoint URL
• API authentication method (API key, Bearer token, Basic auth, etc.)
• Understanding of API request/response format
• API documentation for endpoints you want to use

Connect Custom API

1. Prepare API Information

   • Identify the API endpoints you want to connect
   • Note the required authentication method
   • Gather any required API keys or credentials
   • Understand the request/response format

2. Configure in LiveTok

   • Go to Dashboard > Connect
   • Find Custom API in the available tools
   • Click Configure

3. Add Tools

   • Click Add Tool for each API endpoint you want to connect
   • For each tool, configure:
     • Tool ID: Unique identifier for the tool
     • Tool Name: Display name for the tool
     • URL: The API endpoint URL
     • Description: Description of what the tool does
     • Headers: HTTP headers (e.g., Authorization, Content-Type)
     • Parameters: Input parameters the tool accepts (name, type, description)

4. Save Configuration

   • Review all configured tools
   • Click Save

5. Verify Connection

   • Check that Custom API is listed under “Configured Tools”
   • Test by using one of the configured tools in a conversation

Configuration Settings

For each tool:

• Tool ID: Unique identifier (e.g., get_user_info)
• Tool Name: Display name (e.g., “Get User Information”)
• URL: API endpoint URL
• Description: What the tool does
• Headers: Array of key-value pairs for HTTP headers
• Parameters: Array of parameters with name, type (string/number/boolean/string[]), and description

Once configured, your AI Agent can use the custom API tools during conversations to interact with your external services.