Custom API Integration Guide
Learn how to create and configure custom API integrations to extend your agent's capabilities with external services and databases.
1. Overview
- Custom API integration allows your agent to connect with any external service, database, or API endpoint.
- This enables your agent to fetch real-time data, authenticate users, or perform actions with third-party services during conversations.
2. Key Benefits
- Connect to any REST API endpoint
- Real-time data retrieval during conversations
- User authentication and verification
- Database queries and data management
- Third-party service integration
- Custom business logic implementation
3. How to Create Custom API Integration
- Navigate to your agent's edit page
- Go to the Integrations tab
- Under Connect New Integrations, find 'Custom API' and click Connect
- Fill in the API configuration details
- Test your API endpoint
- Save and attach to your agent

4. Configuration and Testing
- Integration Name: Enter a descriptive name (e.g., 'Supabase Authentication')
- Description: Provide clear description of what the API does and when to use it
- API URL: Enter the complete endpoint URL
- HTTP Method: Select GET, POST, PUT, or DELETE
- Click 'Add Header' to include required headers
- Add body params or query params if needed
- Click on next to move to the next step and test your API and save the integration

5. Example: Supabase User Authentication
Let's walk through creating a complete Supabase authentication integration step by step.
- Add Integration Name and Description
- Make sure descriptions are clear and concise. It will help ai to understand the integration and how to use it
- Add API URL , HTTP Method , and add the query params for the request
- Make sure AI Generated is enabled for the query params , it will help ai to generate the query params from the conversation
- Click on next to move to the next step and test your API and save the integration
Supabase custom API integration

Supabase custom API Testing

6. Other Examples
Here are additional examples of custom API integrations:
- CRM Integration: Retrieve customer data from Salesforce or HubSpot
- Inventory Management: Check product availability in real-time
- User Verification: Authenticate users against internal databases
- Weather Data: Fetch current weather information for location-based services
- Booking Systems: Check availability and make reservations
7. Best Practices
- Write clear, descriptive integration names descriptions , query params or body params
- Use AI Generated to generate the query params or body params
- Test thoroughly with various input values