Ejento AI
Guides
QuickstartRecipesREST APIsRelease NotesFAQs
Guides
QuickstartRecipesREST APIsRelease NotesFAQs
Ejento AI
  1. Features
  • Basic Operations
    • Features
      • Teams → Projects → Assistants Hierarchy
    • Guides
      • Login/Signup
  • Assistants
    • Features
      • Introduction to Assistants
      • Assistant Access Control
      • Caching Responses for Assistants
      • Assistant Evaluation
      • Evaluation Metrics
      • URL-based Chat Thread Creation and Prepopulation
      • Reasoning Patterns
    • Guides
      • Add Assistant
      • Evaluate Assistant
      • Edit Assistant
      • Embed Assistant
      • Delete Assistant
      • Add Favourite Assistants
      • View Assistant Id
      • View Dataset Id
  • Corpus
    • Features
      • Introduction
      • Corpus Permissions
      • PII Redaction
    • Guides
      • Assistant Corpus Setup
      • Assistant Corpus Settings
      • Corpus Access Control
      • Corpus Connections
      • ETag Setup for Corpus Incremental Refresh
      • View Corpus Id
      • View Document Id
      • Tagging
        • Corpus tagging
        • Document tagging
  • Teams
    • Features
      • Introduction
    • Guides
      • Add a Team
      • Edit a Team
      • Delete a Team
      • View Team Id
  • Projects
    • Features
      • Introduction
    • Guides
      • Add a Project
      • Edit a Project
      • Delete a Project
      • View Project Id
  • User Settings
    • Features
      • Introduction
      • Ejento AI User Access Levels
    • Guides
      • Assistant Edit Access
      • Add new user
      • Add User in a Team
      • Remove User from a Team
      • View my Access level in a Team
      • View my User Id
  • API Keys
    • Features
      • Introduction
    • Guides
      • How to generate API Key and Auth Token
  • Workflows
    • Features
      • Introduction
    • Guides
      • Add Workflow
      • Workflow Chat
  • Tools
    • Features
      • Introduction
    • Guides
      • Tools Overview
      • Create External Tool
      • Connect Tool to Assistant
  • Analytics
    • Features
      • Introduction
    • Guides
      • Analyzing Data in the Analytics Dashboard
  • Chatlogs
    • Features
      • Introduction
    • Guides
      • Managing Chatlogs
      • View Chatlog & Chat thread Id
  • Integrations
    • Features
      • Introduction
    • Guides
      • Email Indexing
      • Microsoft Teams
      • Sharepoint Indexing
      • MS Teams Integration Setup
      • Creating a Connection in Credential Manager
  • Ejento AI Shield
    • Features
      • Introduction
      • Understanding Guardrails
    • Guides
      • How to enable Guardrails
  • Assistant Security
    • Features
      • Introduction
      • Assistant Red Teaming
    • Guides
      • Red Team an Assistant
Guides
QuickstartRecipesREST APIsRelease NotesFAQs
Guides
QuickstartRecipesREST APIsRelease NotesFAQs
Ejento AI
  1. Features

Introduction

Ejento AI provides a comprehensive set of REST APIs that enables developers to programmatically interact with assistants, manage projects, access corpora, and integrate Ejento's capabilities into their own applications. To use these APIs securely, you'll need to authenticate your requests using API keys.

What are API Keys?#

API keys are unique authentication credentials that allow you to securely access Ejento's APIs. Each key acts as a secure identifier that verifies your identity and determines what operations you're authorized to perform within the system.

Why API Keys Matter#

API keys serve several critical functions:
Authentication: Verify your identity when making API requests
Authorization: Control access levels through permission scopes (All, Read Only, or Restricted)
Security: Protect your account and data from unauthorized access
Tracking: Monitor API usage and troubleshoot integration issues

Getting Started#

To use Ejento's APIs, you'll need three essential components:
1.
Server URL: Your organization's base URL for API requests (e.g., https://your-server-name)
2.
API Key: A secret key with defined permission scopes to include in request headers.
3.
Authorization Token: A Bearer token to include in request headers

API Documentation#

All Ejento APIs are available and documented at api.ejento.ai, where you can:
Explore available endpoints and their parameters
View request and response examples
Test APIs directly in the interactive playground
Access comprehensive API reference documentation

Permission Scopes#

When creating an API key, you can assign one of three permission levels:
All: Full access to all API endpoints and operations
Read Only: Limited to GET requests across all categories
Restricted: Granular category-level permissions (None, Read, or Write for each API category)
This flexible permission system ensures you can grant the minimum necessary access for each use case, following the principle of least privilege.
Ready to create your first API key? Follow the step-by-step guide in the How to generate API Key and Auth Token tutorial to generate your credentials and start integrating with Ejento AI.
Previous
API Keys
Next
How to generate API Key and Auth Token