Create Agent By Agent Builder

The Create Agent by Agent Builder API endpoint allows users to create an AI-powered agent with specific configurations, project associations, and behavioral settings. This API is useful for building and managing virtual assistants tailored for various domains.

How It Works

The system validates the input and processes the agent configuration.

Upon success, a new agent is created, and a response with its unique agent_id and details is returned.

The created agent is automatically linked to the specified project for easier management.

Step-by-Step Guide to Creating an Agent

To follow a detailed, step-by-step guide on how to create an agent, visit:
Create Agent by Agent Builder Guide

For more detailed information about agent, refer to the Agent Guide.

📝 Note: "Assistant" is another name for "Agent".

Request Body Details

Basic Agent Information

agent_id (integer, required): Unique identifier for the agent.

Example: 1297

project_id (integer, required): ID of the project to which the agent belongs.

Example: 254

history (string, optional): Background information or previous interactions related to the agent.

Example: "I am history"

Configuration Flags

flags (object, optional): Configuration options for the agent.

image_generation_enabled (boolean): Specifies if the agent supports image generation.

Example: true

curl --location --request POST '/v2/api/agent/agentbuilder' \ --header 'Content-Type: application/json' \ --data-raw '{ "agent_id": 1297, "project_id": 254, "history": "i am history", "flags": { "image_generation_enabled": true } }'

{ "success": true, "message": "Agent chat created successfully", "data": { "id": 1297, "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": [ { "id": 10611, "instruction": "", "is_deleted": false, "created_by": "user@example.com", "created_on": "2025-01-29T17:23:00.550155Z", "agent": 1297 } ], "user": { "id": 147, "email": "user@example.com", "first_name": "User", "last_name": "User", "organization": 1 }, "connected_tool_names": [ [ "Rag Tool", "Attachment Tool" ] ], "agent_name": "FC Barcelona Info Assistant", "industry_area": "", "domain": "Your go-to assistant for everything related to FC Barcelona! Get real-time updates, match details, player stats, transfer news, and historical insights about the club", "sample_q1": "", "sample_q2": "", "sample_q3": "", "prefix_prompt": "", "alias": "FCBarcelonaInfoAssistant_1297-dev@ejento.ai", "is_active": false, "is_deleted": false, "created_by": "user@example.com", "created_on": "2025-01-29T17:23:00.299537Z", "agent_image": "[object Object]", "access": "Public", "status": "Live", "caching_enabled": false, "chunk_count": 32, "react_enabled": true, "react_max_iteration_count": 50, "project": 254, "llm_config": 8, "cloned_from": null } }

Request

Body Params application/json

agent_id

integer

optional

The ID of the agent to be created.

Example:

1297

project_id

integer

optional

The project ID the agent belongs to.

Example:

254

history

string

optional

The history or background information of the agent.

Example:

i am history

flags

object

optional

Various configuration flags for the agent.

image_generation_enabled

boolean

optional

Indicates whether image generation is enabled for the agent.

Example:

true

Examples

Responses

🟢200OK

application/json

Agent chat created successfully.

Body

success

boolean

optional

Indicates the success of the operation.

Example:

true

message

string

optional

A message describing the operation's result.

Example:

Agent chat created successfully

data

object

optional

integer

optional

The unique ID of the agent.

Example:

1297

agent_type

object

optional

instructions

array [object {6}]

optional

user

object

optional

connected_tool_names

array[string]

optional

agent_name

string

optional

Example:

FC Barcelona Info Assistant

industry_area

string

optional

Example:

domain

string

optional

The description of the agent's domain.

Example:

Your go-to assistant for everything related to FC Barcelona! Get real-time updates, match details, player stats, transfer news, and historical insights about the club

sample_q1

string

optional

Example:

sample_q2

string

optional

Example:

sample_q3

string

optional

Example:

prefix_prompt

string

optional

Example:

alias

string

optional

Example:

FCBarcelonaInfoAssistant_1297-dev@ejento.ai

is_active

boolean

optional

Example:

false

is_deleted

boolean

optional

Example:

false

created_by

string

optional

Example:

user@example.com

created_on

string <date-time>

optional

Example:

2025-01-29T17:23:00.299537Z

agent_image

string

optional

Example:

[object Object]

access

string

optional

Example:

Public

status

string

optional

Example:

Live

caching_enabled

boolean

optional

Example:

false

chunk_count

integer

optional

Example:

react_enabled

boolean

optional

Example:

true

react_max_iteration_count

integer

optional

Example:

project

integer

optional

Example:

254

llm_config

integer

optional

Example:

cloned_from

string | null

optional

Example:

null

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error

Create Agent By Agent Builder

How It Works#

Step-by-Step Guide to Creating an Agent#

Request Body Details#

Request

Responses

How It Works

Step-by-Step Guide to Creating an Agent

Request Body Details