Get All Agents Of Project

Retrieves all agents linked to a specific project using the provided project_id, allowing users to view comprehensive agent configurations, ownership, and functional details.

This endpoint supports optional pagination through the page query parameter to efficiently navigate large sets of agent records.

What is project_id?

The project_id is a unique numeric identifier assigned to each project in the Ejento platform.

It is required to specify which project's agents you want to retrieve.

Every agent belongs to a project, and this ID helps organize and group agents under a relevant workspace.

How to Find Your Project ID

If you're unsure about the project_id, follow this guide:
How to View Project ID

Returned Data Includes:

User details linked to each agent (name, email, organization).

Agent type metadata including name, creator, and description.

Connected tools and instructions assigned to the agent.

Agent metadata such as name, sample questions, and creation details.

Note:

The project_id is mandatory and must be a valid integer.

Ensure the appropriate subscription key or authentication is provided to access agent data.

{ "success": true, "message": "Agent Project Data fetched successfully", "data": [ { "id": 169, "user": { "id": 4, "email": "user@example.com", "first_name": "user", "last_name": "user", "organization": 1 }, "agent_type": { "id": 1, "created_by": "System", "created_on": "2024-04-17T23:10:22.313394Z", "modified_by": "user@example.com", "modified_on": "2024-04-17T23:10:22.313414Z", "name": "QnA", "description": "" }, "instructions": [], "connected_tool_names": [ "Rag Tool" ], "agent_name": "Expertise Guide", "industry_area": "", "domain": "Expert AI assistant providing guidance and assistance in LLM field.", "sample_q1": "What are the components needed for AI software?", "sample_q2": "What criteria should be considered when selecting a supplier for AI software components?", "sample_q3": "What factors contribute to the sustainability of AI software components?", "prefix_prompt": "You are an LLM Expert agent who specializes in providing expert guidance on LLM programs.", "alias": null, "is_active": false, "is_deleted": false, "created_by": "user@example.com", "created_on": "2024-03-27T22:13:43.965931Z", "agent_image": "https://testenvrstorage.blob.core.windows.net/dev-dall-e-images/ExpertiseGuide_f9b8c45e-c714-42ea-a03b-cc53a4415736.jpg", "access": "Public", "status": "Live", "caching_enabled": false, "chunk_count": 32, "react_enabled": false, "react_max_iteration_count": 50, "project": 4, "llm_config": 1, "cloned_from": null } ] }

Responses

🟢200OK

application/json

Agent Project Data fetched successfully.

Body

success

boolean

optional

Indicates whether the request was successful.

Example:

true

message

string

optional

Response message indicating the status of the request.

Example:

Agent Project Data fetched successfully

data

array [object {27}]

optional

List of agents associated with the given project.

integer

optional

Unique identifier of the agent.

Example:

169

user

object

optional

Details of the user associated with the agent.

agent_type

object

optional

Details about the agent type.

instructions

array[string]

optional

List of specific instructions for the agent.

Example:

[]

connected_tool_names

array[string]

optional

List of tools connected to the agent.

Example:

["Rag Tool"]

agent_name

string

optional

Name of the agent.

Example:

Expertise Guide

industry_area

string

optional

The industry area the agent is associated with.

Example:

domain

string

optional

A short description of the agent's functionality.

Example:

Expert AI assistant providing guidance and assistance in LLM field.

sample_q1

string

optional

Sample question 1 related to the agent.

Example:

What are the components needed for AI software?

sample_q2

string

optional

Sample question 2 related to the agent.

Example:

What criteria should be considered when selecting a supplier for AI software components?

sample_q3

string

optional

Sample question 3 related to the agent.

Example:

What factors contribute to the sustainability of AI software components?

prefix_prompt

string

optional

A predefined prompt for the agent.

Example:

You are an LLM Expert agent who specializes in providing expert guidance on LLM programs.

alias

string | null

optional

Alias name of the agent.

Example:

null

is_active

boolean

optional

Indicates if the agent is currently active.

Example:

false

is_deleted

boolean

optional

Indicates if the agent has been deleted.

Example:

false

created_by

string

optional

The email of the user who created the agent.

Example:

user@example.com

created_on

string <date-time>

optional

Timestamp of when the agent was created.

Example:

2024-03-27T22:13:43.965931Z

agent_image

string <uri>

optional

URL of the agent's profile image.

Example:

https://testenvrstorage.blob.core.windows.net/dev-dall-e-images/ExpertiseGuide_f9b8c45e-c714-42ea-a03b-cc53a4415736.jpg

access

enum<string>

optional

The access level of the agent.

Allowed values:

PublicPrivateRestricted

Example:

Public

status

string

optional

Current status of the agent.

Example:

Live

caching_enabled

boolean

optional

Indicates if caching is enabled for the agent.

Example:

false

chunk_count

integer <int32>

optional

Number of chunks processed for the agent.

Example:

react_enabled

boolean

optional

Indicates if React functionality is enabled.

Example:

false

react_max_iteration_count

integer <int32>

optional

Maximum iterations allowed in React mode.

Example:

project

integer

optional

The project ID associated with the agent.

Example:

llm_config

integer

optional

Configuration ID for LLM settings.

Example:

cloned_from

string | null

optional

ID of the agent from which this agent was cloned.

Example:

null

🟠404Record Not Found

🔴500Server Error

Get All Agents Of Project

How to Find Your Project ID#

Request

Responses

How to Find Your Project ID