Overview

Welcome to the Ejento AI V2 Legacy API Documentation

The Legacy APIs are built on earlier architectural patterns and are maintained for compatibility with systems that still rely on them. These APIs provide stable and predictable behavior but may not include the latest features or improvements available in the Latest APIs.

⚠️ Note: Legacy APIs are not recommended for new integrations and are planned to be sunset soon. For new development, please use the Stable APIs.

Why Use Legacy APIs?

Backward Compatibility – Ensures existing integrations continue working without disruption.

Long-Term Support – Maintained for customers with existing dependencies and workflows.

When to Use

Maintaining or supporting existing systems built on earlier Ejento API structures.

Reviewing or updating current integrations that rely on Legacy APIs.

Getting Started

API Base URL

Customizable Server URL : https://{server_name}

Ejento AI gives its customers the ability to use APIs with their own hosted Ejento offering. To call the APIs via your own offering you can utilize the server provided by the Admin.

URL: https://{server_name}

Replace {your-server-name} with your actual server name, for example:
https://apim-ejento-prod

While using the "Try it" feature, you must include
1- Your server URL (https://{your-server-name}) before the API endpoint.
For example, the request will look like:
https://apim-ejento-prod/api/v2/agents/{agent_id}
2- API Key in the headers as:
Ocp-Apim-Subscription-Key: {your-api-key}
3- Authorization Bearer Token in the headers as:
Authorization: Bearer {your-access-token}

Create Your API Key:

First, head over to the Developer Portal to create your API key. You will need this key to authenticate and interact with the Ejento.

You can refer to API key guide

Once you've generated your key, make sure to keep it secure. You will include it in your request header when calling APIs.

Accessing the Server URL

To test APIs effectively, you must obtain and correctly configure the Server URL. Follow the instructions below based on your user role:

For Global Admins:

Navigate to the Admin Panel.

Select API Keys from the menu.

Locate the Server URL — this is your designated server name.

For Regular Users:

Contact your Global Admin to request the Server URL.

Navigating the Documentation:

On the sidebar, you’ll find a list of available API endpoints grouped by functionality. Click on any section to expand it and view details for each API.

Each API page provides information such as the endpoint URL, request parameters, example responses, and error codes.

Using the API Playground:

Once you have your API key, you can use the Playground available within this documentation to try any API in real-time.

Each API page includes a "Try It" section where you can input your server URL {your-server-name}, add your API key Ocp-Apim-Subscription-Key in the headers, include the Authorization: Bearer {your-access-token} header, set parameters, and initiate requests directly from your browser.

View the responses to see how the API behaves, or troubleshoot any issues with your implementation.

Recommendation

Use Legacy APIs only if you are maintaining an existing Ejento integration.

For all new integrations, we highly recommend switching to the V2 Latest APIs for:

Better performance

Improved consistency

Long-term support

For any questions, please our support team.

Welcome to the Ejento AI V2 Legacy API Documentation#

Why Use Legacy APIs?#

When to Use#

Getting Started#

API Base URL#

Create Your API Key:#

Accessing the Server URL#

Navigating the Documentation:#

Using the API Playground:#

Recommendation#