Configuring REST API Data Sources

Overview

The REST API integration feature explains how to configure REST API connections within the platform and provides an overview of how Connections support Collections and Workflows. It outlines the steps required to establish secure integrations using Live APIs mode

To enable AI Orchestration, navigate to the Admin section, open Model Settings, and enable the Orchestration option. Once the feature is enabled, users can proceed with the necessary configuration steps within the application.

To configure a REST API integration

Navigate to Add Source.
Select REST API as the source type.

Once a REST API is added as a source, the Settings page displays a Connection Mode option under Basic Information, which provides two options:

Offline – Use this option to create the data source without authentication. This mode is available for AI agents.
Live – Use this option to connect to an external REST API using authentication details.

NOTE: In addition to REST API configurations, predefined sources such as DvSum, Microsoft Teams, and Jira can also be configured from the Data Sources page.

Connection Configuration

After selecting Live APIs, provide the following details:

Base URL – Root endpoint of the external API.
Authentication Type – Select the required authentication mechanism.

Supported authentication methods include:

None
API Key
Basic Auth
Bearer Token
OAuth2 (Client Credentials)
OAuth2 (Password Credentials)

Once the required configuration is completed, use Test Connection to validate the setup before saving.

API Key Configuration

When Authentication Type is set to API Key:

Enter the API Key Name.
Provide the corresponding API Key Value.
Specify placement in either:
- Request Header (e.g., x-api-key)
- Query Parameter (e.g., api-key)

The platform supports configuring multiple API keys within a single connection. Each key can be independently placed in headers or query parameters based on the API requirements.

After entering all required keys, click Test Connection to validate the configuration. Upon successful validation, save the setup.

Basic Authentication

When Authentication Type is set to Basic Auth:

Provide the required Username and Password under the Credentials section.
Use Test Connection to validate authentication.
Save the configuration after successful verification.

Bearer Token Authentication

When Authentication Type is set to Bearer Token:

Specify whether the token should be sent in the Header or as a Query Parameter.
Enter the Bearer Token value.
Adjust the header name or prefix if required.

Validate using Test Connection, then save the configuration.

OAuth2 – Client Credentials

When selecting OAuth2 (Client Credentials):

Provide the Access Token URL.
Enter the Client ID and Client Secret issued by the external service.
Specify whether credentials are transmitted via:
- Authorization Header
- Request Body
Include the required Scope, if applicable.

After completing the fields, use Test Connection to verify authentication and then save the configuration.

OAuth2 – Password Credentials

When selecting OAuth2 (Password Credentials):

Provide the Access Token URL.
Enter the resource owner’s Username and Password.
Provide the associated Client ID and Client Secret.
Select how client credentials should be transmitted (commonly via Authorization Header).

Validate using Test Connection and save the configuration once successful.

Test Endpoint Method

Users can validate the API configuration using the Test Endpoint option by selecting the required HTTP method, providing the endpoint URL, and running Test Connection before saving the source.

There are 6 endpoint method, GET, POST, PUT, PATCH, DELETE & HEAD.

Save & Status

After configuration:

Click Done & Save.
The connection status updates upon successful validation.
Credentials are securely masked after saving.

This completes the REST API Connection setup. The configured connection is now available for use in Collections and Workflows.

In this Article: