Welcome to Ejento!
This guide provides a comprehensive roadmap for working with Ejento APIs, covering everything from setup to advanced features.

Each API listed here comes with a direct link to its detailed documentation, where you can explore full request/response formats and advanced options.
Please note that this guide highlights only the key APIs for getting started. In the sidebar, you’ll find all categories with their complete set of APIs, organized for deeper exploration.

By following this guide, you can efficiently build and scale AI-powered applications with confidence and clarity.

Before You Start
To use Ejento APIs, you’ll need:

The server base URL

Your API key passed in the request headers

Your Authorization Bearer token passed in the request headers

For details, please refer to the API Overview. Or you can directly go to the API key guide to get your keys, auth token, and server URL.
Once set up, you can return here and start using any API right away.

1. Authentication & User Setup

Before anything else, secure your app with user authentication. Ejento provides flexible APIs for registration, login, tokens, and profiles.

Register User – Create a new user in your app.

Login (Exchange Credentials) – Validate credentials and issue access tokens.

Refresh Access Token – Refresh tokens to maintain sessions securely.

Passwordless Authentication – Allow login without passwords (e.g., via magic links).

Get Authenticated User – Retrieve the profile of the logged-in user.

Get All Users – Retrieve a list of all registered users in your organization.
Useful for admin dashboards, role management, or analytics, where you need visibility into the complete user base.

Result: Your users can now register, log in, and securely access your app.

2. Organizing Teams & Projects

Ejento lets you structure workspaces for your apps using Teams and Projects.
Ejento uses a hierarchical model:

Team → Project → Assistant

Team: A group of users (e.g., your company or department).

Project: A workspace inside a team for a specific app or use case.

Assistant (Agent): An AI chatbot that lives inside a project.

Step 1: Create a Team

Create Team – Start by creating a new team.

Add Users to Team – Invite collaborators into the team.

Step 2: Create a Project within the Team

Create Project – Set up a new project inside your team.

Add Users to Project – Assign project-specific members.

Step 3: Prepare for Assistants

Once your project is ready, you can move on to creating your Assistants (Agents) inside that project.

Result: You now have a properly organized environment where assistants can be created and managed within projects, and projects are grouped under teams.

3. Creating Your Assistant (Agent)

The heart of your app is an Assistant (Agent) – an AI entity that chats with users.

Create Agent – Spin up a brand-new assistant.

Get Agent – Fetch full details of your agent.

Add User to Agent – Assign users to a specific agent so they can start interacting with it.

Custom Instructions – Personalize your assistant with instructions and behavior rules.

Link Agent to Tool – Connect your assistant with a specific tool (e.g., web search, RAG, external APIs, or other custom tools you create). Once linked, the agent can use that tool while generating responses, enabling richer and more powerful conversations tailored to your use case.

Result: Your assistant is created and ready to be trained.

4. Knowledge Base (Corpus & Documents)

To make your assistant smart, you need to feed it knowledge.

Create Corpus – Set up a knowledge base for your app.

Upload Document – Add knowledge to your assistant by uploading files such as PDFs, text files, Word docs, or other supported formats.
This API takes your document, processes its content, and stores it inside the selected Corpus. Once uploaded, the assistant can reference the document in conversations, giving users precise, context-aware answers.

Get All Documents for Corpus – Retrieve a list of all documents added to a corpus, making it easier to manage and verify uploaded knowledge sources.

Agent–Corpus Connection – Link your agent with a corpus so it can answer using your data.

Result: Your assistant now has access to your organization’s knowledge base.
It can read from your uploaded documents and use that content to provide accurate, contextual, and domain-specific answers. This means your assistant goes beyond generic responses and becomes a true expert on your company’s data.

5. Conversations & Chat Threads

Now, let’s enable real user conversations.

Create Chat Thread – Start a new conversation thread with your agent.

Agent Response (Send Message) – Post a message and receive the agent’s reply.

Get Agent Response – Retrieve specific agent replies by ID.

Get Chat Logs – Access full history of a chat session.

Result: Your users can chat with the assistant, and you can store complete conversations.

6. Feedback & Ratings

Collect insights to improve your assistant’s performance.

Update Agent Rating – Let users upvote or downvote your agent based on their experience. This helps track satisfaction and gather quick feedback on performance.

Feedback on Response – Attach comments or thumbs-up/down to responses.

Result: You can track user satisfaction and refine your assistant.

7. Notifications & Engagement

Keep users informed and engaged with push-style notifications.

Create Notification – Generate a new notification for users.

Get Notifications – Retrieve the list of user notifications.

Result: Your app can actively engage with its users.

8. Analytics & Monitoring

Measure, monitor, and optimize your app with Ejento’s analytics.

Agent Summary Statistics – Overview of usage and performance.

Query Count Data – Track how many queries your agent is handling.

Cost & Token Usage – Monitor consumption and associated costs.

Result: You understand performance and costs at a glance.

9. Advanced Features (Optional)

Enhance your assistant with advanced capabilities.

Guardrails – Apply safety filters to control agent behavior.

Image Generation – Generate AI-powered images based on prompts.

Workflows – Automate multi-step tasks and connect multiple APIs together.

Result: Your assistant becomes smarter, safer, and more versatile.

Complete Flow Summary

Here’s the big picture flow for building a chatbot assistant app:

User Auth → Register and log in users securely with authentication APIs.

Teams → Create teams to manage groups of users and collaborate within shared spaces.

Projects → Organize work inside teams by creating projects for different apps or use cases.

Assistants → Spin up your chatbot assistant inside a project and customize its behavior.

Knowledge Base → Add documents and data sources (PDFs, text, Word files, etc.) so your assistant can answer with real knowledge.

Conversations → Enable chat threads and responses, allowing real-time interactions with users.

Feedback → Collect upvotes, downvotes, reviews, and comments to improve assistant quality.

Notifications → Keep users engaged with in-app alerts and updates.

Analytics → Monitor usage, costs, activity, and performance metrics to optimize your app.

10.

Advanced Features → Add guardrails for safety, enable image generation, or automate tasks with workflows.

Conclusion

By following this roadmap, you can build a fully functional app in just a few steps.
Ejento APIs are designed to be modular, flexible, and developer-friendly so you can pick what you need and scale as your app grows.

Build an App with Ejento APIs

1. Authentication & User Setup#

2. Organizing Teams & Projects#

Step 1: Create a Team#

Step 2: Create a Project within the Team#

Step 3: Prepare for Assistants#

3. Creating Your Assistant (Agent)#

4. Knowledge Base (Corpus & Documents)#

5. Conversations & Chat Threads#

6. Feedback & Ratings#

7. Notifications & Engagement#

8. Analytics & Monitoring#

9. Advanced Features (Optional)#

Complete Flow Summary#

Conclusion#