OmniDim Logo
    HomeDocumentationCustom API Integration

    Custom API Integration Guide

    Learn how to connect your agent to any external service using Custom API integration.

    1. Overview

    Custom API integration connects your agent to external services through REST APIs, allowing it to fetch data or perform actions using third-party services.

    2. Key Benefits

  1. Access external data sources in real-time
  2. Connect to your own backend services
  3. Integrate with virtually any REST API endpoint
  4. Extend your agent's capabilities with custom functionality

    5. 3. Setup Option 1: From Main Dashboard

  5. Go to Integrations page in your dashboard
  6. Select the All Integrations tab
  7. Find the Custom API card and click Connect
  8. Configure your API (see configuration details below)
  9. Test your configuration in the Test tab
  10. Go to your agent's edit page → Integrations tab
  11. Attach the integration from the dropdown

    12. Connecting from dashboard

    Custom API dashboard integration

    Custom API config in dashboard

    Configuration on dashboard

    4. Setup Option 2: From Agent Configuration

  12. Go to your agent's edit page
  13. Select the Integrations tab
  14. Under Connect New Integrations, find Custom API and click Connect
  15. Configure your API
  16. Test your configuration
  17. The integration will automatically attach to your agent

    18. 5. Setup Option 3: From Chat Interface

  18. Ask in chat using natural language like 'Connect my CRM api' or 'Connect my Airtable api'
  19. A connection widget will automatically appear
  20. Click on Add integration to navigate to the integration tab
  21. Under Connect New Integrations, find Custom API Integration and click Connect
  22. Configure your integration

    23. 6. Configuration Guide - Basic Settings

  23. Integration Name: Choose a descriptive name (e.g., 'Weather API')
  24. Description: Explain the API's purpose and usage (important for LLM tool calling)
  25. URL: Full endpoint URL (e.g., https://api.example.com/data)
  26. Method: Select HTTP method (GET, POST, PUT, DELETE)

    27. 7. Configuration Guide - Headers

  27. Authorization tokens
  28. Content-Type specifications
  29. API keys
  30. Custom headers

    31. 8. Configuration Guide - Parameters

    Specify both query parameters (GET) and body parameters (POST/PUT).

  31. Name: Parameter identifier
  32. Description: Purpose of this parameter
  33. Required: Toggle between optional/required
  34. Data Type: Select from dropdown
  35. AI Generated: Toggle whether the AI should dynamically generate values

    36. Adding query or body parameters

    Parameter configuration

    9. Testing Your Integration

  36. Navigate to the Test tab
  37. Enter test values for all parameters
  38. Click Test API to verify the connection
  39. After successful testing, click Save Integration

    40. Running a test before saving integration

    Testing custom API

    10. Using With Your Agent

  40. Once connected, your agent will automatically use this API when appropriate
  41. Usage is determined based on the API description you provide

    42. 11. Example of Using Custom API

    Example of using Airtable with custom API integration.

    Custom API Airtable integration sample

    Airtable API example

    12. Pro Tips

  42. Provide detailed descriptions for AI-generated parameters
  43. Use specific examples in your descriptions
  44. Test thoroughly before deploying to production