Create or Update an Agent using the Agent Builder

Handle POST requests to create or update an Agent using the Agent Builder.

Request Body:

history: List of past conversation messages, each with a 'role' (e.g., 'user') and 'content'.

agent_id: ID of an existing agent(optional) to update.

project_id: ID of the project to associate the new agent with.

flags (optional dictionary): Feature flags for agent capabilities.

caching_enabled: Whether response caching is enabled for this chat session.

Returns:

Response with the updated agent state if the creation is successful.

Response with an error message if validation fails or an internal error occurs.

Current Version:

2.0.0

curl --location --request POST '/api/v2/agents/agentbuilder' \ --header 'Content-Type: application/json' \ --data-raw '{ "history": [ { "role": "user", "content": "Hello, how are you?" } ], "agent_id": 1, "project_id": 1, "flags": { "edit": true }, "user_id": 1, "caching_enabled": true }'

{ "success": true, "message": "Agent created successfully by Agent Builder", "data": { "response": "Hello! How can I assist you in building a custom agent today?", "history": [ { "role": "user", "content": "hi" }, { "role": "ai", "content": "Hello! How can I assist you in building a custom agent today?" } ], "agent_id": 0, "agent_state": { "agent_name": "Legal Consultant", "prefix_prompt": "You are an AI assistant specializing in providing legal advice on regulatory requirements, compliance issues, and legal barriers to market entry.", "agent_image": "/build/static/media/xyz123.png", "description": "Legal advisor provides expert guidance on compliance audits, risk assessment, contract management, and regulatory requirements to ensure legal and operational excellence." }, "new_image": false } }

Request

Body Params application/json

history

array [object {1}]

required

List of past conversation messages, each with a 'role' (e.g., 'user') and 'content'.

Additional properties

integer | number | string | boolean

optional

agent_id

integer

required

The ID of the agent to whom the chat is addressed.

project_id

integer

required

Associated project ID. Set to 0 if not linked to a project.

flags

object

required

Dictionary of flags controlling behavior (e.g., { 'edit': true }).

Additional properties

boolean

optional

user_id

integer

required

Internal user ID of the requester.

caching_enabled

boolean

required

Whether response caching is enabled for this chat session.

Examples

application/json

Success

Body

success

boolean

required

message

string

required

data

object

optional

Default:

{}

Additional properties

integer | number | string | boolean

optional

Create or Update an Agent using the Agent Builder

Request

Responses