Documentation

Description

Custom integration is a flexible solution that allows you to connect any API-based data source to Improvado by providing your own credentials. This integration uses our AI Agent in an isolated sandbox environment to implement and test your custom integration before making it available for data extraction and reporting.

How It Works

The custom integration process leverages our AI Agent technology in a secure environment:

1. Credential Entry: You provide your API credentials to the AI Agent
2. Sandbox Implementation: The AI Agent runs your credentials in an isolated sandbox to safely implement the custom integration
3. Data Source Creation: A new custom data source is automatically created based on the successful sandbox implementation
4. API Discovery: Once you create a connection, you can then use the AI Agent to explore available endpoints, test API calls, and understand the data structure

Benefits

• Quick Implementation: Rapidly connect to any API-based data source without waiting for official integration development
• Secure Testing: All implementation occurs in an isolated sandbox to protect your credentials and data
• Guided Exploration: The AI Agent helps you navigate complex APIs through natural language interaction
• Documentation Generation: Automatic creation of documentation for all API requests performed during discovery

Use Cases

The custom integration feature is particularly useful for:

• Connecting to proprietary or internal APIs
• Testing new data sources before requesting official integration support
• Exploring API capabilities without technical knowledge of API structure
• Troubleshooting data discrepancies between platform UI and API-extracted data

‍

Follow our setup guide to connect custom integration to Improvado and use it for API Discovery.

Step 1. To authorize your account, you need to fill in the required fields.

Step 2. After completing the connection process, the new connection will appear in your Connected sources list.

Step 3. When the connection status becomes Active, you can move on to using API Discovery in AI Agent.

Step 3.1. Open the AI Agent chat interface.

Step 3.2. Begin exploring your custom API by asking questions about specific endpoints or data.

Step 3.3. The AI Agent will guide you through the available endpoints and execute test API calls using your credentials.

‍