Overview

Welcome to the Ejento AI REST API Documentation

This documentation allows you to explore and try available APIs for the Ejento platform. Using these APIs, you can integrate Ejento’s capabilities into your own applications.

📘 Looking for step-by-step guides and tutorials?
Visit our Ejento Docs for walkthroughs, usage examples, and how-to articles to help you get started with Ejento AI.

Get an overview of how we manage versions in our APIs in the API Versioning Guide

API Categories in v2

Ejento AI version 2 APIs are organized into two categories based on development lifecycle and feature sets:

Legacy APIs
These APIs are built on earlier architectural patterns and are maintained for systems that rely on stable, consistent behavior. Ideal for maintaining existing integrations.

Access the complete guide to the Legacy APIs overview here.

Latest APIs
The most up-to-date and actively maintained APIs, designed with modern development standards, standardized structures, and more meaningful, intuitive endpoint URLs. Recommended for all new integrations.

Access the complete guide to the Latest APIs overview here.

If you’re beginning a new integration, we highly recommend using the Latest 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 out" 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 Out 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.

Welcome to the Ejento AI REST API Documentation#

API Categories in v2#

Getting Started#

API Base URL#

Create Your API Key:#

Accessing the Server URL#

Navigating the Documentation:#

Using the API Playground:#