OmniDim Logo
    HomeDocumentationCustom API

    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

  1. Custom API integration allows your agent to connect with any external service, database, or API endpoint.
  2. This enables your agent to fetch real-time data, authenticate users, or perform actions with third-party services during conversations.

    3. 2. Key Benefits

  3. Connect to any REST API endpoint
  4. Real-time data retrieval during conversations
  5. User authentication and verification
  6. Database queries and data management
  7. Third-party service integration
  8. Custom business logic implementation

    9. 3. How to Create Custom API Integration

  9. Navigate to your agent's edit page
  10. Go to the Integrations tab
  11. Under Connect New Integrations, find 'Custom API' and click Connect
  12. Fill in the API configuration details
  13. Test your API endpoint
  14. Save and attach to your agent
    15. 3. How to Create Custom API Integration

    4. Configuration and Testing

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

    5. Example: Supabase User Authentication

    Let's walk through creating a complete Supabase authentication integration step by step.

  22. Add Integration Name and Description
  23. Make sure descriptions are clear and concise. It will help ai to understand the integration and how to use it
  24. Add API URL , HTTP Method , and add the query params for the request
  25. Make sure AI Generated is enabled for the query params , it will help ai to generate the query params from the conversation
  26. Click on next to move to the next step and test your API and save the integration

    27. Supabase custom API integration

    Supabase custom API integration

    Supabase custom API Testing

    Supabase custom API Testing

    6. Other Examples

    Here are additional examples of custom API integrations:

  27. CRM Integration: Retrieve customer data from Salesforce or HubSpot
  28. Inventory Management: Check product availability in real-time
  29. User Verification: Authenticate users against internal databases
  30. Weather Data: Fetch current weather information for location-based services
  31. Booking Systems: Check availability and make reservations

    32. 7. Best Practices

  32. Write clear, descriptive integration names descriptions , query params or body params
  33. Use AI Generated to generate the query params or body params
  34. Test thoroughly with various input values