Overview

The REST API connector enables your Leena AI Agents to integrate with any third-party service or custom application via their REST API, facilitating flexible data exchange with systems that do not have a dedicated Leena AI connector.

The REST API connector supports standard HTTP operations (GET, POST, PUT, PATCH, DELETE, and more), configurable headers, query parameters, and multiple request body formats. This makes it the universal building block for connecting Leena AI to internal tools, homegrown applications, and any SaaS platform that exposes a REST API.

API Details

Leena AI executes HTTP requests directly against the REST API endpoints you configure. Since this connector is generic, the API documentation to refer to is that of the third-party service or custom application you are integrating with.

Setup

The REST API connector supports eight authentication methods:

Prerequisites

Before setting up the REST API connector, ensure you have:

• The base endpoint(s) and API documentation of the service you want to integrate with
• Valid credentials for the chosen authentication method (username/password, API token, or OAuth client credentials)
• For OAuth-based methods, the ability to register an OAuth application with the third-party provider and to add Leena AI's Redirect URI to it
• Network access from Leena AI to the target API (allowlist Leena AI's IP addresses if the target service restricts inbound traffic)
• Access to your Leena AI workspace with connector management permissions

Get credentials

The credential procurement steps depend on the target service and the chosen authentication method:

For Basic auth: Obtain a username and password (typically a service account) from the target application.

For Bearer token: Generate an API token or personal access token from the target application's developer or security settings.

For OAuth-based methods (OAuth 2.0, OAuth 2.0 client credentials, User OAuth 2.0):

1. Register an OAuth application in the target service's developer console.
2. Note down the Client ID and Client Secret issued for the application.
3. Note down the provider's Authorization URL and Token URL (published in the provider's OAuth/API documentation).
4. Identify the Scopes required for the API operations Leena AI will perform.
5. For the authorization code flows (OAuth 2.0 and User OAuth 2.0), you will add Leena AI's auto-generated Redirect URI to the OAuth application's allowed redirect URIs during connection setup.

For Leena app secret and Leena bot token: No credentials need to be procured — these are managed by the Leena AI platform.

Add connection

Here is how to add a connection on Leena AI:

1. Log in to your Leena AI workspace

2. Navigate to Settings > Integrations

3. Search for "REST API" and select it from the list to add its new connector

4. Start configuring the connector

   1. Auth type: Select one of the supported authentication methods; the remaining fields depend on your selection

5. Fill in the authentication fields based on the selected auth type

   Basic auth:

   Field	Description
   Username	Username for HTTP Basic authentication
   Password	Password for HTTP Basic authentication

   Bearer token:

   Field	Description
   Token	Static token sent as a Bearer Authorization header on every request

   OAuth 2.0:

   Field	Description
   Redirect URI	Auto-generated by Leena AI; copy this URL and add it to your OAuth app configuration
   Authorization URL	OAuth 2.0 authorization endpoint of the provider
   Token URL	OAuth 2.0 token endpoint of the provider
   Client ID	OAuth application client ID
   Client secret	OAuth application client secret
   Scope	Space or comma-separated list of scopes required for API access

   OAuth 2.0 client credentials:

   Field	Description
   Token URL	OAuth 2.0 token endpoint of the provider
   Client ID	OAuth application client ID
   Client secret	OAuth application client secret
   Scope	Space-separated list of scopes required for API access

   User OAuth 2.0:

   Field	Description
   Redirect URI	Auto-generated by Leena AI; copy this URL and add it to your OAuth app configuration
   Authorization URL	OAuth 2.0 authorization endpoint of the provider
   Token URL	OAuth 2.0 token endpoint of the provider
   Client ID	OAuth application client ID
   Client secret	OAuth application client secret
   Scope	Space or comma-separated list of scopes required for API access

   No auth, Leena app secret, Leena bot token: No additional fields are required.

6. Complete the connection setup

   1. For the OAuth 2.0 and User OAuth 2.0 methods, copy the auto-generated Redirect URI into your OAuth application's allowed redirect URIs, then complete the authorization flow when prompted (with User OAuth 2.0, each end user completes their own authorization when they first use a skill backed by this connection)
   2. Save the connector

Actions

The following action is supported for the REST API connector:

Execute REST API

Executes a REST API request via the REST API connector. The Agent can leverage the skill (workflow), which has been designed with the fully configured HTTP request, once the user raises a query that requires it. Here are some common use cases:

• Custom Integrations: Call internal or homegrown application APIs that don't have a dedicated connector
• Data Retrieval: Fetch records from any third-party REST endpoint for use in a workflow
• Data Submission: Create or update records in external systems via POST/PUT/PATCH requests
• File Exchange: Upload files using form data or binary payloads, or download content using non-JSON response types

Input Parameters

Here are the input parameters required to set up this action:

Mandatory

Optional

Body payload fields

Depending on the selected Body format, one of the following payload fields becomes available:

Response

The action returns the response from the target REST API in the selected response type. When "Include response headers in output" is enabled, the response headers are returned alongside the body, allowing downstream workflow steps to use values such as pagination links or rate-limit information.