Overview

Welcome to the Ejento AI API Documentation

Getting Started

Create Your API Key

Head over to Ejento AI to create your API key. You will need this key to authenticate and interact with the Ejento APIs.

View API key guide →

Access the Server URL

Obtain your designated server URL from the Admin Panel (visible to Global Admins) or contact your Global Admin to provide it to you.

Navigate the Documentation

Use this API documentation to browse API endpoints grouped by functionality in the sidebar. Each page covers endpoint URLs, request parameters, example responses, and error codes.

Use the API Playground

Each API page includes a "Try It" section — input your credentials, set parameters, and fire live requests directly from your browser.

INFO

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.

NOTE

Get an overview of key changes introduced in APIs via our Changelog page

Recommendation

TIP

Always use Stable version of our API documentation for all new integrations to stay current with Ejento AI's most modern and reliable endpoints.

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, utilize the server URL provided by the Admin.

URL format:

https://{server_name}

Replace {server_name} with your actual server name, for example:

https://apim-ejento-prod

When using the "Try It" feature, you must include the following:

1 — Your server URL before the API endpoint:

https://apim-ejento-ai.net/api/v2/agents/{agent_id}

2 — API key in the request header:

Ocp-Apim-Subscription-Key: {your-api-key}

3 — Authorization bearer token in the request header:

Authorization: Bearer {your-access-token}

Setup Guide

Create Your API Key

Head over to the Developer Portal to create your API key. You will need this key to authenticate and interact with the Ejento APIs. Once you've generated your key, make sure to keep it secure — you will include it in your request header when calling APIs.

View the API key guide →

Access the Server URL

To test APIs effectively, you must obtain and correctly configure the Server URL. Follow the instructions below on Ejento AI platform 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

Navigate the Documentation

On the sidebar of this documentation, 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.

Use 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.

Using the Interactive API Playground

Navigate to an API Endpoint for example Get an Agent

1. Click on Try it

2. A. Click on URL icon

B. Click on https://{{your-server-name}} to edit the server name

3. Paste your server name into input box

4. Click on Save & Exit

5. Click on {{your-api-key}}

6. Enter your api key

7. Click on Save & Exit

8. Type in the request parameter value

9. Click on Send

10. The API response is visible underneath

Welcome to the Ejento AI API Documentation#

Getting Started#

Recommendation#

API Base URL#

Setup Guide#

Using the Interactive API Playground#

1. Click on Try it#

2. A. Click on URL icon#

B. Click on https://{{your-server-name}} to edit the server name#

3. Paste your server name into input box#

4. Click on Save & Exit#

5. Click on {{your-api-key}}#

6. Enter your api key#

7. Click on Save & Exit#

8. Type in the request parameter value#

9. Click on Send#

10. The API response is visible underneath#

Welcome to the Ejento AI API Documentation

Getting Started

Recommendation

API Base URL

Setup Guide

Using the Interactive API Playground

1. Click on Try it

2. A. Click on URL icon

B. Click on https://{{your-server-name}} to edit the server name

3. Paste your server name into input box

4. Click on Save & Exit

5. Click on {{your-api-key}}

6. Enter your api key

7. Click on Save & Exit

8. Type in the request parameter value

9. Click on Send

10. The API response is visible underneath